/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/metatype/annotations/ObjectClassDefinition.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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <!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>ObjectClassDefinition</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="ObjectClassDefinition";
}
}
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/Icon.html" title="annotation in org.osgi.service.metatype.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/Option.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/ObjectClassDefinition.html" target="_top">Frames</a></li>
<li><a href="ObjectClassDefinition.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>Required | </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 ObjectClassDefinition" class="title">Annotation Type ObjectClassDefinition</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">ObjectClassDefinition</span></pre>
<div class="block">Generate a Meta Type Resource using the annotated type.
<p>
This annotation can be used without defining any element values since
defaults can be generated from the annotated type. Each method of the
annotated type has an implied <a href="../../../../../org/osgi/service/metatype/annotations/AttributeDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>AttributeDefinition</code></a> annotation if not
explicitly annotated.
<p>
This annotation may only be used on annotation types and interface types. Use
on concrete or abstract class types is unsupported. If applied to an
interface then all methods inherited from super types are included as
attributes.
<p>
This annotation is not processed at runtime. It must be processed by tools
and used to generate a Meta Type Resource document for the bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The OCD element of a Meta Type Resource."</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#description--">description</a></span></code>
<div class="block">The human readable description of this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#factoryPid--">factoryPid</a></span></code>
<div class="block">The factory PIDs associated with this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/metatype/annotations/Icon.html" title="annotation in org.osgi.service.metatype.annotations">Icon</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#icon--">icon</a></span></code>
<div class="block">The icon resources associated with this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#id--">id</a></span></code>
<div class="block">The id of this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#localization--">localization</a></span></code>
<div class="block">The localization resource of this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#name--">name</a></span></code>
<div class="block">The human readable name of this ObjectClassDefinition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#pid--">pid</a></span></code>
<div class="block">The PIDs associated with this ObjectClassDefinition.</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="id--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>id</h4>
<pre>public abstract java.lang.String id</pre>
<div class="block">The id of this ObjectClassDefinition.
<p>
If not specified, the id of this ObjectClassDefinition is the fully
qualified name of the annotated type using the dollar sign (<code>'$'</code>
\u0024) to separate nested class names from the name of their
enclosing class. The id is not to be confused with a PID which can be
specified by the <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#pid--"><code>pid()</code></a> or <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#factoryPid--"><code>factoryPid()</code></a> element.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The id attribute of the OCD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract java.lang.String name</pre>
<div class="block">The human readable name of this ObjectClassDefinition.
<p>
If not specified, the name of this ObjectClassDefinition is derived from
the <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#id--"><code>id()</code></a>. For example, low line (<code>'_'</code> \u005F) and
dollar sign (<code>'$'</code> \u0024) are replaced with space (<code>' '</code>
\u0020) and space is inserted between camel case words.
<p>
If the name begins with the percent sign (<code>'%'</code> \u0025), the
name can be <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#localization--"><code>localized</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The name attribute of the OCD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="description--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract java.lang.String description</pre>
<div class="block">The human readable description of this ObjectClassDefinition.
<p>
If not specified, the description of this ObjectClassDefinition is the
empty string.
<p>
If the description begins with the percent sign (<code>'%'</code> \u0025),
the description can be <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#localization--"><code>localized</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The description attribute of the OCD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="localization--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localization</h4>
<pre>public abstract java.lang.String localization</pre>
<div class="block">The localization resource of this ObjectClassDefinition.
<p>
This refers to a resource property entry in the bundle that can be
augmented with locale information. If not specified, the localization
resource for this ObjectClassDefinition is the string
"OSGI-INF/l10n/" followed by the <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#id--"><code>id()</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The localization attribute of the MetaData element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="pid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pid</h4>
<pre>public abstract java.lang.String[] pid</pre>
<div class="block">The PIDs associated with this ObjectClassDefinition.
<p>
For each specified PID, a <code>Designate</code> element with a pid attribute
is generated that <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#id--"><code>references</code></a> this ObjectClassDefinition.
<p>
The <a href="../../../../../org/osgi/service/metatype/annotations/Designate.html" title="annotation in org.osgi.service.metatype.annotations"><code>Designate</code></a> annotation can also be used to associate a
Declarative Services component with an ObjectClassDefinition and generate
a <code>Designate</code> element.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The pid attribute of the Designate element of a Meta Type Resource.",
<a href="../../../../../org/osgi/service/metatype/annotations/Designate.html" title="annotation in org.osgi.service.metatype.annotations"><code>Designate</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="factoryPid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factoryPid</h4>
<pre>public abstract java.lang.String[] factoryPid</pre>
<div class="block">The factory PIDs associated with this ObjectClassDefinition.
<p>
For each specified factory PID, a <code>Designate</code> element with a
factoryPid attribute is generated that <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html#id--"><code>references</code></a> this
ObjectClassDefinition.
<p>
The <a href="../../../../../org/osgi/service/metatype/annotations/Designate.html" title="annotation in org.osgi.service.metatype.annotations"><code>Designate</code></a> annotation can also be used to associate a
Declarative Services component with an ObjectClassDefinition and generate
a <code>Designate</code> element.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The factoryPid attribute of the Designate element of a Meta Type Resource.",
<a href="../../../../../org/osgi/service/metatype/annotations/Designate.html" title="annotation in org.osgi.service.metatype.annotations"><code>Designate</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="icon--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>icon</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/metatype/annotations/Icon.html" title="annotation in org.osgi.service.metatype.annotations">Icon</a>[] icon</pre>
<div class="block">The icon resources associated with this ObjectClassDefinition.
<p>
For each specified <a href="../../../../../org/osgi/service/metatype/annotations/Icon.html" title="annotation in org.osgi.service.metatype.annotations"><code>Icon</code></a>, an <code>Icon</code> element is generated for
this ObjectClassDefinition. If not specified, no <code>Icon</code> elements
will be generated.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The Icon element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</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/Icon.html" title="annotation in org.osgi.service.metatype.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/Option.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/ObjectClassDefinition.html" target="_top">Frames</a></li>
<li><a href="ObjectClassDefinition.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>Required | </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>
|