/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/metatype/annotations/AttributeDefinition.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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | <!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>AttributeDefinition</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="AttributeDefinition";
}
}
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>Prev Class</li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum 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/AttributeDefinition.html" target="_top">Frames</a></li>
<li><a href="AttributeDefinition.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 AttributeDefinition" class="title">Annotation Type AttributeDefinition</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=CLASS)
@Target(value=METHOD)
public @interface <span class="memberNameLabel">AttributeDefinition</span></pre>
<div class="block"><code>AttributeDefinition</code> information for the annotated method.
<p>
Each method of a type annotated by <a href="../../../../../org/osgi/service/metatype/annotations/ObjectClassDefinition.html" title="annotation in org.osgi.service.metatype.annotations"><code>ObjectClassDefinition</code></a> has an
implied AttributeDefinition annotation. This annotation is only used to
specify non-default AttributeDefinition information.
<p>
The <code>id</code> of this AttributeDefinition is generated from the name of the
annotated method. The annotated method name is processed from left to right
changing each character as follows:
<ul>
<li>A dollar sign (<code>'$'</code> \u0024) is removed unless it is followed
by another dollar sign in which case the two consecutive dollar signs (
<code>'$$'</code>) are changed to a single dollar sign.</li>
<li>A low line (<code>'_'</code> \u005F) is changed to a full stop (
<code>'.'</code> \u002E) unless is it followed by another low line in which
case the two consecutive low lines (<code>'__'</code>) are changed to a single low
line.</li>
<li>All other characters are unchanged.</li>
</ul>
This id is the value of the id attribute of the generate AD element and is
used as the name of the corresponding configuration property.
<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 AD 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/AttributeDefinition.html#cardinality--">cardinality</a></span></code>
<div class="block">The cardinality of this AttributeDefinition.</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/AttributeDefinition.html#defaultValue--">defaultValue</a></span></code>
<div class="block">The default value for this AttributeDefinition.</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/AttributeDefinition.html#description--">description</a></span></code>
<div class="block">The human readable description of this AttributeDefinition.</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/AttributeDefinition.html#max--">max</a></span></code>
<div class="block">The maximum value for this AttributeDefinition.</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/AttributeDefinition.html#min--">min</a></span></code>
<div class="block">The minimum value for this AttributeDefinition.</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/AttributeDefinition.html#name--">name</a></span></code>
<div class="block">The human readable name of this AttributeDefinition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/metatype/annotations/Option.html" title="annotation in org.osgi.service.metatype.annotations">Option</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/AttributeDefinition.html#options--">options</a></span></code>
<div class="block">The option information for this AttributeDefinition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/AttributeDefinition.html#required--">required</a></span></code>
<div class="block">The required value for this AttributeDefinition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum in org.osgi.service.metatype.annotations">AttributeType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/metatype/annotations/AttributeDefinition.html#type--">type</a></span></code>
<div class="block">The type of this AttributeDefinition.</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="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 AttributeDefinition.
<p>
If not specified, the name of this AttributeDefinition is derived from
the name of the annotated method. 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 AD 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 AttributeDefinition.
<p>
If not specified, the description of this AttributeDefinition 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 AD 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="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum in org.osgi.service.metatype.annotations">AttributeType</a> type</pre>
<div class="block">The type of this AttributeDefinition.
<p>
This must be one of the defined <a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum in org.osgi.service.metatype.annotations"><code>attributes types</code></a>.
<p>
If not specified, the type is derived from the return type of the
annotated method. Return types of <code>Class</code> and <code>Enum</code> are
mapped to <a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html#STRING"><code>STRING</code></a>. If the return type is
<code>List</code>, <code>Set</code>, <code>Collection</code>, <code>Iterable</code> or some
type which can be determined at annotation processing time to
<ol>
<li>be a subtype of <code>Collection</code> and</li>
<li>have a public no argument constructor,</li>
</ol>
then the type is derived from the generic type. For example, a return
type of <code>List<String></code> will be mapped to
<a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html#STRING"><code>STRING</code></a>. A return type of a single
dimensional array is supported and the type is the component type of the
array. Multi dimensional arrays are not supported. Annotation return
types are not supported. Any unrecognized type is mapped to
<a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html#STRING"><code>STRING</code></a>. A tool processing the annotation
should declare an error for unsupported return types.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The type attribute of the AD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.osgi.service.metatype.annotations.AttributeType.STRING</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="cardinality--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cardinality</h4>
<pre>public abstract int cardinality</pre>
<div class="block">The cardinality of this AttributeDefinition.
<p>
If not specified, the cardinality is derived from the return type of the
annotated method. For an array return type, the cardinality is a large
positive value. If the return type is <code>List</code>, <code>Set</code>,
<code>Collection</code>, <code>Iterable</code> or some type which can be determined
at annotation processing time to
<ol>
<li>be a subtype of <code>Collection</code> and</li>
<li>have a public no argument constructor,</li>
</ol>
the cardinality is a large negative value. Otherwise, the cardinality is
0.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The cardinality attribute of the AD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="min--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public abstract java.lang.String min</pre>
<div class="block">The minimum value for this AttributeDefinition.
<p>
If not specified, there is no minimum value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The min attribute of the AD 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="max--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public abstract java.lang.String max</pre>
<div class="block">The maximum value for this AttributeDefinition.
<p>
If not specified, there is no maximum value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The max attribute of the AD 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="defaultValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public abstract java.lang.String[] defaultValue</pre>
<div class="block">The default value for this AttributeDefinition.
<p>
The specified values are concatenated into a comma delimited list to
become the value of the <code>default</code> attribute of the generated
<code>AD</code> element.
<p>
If not specified and the annotated method is an annotation element that
has a <code>default</code> value, then the value of this element is the
<code>default</code> value of the annotated element. Otherwise, there is no
default value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The default attribute of the AD 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="required--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre>public abstract boolean required</pre>
<div class="block">The required value for this AttributeDefinition.
<p>
If not specified, the value is <code>true</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The required attribute of the AD element of a Meta Type Resource."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="options--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>options</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/metatype/annotations/Option.html" title="annotation in org.osgi.service.metatype.annotations">Option</a>[] options</pre>
<div class="block">The option information for this AttributeDefinition.
<p>
For each specified <a href="../../../../../org/osgi/service/metatype/annotations/Option.html" title="annotation in org.osgi.service.metatype.annotations"><code>Option</code></a>, an <code>Option</code> element is generated
for this AttributeDefinition.
<p>
If not specified, the option information is derived from the return type
of the annotated method. If the return type is an <code>enum</code>, a single
dimensional array of an <code>enum</code>, or a <code>List</code>, <code>Set</code>,
<code>Collection</code>, <code>Iterable</code> or some type which can be determined
at annotation processing time to
<ol>
<li>be a subtype of <code>Collection</code> and</li>
<li>have a public no argument constructor,</li>
</ol>
with a generic type of an <code>enum</code>, then the value of this element
has an <a href="../../../../../org/osgi/service/metatype/annotations/Option.html" title="annotation in org.osgi.service.metatype.annotations"><code>Option</code></a> for each value of the <code>enum</code>. The label and
value of each <a href="../../../../../org/osgi/service/metatype/annotations/Option.html" title="annotation in org.osgi.service.metatype.annotations"><code>Option</code></a> are set to the name of the corresponding
<code>enum</code> value. Otherwise, no <code>Option</code> elements will be
generated.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The Option 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>Prev Class</li>
<li><a href="../../../../../org/osgi/service/metatype/annotations/AttributeType.html" title="enum 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/AttributeDefinition.html" target="_top">Frames</a></li>
<li><a href="AttributeDefinition.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>
|