/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/component/annotations/Component.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 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 | <!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>Component</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="Component";
}
}
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/component/annotations/Activate.html" title="annotation in org.osgi.service.component.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/component/annotations/ConfigurationPolicy.html" title="enum in org.osgi.service.component.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/component/annotations/Component.html" target="_top">Frames</a></li>
<li><a href="Component.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><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation.type.field.detail">Field</a> | </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.component.annotations</div>
<h2 title="Annotation Type Component" class="title">Annotation Type Component</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">Component</span></pre>
<div class="block">Identify the annotated class as a Service Component.
<p>
The annotated class is the implementation class of the Component.
<p>
This annotation is not processed at runtime by a Service Component Runtime
implementation. It must be processed by tools and used to add a Component
Description to the bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The component element of a Component Description."</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Fields and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#NAME">NAME</a></span></code>
<div class="block">Special string representing the name of this Component.</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>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#configurationPid--">configurationPid</a></span></code>
<div class="block">The configuration PIDs for the configuration of this Component.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/component/annotations/ConfigurationPolicy.html" title="enum in org.osgi.service.component.annotations">ConfigurationPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#configurationPolicy--">configurationPolicy</a></span></code>
<div class="block">The configuration policy of this Component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#enabled--">enabled</a></span></code>
<div class="block">Declares whether this Component is enabled when the bundle containing it
is started.</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/component/annotations/Component.html#factory--">factory</a></span></code>
<div class="block">The factory identifier of this Component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#immediate--">immediate</a></span></code>
<div class="block">Declares whether this Component must be immediately activated upon
becoming satisfied or whether activation should be delayed.</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/component/annotations/Component.html#name--">name</a></span></code>
<div class="block">The name of this Component.</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/component/annotations/Component.html#properties--">properties</a></span></code>
<div class="block">Property entries for this Component.</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/component/annotations/Component.html#property--">property</a></span></code>
<div class="block">Properties for this Component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/component/annotations/Reference.html" title="annotation in org.osgi.service.component.annotations">Reference</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#reference--">reference</a></span></code>
<div class="block">The lookup strategy references of this Component.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/component/annotations/ServiceScope.html" title="enum in org.osgi.service.component.annotations">ServiceScope</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/component/annotations/Component.html#scope--">scope</a></span></code>
<div class="block">The service scope for the service of this Component.</div>
</td>
</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/component/annotations/Component.html#service--">service</a></span></code>
<div class="block">The types under which to register this Component as a service.</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/component/annotations/Component.html#servicefactory--">servicefactory</a></span></code>
<div class="block">Declares whether this Component uses the OSGi ServiceFactory concept and
each bundle using this Component's service will receive a different
component instance.</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/component/annotations/Component.html#xmlns--">xmlns</a></span></code>
<div class="block">The XML name space of the Component Description for this Component.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NAME</h4>
<pre>public static final java.lang.String NAME</pre>
<div class="block">Special string representing the name of this Component.
<p>
This string can be used in <a href="../../../../../org/osgi/service/component/annotations/Component.html#configurationPid--"><code>configurationPid()</code></a> to specify the
name of the component as a configuration PID. For example:
<pre>
@Component(configurationPid={"com.acme.system", Component.NAME})
</pre>
Tools creating a Component Description from this annotation must replace
the special string with the actual name of this Component.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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 name of this Component.
<p>
If not specified, the name of this Component is the fully qualified type
name of the class being annotated.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The name attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="service--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>service</h4>
<pre>public abstract java.lang.Class<?>[] service</pre>
<div class="block">The types under which to register this Component as a service.
<p>
If no service should be registered, the empty value
<code>{}</code> must be specified.
<p>
If not specified, the service types for this Component are all the
<i>directly</i> implemented interfaces of the class being annotated.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The service element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="factory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factory</h4>
<pre>public abstract java.lang.String factory</pre>
<div class="block">The factory identifier of this Component. Specifying a factory identifier
makes this Component a Factory Component.
<p>
If not specified, the default is that this Component is not a Factory
Component.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The factory attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="servicefactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>servicefactory</h4>
<pre>public abstract boolean servicefactory</pre>
<div class="block">Declares whether this Component uses the OSGi ServiceFactory concept and
each bundle using this Component's service will receive a different
component instance.
<p>
If <code>true</code>, this Component uses the OSGi ServiceFactory concept. If
<code>false</code> or not specified, this Component does not use the OSGi
ServiceFactory concept.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The servicefactory attribute of the service element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="enabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enabled</h4>
<pre>public abstract boolean enabled</pre>
<div class="block">Declares whether this Component is enabled when the bundle containing it
is started.
<p>
If <code>true</code>, this Component is enabled. If <code>false</code> or not
specified, this Component is disabled.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The enabled attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="immediate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>immediate</h4>
<pre>public abstract boolean immediate</pre>
<div class="block">Declares whether this Component must be immediately activated upon
becoming satisfied or whether activation should be delayed.
<p>
If <code>true</code>, this Component must be immediately activated upon
becoming satisfied. If <code>false</code>, activation of this Component is
delayed. If this property is specified, its value must be <code>false</code>
if the <a href="../../../../../org/osgi/service/component/annotations/Component.html#factory--"><code>factory()</code></a> property is also specified or must be
<code>true</code> if the <a href="../../../../../org/osgi/service/component/annotations/Component.html#service--"><code>service()</code></a> property is specified with an empty
value.
<p>
If not specified, the default is <code>false</code> if the <a href="../../../../../org/osgi/service/component/annotations/Component.html#factory--"><code>factory()</code></a>
property is specified or the <a href="../../../../../org/osgi/service/component/annotations/Component.html#service--"><code>service()</code></a> property is not specified
or specified with a non-empty value and <code>true</code> otherwise.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The immediate attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="property--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>property</h4>
<pre>public abstract java.lang.String[] property</pre>
<div class="block">Properties for this Component.
<p>
Each property string is specified as <code>"key=value"</code>. The type of the
property value can be specified in the key as <code>key:type=value</code>. The
type must be one of the property types supported by the type attribute of
the property element of a Component Description.
<p>
To specify a property with multiple values, use multiple key, value
pairs. For example, <code>"foo=bar", "foo=baz"</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The property element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="properties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre>public abstract java.lang.String[] properties</pre>
<div class="block">Property entries for this Component.
<p>
Specifies the name of an entry in the bundle whose contents conform to a
standard Java Properties File. The entry is read and processed to obtain
the properties and their values.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The properties element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="xmlns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>xmlns</h4>
<pre>public abstract java.lang.String xmlns</pre>
<div class="block">The XML name space of the Component Description for this Component.
<p>
If not specified, the XML name space of the Component Description for
this Component should be the lowest Declarative Services XML name space
which supports all the specification features used by this Component.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The XML name space specified for a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="configurationPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configurationPolicy</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/component/annotations/ConfigurationPolicy.html" title="enum in org.osgi.service.component.annotations">ConfigurationPolicy</a> configurationPolicy</pre>
<div class="block">The configuration policy of this Component.
<p>
Controls whether component configurations must be satisfied depending on
the presence of a corresponding Configuration object in the OSGi
Configuration Admin service. A corresponding configuration is a
Configuration object where the PID equals the name of the component.
<p>
If not specified, the <a href="../../../../../org/osgi/service/component/annotations/ConfigurationPolicy.html#OPTIONAL"><code>OPTIONAL</code></a>
configuration policy is used.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The configuration-policy attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.osgi.service.component.annotations.ConfigurationPolicy.OPTIONAL</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="configurationPid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configurationPid</h4>
<pre>public abstract java.lang.String[] configurationPid</pre>
<div class="block">The configuration PIDs for the configuration of this Component.
<p>
Each value specifies a configuration PID for this Component.
<p>
If no value is specified, the name of this Component is used as the
configuration PID of this Component.
<p>
A special string (<code><a href="../../../../../org/osgi/service/component/annotations/Component.html#NAME">"$"</a></code>) can be used to specify the
name of the component as a configuration PID. The <code>NAME</code> constant
holds this special string. For example:
<pre>
@Component(configurationPid={"com.acme.system", Component.NAME})
</pre>
Tools creating a Component Description from this annotation must replace
the special string with the actual name of this Component.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The configuration-pid attribute of the component element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"$"</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="scope--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scope</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/component/annotations/ServiceScope.html" title="enum in org.osgi.service.component.annotations">ServiceScope</a> scope</pre>
<div class="block">The service scope for the service of this Component.
<p>
If not specified (and the deprecated <a href="../../../../../org/osgi/service/component/annotations/Component.html#servicefactory--"><code>servicefactory()</code></a> element is
not specified), the <a href="../../../../../org/osgi/service/component/annotations/ServiceScope.html#SINGLETON"><code>singleton</code></a> service
scope is used. If the <a href="../../../../../org/osgi/service/component/annotations/Component.html#factory--"><code>factory()</code></a> element is specified or the
<a href="../../../../../org/osgi/service/component/annotations/Component.html#immediate--"><code>immediate()</code></a> element is specified with <code>true</code>, this element
can only be specified with the <a href="../../../../../org/osgi/service/component/annotations/ServiceScope.html#SINGLETON"><code>singleton</code></a>
service scope.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The scope attribute of the service element of a Component Description."</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.osgi.service.component.annotations.ServiceScope.DEFAULT</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="reference--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reference</h4>
<pre>public abstract <a href="../../../../../org/osgi/service/component/annotations/Reference.html" title="annotation in org.osgi.service.component.annotations">Reference</a>[] reference</pre>
<div class="block">The lookup strategy references of this Component.
<p>
To access references using the lookup strategy, <a href="../../../../../org/osgi/service/component/annotations/Reference.html" title="annotation in org.osgi.service.component.annotations"><code>Reference</code></a>
annotations are specified naming the reference and declaring the type of
the referenced service. The referenced service can be accessed using one
of the <code>locateService</code> methods of <code>ComponentContext</code>.
<p>
To access references using the event strategy, bind methods are annotated
with <a href="../../../../../org/osgi/service/component/annotations/Reference.html" title="annotation in org.osgi.service.component.annotations"><code>Reference</code></a>. To access references using the field strategy,
fields are annotated with <a href="../../../../../org/osgi/service/component/annotations/Reference.html" title="annotation in org.osgi.service.component.annotations"><code>Reference</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"The reference element of a Component Description."</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/component/annotations/Activate.html" title="annotation in org.osgi.service.component.annotations"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/component/annotations/ConfigurationPolicy.html" title="enum in org.osgi.service.component.annotations"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/component/annotations/Component.html" target="_top">Frames</a></li>
<li><a href="Component.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><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation.type.field.detail">Field</a> | </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>
|