/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/metatype/annotations/Designate.html is in libosgi-compendium-java-doc 5.0.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>Designate</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Designate";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum in org.osgi.service.metatype.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/Icon.html" title="annotation in org.osgi.service.metatype.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/metatype/annotations/Designate.html" target="_top">Frames</a></li>
<li><a href="Designate.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.service.metatype.annotations</div>
<h2 title="Annotation Type Designate" class="title">Annotation Type Designate</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=CLASS)
@Target(value=TYPE)
public @interface <span class="memberNameLabel">Designate</span></pre>
<div class="block">Generate a <code>Designate</code> element in the Meta Type Resource for an
<a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>ObjectClassDefinition</code></a> using the annotated Declarative Services
component.
<p>
This annotation must be used on a type that is also annotated with the
Declarative Services <a href="../../../../../org/osgi/service/component/annotations/Component.html" title="annotation in org.osgi.service.component.annotations"><code>Component</code></a> annotation. The component must only have a single PID which is
used for the generated <code>Designate</code> element.
<p>
This annotation is not processed at runtime. It must be processed by tools
and used to contribute to a Meta Type Resource document for the bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The Designate element of a Meta Type Resource."</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.required.element.summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class<?></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/Designate.html#ocd--">ocd</a></span></code>
<div class="block">The type of the <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>ObjectClassDefinition</code></a> for this Designate.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/Designate.html#factory--">factory</a></span></code>
<div class="block">Specifies whether this Designate is for a factory PID.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="ocd--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ocd</h4>
<pre>public abstract java.lang.Class<?> ocd</pre>
<div class="block">The type of the <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>ObjectClassDefinition</code></a> for this Designate.
<p>
The specified type must be annotated with <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>ObjectClassDefinition</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The ocdref attribute of the Designate element of a Meta Type Resource."</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="factory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>factory</h4>
<pre>public abstract boolean factory</pre>
<div class="block">Specifies whether this Designate is for a factory PID.
<p>
If <code>false</code>, then the PID value from the annotated component will be
used in the <code>pid</code> attribute of the generated <code>Designate</code>
element. If <code>true</code>, then the PID value from the annotated component
will be used in the <code>factoryPid</code> attribute of the generated
<code>Designate</code> element.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The pid and factoryPid attributes of the Designate element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum in org.osgi.service.metatype.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/Icon.html" title="annotation in org.osgi.service.metatype.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/metatype/annotations/Designate.html" target="_top">Frames</a></li>
<li><a href="Designate.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|