Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/ConfigurationDependency.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/ConfigurationDependency.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/ConfigurationDependency.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/ConfigurationDependency.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,517 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>ConfigurationDependency</title> +<meta name="date" content="2018-10-22"> +<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="ConfigurationDependency"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/ConfigurationDependency.html" target="_top">Frames</a></li> +<li><a href="ConfigurationDependency.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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type ConfigurationDependency" class="title">Annotation Type ConfigurationDependency</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">ConfigurationDependency</span></pre> +<div class="block">Annotates a method for injecting a Configuration Dependency. + + <p> A configuration dependency + is required by default, and allows you to depend on the availability of a valid configuration + for your component. This dependency requires the OSGi Configuration Admin Service. + + Configuration Dependency callback is always invoked before any service dependency callbacks, and before init/start callbacks. + + The annotation can be applied on a callback method which accepts the following parameters: + + <ul> + <li>callback(Dictionary) + <li>callback(Component, Dictionary) + <li>callback(Component, Configuration ... configTypes) // type safe configuration interface(s) + <li>callback(Configuration ... configTypes) // type safe configuration interface(s) + <li>callback(Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s) + <li>callback(Component, Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s) + </ul> + + <h3>Usage Examples</h3> + + <p> In the following example, the Printer components depends on a configuration + whose PID name is "sample.Printer". This service will initialize + its ip/port number from the provided configuration. + + <blockquote> + <pre> + + package sample; + + @Component + public class Printer { + @ConfigurationDependency(propagate=true) // Will use the fqdn of the Printer interface as the pid. + void updated(Dictionary cnf) { + if (cnf != null) { + String ip = cnf.get("address"); + int port = Integer.parseInt(cnf.get("port")); + } + } + } + </pre> + </blockquote> + + You can also define your own component properties using a custom type-safe interface: + + <blockquote> + <pre> + package sample; + + interface PrinterConfig { + String getAddress(); + int getPort(); + } + </pre> + </blockquote> + + Next, we define our Printer service which depends on the PrinterConfig: + + <blockquote> + <pre> + package sample; + + @Component + public class Printer { + @ConfigurationDependency // Will use the fqdn of the PrinterConfig interface as the pid. + void updated(PrinterConfig cnf) { + if (cnf != null) { + String ip = cnf.getAddress(); + int port = cnf.getPort(); + } + } + } + </pre> + </blockquote> + + In the above example, the updated callback accepts a type-safe configuration type (and its fqdn is used as the pid). + <p> Configuration type is a new feature that allows you to specify an interface that is implemented + by DM and such interface is then injected to your callback instead of the actual Dictionary. + Using such configuration interface provides a way for creating type-safe configurations from a actual <code>Dictionary</code> that is + normally injected by Dependency Manager. + The callback accepts in argument an interface that you have to provide, and DM will inject a proxy that converts + method calls from your configuration-type to lookups in the actual map or dictionary. The results of these lookups are then + converted to the expected return type of the invoked configuration method.<br> + As proxies are injected, no implementations of the desired configuration-type are necessary! + </p> + <p> + The lookups performed are based on the name of the method called on the configuration type. The method names are + "mangled" to the following form: <tt>[lower case letter] [any valid character]*</tt>. Method names starting with + <tt>get</tt> or <tt>is</tt> (JavaBean convention) are stripped from these prefixes. For example: given a dictionary + with the key <tt>"foo"</tt> can be accessed from a configuration-type using the following method names: + <tt>foo()</tt>, <tt>getFoo()</tt> and <tt>isFoo()</tt>.<p> + If the property contains a dot (which is invalid in java method names), then dots (".") can be converted using the following conventions: + <ul> + + <li> if the method name follows the javabean convention and/or kamel casing convention, then each capital letter is assumed to map to a "dot", + followed by the same letter in lower case. This means only lower case properties are + supported in this case. Example: getFooBar() or fooBar() will map to "foo.bar" property. + + <li> else, if the method name follows the standard OSGi metatype specification, then dots + are encoded as "_"; and "_" is encoded as "__". (see OSGi r6 compendium, chapter 105.9.2). + Example: "foo_BAR()" is mapped to "foo.BAR" property; "foo__BAR_zoo()" is mapped to "foo_BAR.zoo" property. + </ul> + <p> + The return values supported are: primitive types (or their object wrappers), strings, enums, arrays of + primitives/strings, <code>Collection</code> types, <code>Map</code> types, <code>Class</code>es and interfaces. When an interface is + returned, it is treated equally to a configuration type, that is, it is returned as a proxy. + </p> + <p> + Arrays can be represented either as comma-separated values, optionally enclosed in square brackets. For example: + <tt>[ a, b, c ]</tt> and <tt>a, b,c</tt> are both considered an array of length 3 with the values "a", "b" and "c". + Alternatively, you can append the array index to the key in the dictionary to obtain the same: a dictionary with + "arr.0" => "a", "arr.1" => "b", "arr.2" => "c" would result in the same array as the earlier examples. + </p> + <p> + Maps can be represented as single string values similarly as arrays, each value consisting of both the key and value + separated by a dot. Optionally, the value can be enclosed in curly brackets. Similar to array, you can use the same + dot notation using the keys. For example, a dictionary with + + <pre><code> "map" => "{key1.value1, key2.value2}"</code></pre> + + and a dictionary with + + <pre><code> "map.key1" => "value1", "map2.key2" => "value2"</code></pre> + + result in the same map being returned. + Instead of a map, you could also define an interface with the methods <tt>getKey1()</tt> and <tt>getKey2</tt> and use + that interface as return type instead of a <code>Map</code>. + + <p> + In case a lookup does not yield a value from the underlying map or dictionary, the following rules are applied: + <ol> + <li>primitive types yield their default value, as defined by the Java Specification; + <li>string, <code>Class</code>es and enum values yield <code>null</code>; + <li>for arrays, collections and maps, an empty array/collection/map is returned; + <li>for other interface types that are treated as configuration type a null-object is returned. + </ol></div> +</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/apache/felix/dm/annotation/api/ConfigurationDependency.html#name--">name</a></span></code> +<div class="block">The name for this configuration dependency.</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/apache/felix/dm/annotation/api/ConfigurationDependency.html#pid--">pid</a></span></code> +<div class="block">Returns the pid for a given service (by default, the pid is the service class name, of the FQDN of + the configuration type found in the updated callback signature.</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/apache/felix/dm/annotation/api/ConfigurationDependency.html#pidClass--">pidClass</a></span></code> +<div class="block">Returns the pid from a class name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#propagate--">propagate</a></span></code> +<div class="block">Returns true if the configuration properties must be published along with the service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#required--">required</a></span></code> +<div class="block">Sets the required flag which determines if this configuration dependency is required or not.</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="pid--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pid</h4> +<pre>public abstract java.lang.String pid</pre> +<div class="block">Returns the pid for a given service (by default, the pid is the service class name, of the FQDN of + the configuration type found in the updated callback signature.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the pid for a given service (default = Service class name)</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="pidClass--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pidClass</h4> +<pre>public abstract java.lang.Class<?> pidClass</pre> +<div class="block">Returns the pid from a class name. The full class name will be used as the configuration PID.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the pid class whose FQDN name is used as the configuration PID.</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>java.lang.Object.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="propagate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>propagate</h4> +<pre>public abstract boolean propagate</pre> +<div class="block">Returns true if the configuration properties must be published along with the service. + Any additional service properties specified directly are merged with these. The configuration + dependency properties take precedence over the component service properties, meaning that a given configuration + property will override the same property that is already present in the component service properties.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if configuration must be published along with the service, false if not.</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>false</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">Sets the required flag which determines if this configuration dependency is required or not. + A configuration dependency is required by default.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>true</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="name--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>name</h4> +<pre>public abstract java.lang.String name</pre> +<div class="block">The name for this configuration dependency. When you give a name a dependency, it won't be evaluated + immediately, but after the component's init method has been called, and from the init method, you can then return + a map in order to dynamically configure the configuration dependency (the map has to contain a "pid" and/or "propagate" + flag, prefixed with the dependency name). Then the dependency will be evaluated after the component init method, and will + be injected before the start method. + + <p> Usage example of a Configuration dependency whose pid and propagate flag is configured dynamically from init method: + + <blockquote><pre> + /** + * A Service that dynamically defines an extra dynamic configuration dependency from its init method. + */ + @Component + class X { + private Dictionary m_config; + + // Inject initial Configuration (injected before any other required dependencies) + @ConfigurationDependency + void componentConfiguration(Dictionary config) { + // you must throw an exception if the configuration is not valid + m_config = config; + } + + /** + * All unnamed dependencies are injected: we can now configure our dynamic configuration whose dependency name is "global". + */ + @Init + Map init() { + return new HashMap() {{ + put("global.pid", m_config.get("globalConfig.pid")); + put("global.propagate", m_config.get("globalConfig.propagate")); + }}; + } + + // Injected after init, and dynamically configured by the init method. + @ConfigurationDependency(name="global") + void globalConfiguration(Dictionary globalConfig) { + // you must throw an exception if the configuration is not valid + } + + /** + * All dependencies are injected and our service is now ready to be published. + */ + @Start + void start() { + } + } + </pre></blockquote></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the dependency name used to configure the dependency dynamically from init callback</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/ConfigurationDependency.html" target="_top">Frames</a></li> +<li><a href="ConfigurationDependency.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>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Destroy.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Destroy.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Destroy.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Destroy.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,180 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>Destroy</title> +<meta name="date" content="2018-10-22"> +<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="Destroy"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Destroy.html" target="_top">Frames</a></li> +<li><a href="Destroy.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type Destroy" class="title">Annotation Type Destroy</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">Destroy</span></pre> +<div class="block">Annotates a method which is invoked when the component is destroyed. + The method is called when the component's bundle is stopped, or when one of its + required dependency is lost (unless the dependency has been defined as an "instance bound" + dependency using the Dependency Manager API). + + + <h3>Usage Examples</h3> + <blockquote> + <pre> + @Component + class MyComponent { + @ServiceDependency + private LogService logService; // Required dependency over the log service. + + @Destroy + void destroyed() {} // called if bundle is stopped or if we have lost some required dependencies. + } + </pre> + </blockquote></div> +</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Destroy.html" target="_top">Frames</a></li> +<li><a href="Destroy.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Init.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Init.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Init.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Init.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,315 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>Init</title> +<meta name="date" content="2018-10-22"> +<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="Init"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Init.html" target="_top">Frames</a></li> +<li><a href="Init.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type Init" class="title">Annotation Type Init</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">Init</span></pre> +<div class="block">Annotates a method used to configure dynamic dependencies. + When this method is invoked, all required dependencies (except the ones declared with a <code>name</code> + attribute) are already injected, and optional dependencies on class fields + are also already injected (possibly with NullObjects). + + The purpose of the @Init method is to either declare more dynamic dependencies using the DM API, or to + return a Map used to dynamically configure dependencies that are annotated using a <code>name</code> attribute. + + After the init method returns, the added or configured dependencies are then tracked, and when all + dependencies are injected, then the start method (annotated with @Start) is invoked. + + The method annotated with @Init may have the following signatures, + <ol> + <li>void init(Component component)</li> + <li>void init()</li> + <li>Map<String, String> init(Component component)</li> + <li>Map<String, String> init()</li> + </ol> + + When the init method defines a Component argument, it can then be used by the method to add more dependencie using the Dependency Manager API. + + <h3>Usage Examples</h3> + In this sample, the "PersistenceImpl" component dynamically configures the "storage" dependency from the "init" method. + The dependency "required" flag and filter string are derived from an xml configuration that is already injected before the init + method. + + <blockquote> + <pre> + @Component + public class PersistenceImpl implements Persistence { + // Injected before init. + @ConfigurationDependency + void updated(Dictionary conf) { + if (conf != null) { + _xmlConfiguration = parseXmlConfiguration(conf.get("xmlConfiguration")); + } + } + + // Parsed xml configuration, where we'll get our storage service filter and required dependency flag. + XmlConfiguration _xmlConfiguration; + + // Dynamically configure the dependency declared with a "storage" name. + @Init + Map<String, String> init() { + Map<String, String> props = new HashMap<>(); + props.put("storage.required", Boolean.toString(_xmlConfiguration.isStorageRequired())) + props.put("storage.filter", "(type=" + _xmlConfiguration.getStorageType() + ")"); + return props; + } + + // Injected after init (dependency filter is defined dynamically from our init method). + @ServiceDependency(name="storage") + Storage storage; + + // All dependencies injected, including dynamic dependencies defined from init method. + @Start + void start() { + log.log(LogService.LOG_WARNING, "start"); + } + + @Override + void store(String key, String value) { + storage.store(key, value); + } + } + </pre> + </blockquote> + + Same example as above, but this time the dependency is added from the init method using the Dependency Manager API: + + <blockquote> + <pre> + @Component + public class PersistenceImpl implements Persistence { + // Injected before init. + @ConfigurationDependency + void updated(Dictionary conf) { + if (conf != null) { + _xmlConfiguration = parseXmlConfiguration(conf.get("xmlConfiguration")); + } + } + + // Parsed xml configuration, where we'll get our storage service filter and required dependency flag. + XmlConfiguration _xmlConfiguration; + + // Dynamically configure the dependency declared with a "storage" name. + @Init + void init(org.apache.felix.dm.Comppnent myComponent) { + boolean required = _xmlConfiguration.isStorageRequired(); + String filter = _xmlConfiguration.getStorageType(); + DependencyManager dm = myComponent.getDependencyManager(); + myComponent.add(dm.createServiceDependency().setService(Storage.class, filter).setRequired(required)); + } + + // Injected after init, later, when the dependency added from the init() method is satisfied + volatile Storage storage; + + // All dependencies injected, including dynamic dependencies defined from init method. + @Start + void start() { + log.log(LogService.LOG_WARNING, "start"); + } + + @Override + void store(String key, String value) { + storage.store(key, value); + } + } + </pre> + </blockquote> + + Same example as above, but this time the dependency is added from the init method using the Dependency Manager Lambda: + + <blockquote> + <pre> + import static org.apache.felix.dm.lambda.DependencyManagerActivator.component; + + @Component + public class PersistenceImpl implements Persistence { + // Injected before init. + @ConfigurationDependency + void updated(Dictionary conf) { + if (conf != null) { + _xmlConfiguration = parseXmlConfiguration(conf.get("xmlConfiguration")); + } + } + + // Parsed xml configuration, where we'll get our storage service filter and required dependency flag. + XmlConfiguration _xmlConfiguration; + + // Dynamically configure the dependency declared with a "storage" name. + @Init + void init(org.apache.felix.dm.Comppnent myComponent) { + boolean required = _xmlConfiguration.isStorageRequired(); + String filter = _xmlConfiguration.getStorageType(); + component(myComponent, comp -> comp.withSvc(Storage.class, filter, required)); + } + + // Injected after init, later, when the dependency added from the init() method is satisfied + volatile Storage storage; + + // All dependencies injected, including dynamic dependencies defined from init method. + @Start + void start() { + log.log(LogService.LOG_WARNING, "start"); + } + + @Override + void store(String key, String value) { + storage.store(key, value); + } + } + </pre> + </blockquote></div> +</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Init.html" target="_top">Frames</a></li> +<li><a href="Init.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Inject.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Inject.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Inject.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Inject.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,206 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>Inject</title> +<meta name="date" content="2018-10-22"> +<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="Inject"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Inject.html" target="_top">Frames</a></li> +<li><a href="Inject.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type Inject" class="title">Annotation Type Inject</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Retention(value=CLASS) + @Target(value=FIELD) +public @interface <span class="memberNameLabel">Inject</span></pre> +<div class="block">Inject classes in a component instance field. + The following injections are currently performed, depending on the type of the + field this annotation is applied on: + <ul> + <li>BundleContext: the bundle context of the bundle + <li>DependencyManager: the dependency manager instance + <li>Component: the component instance of the dependency manager + </ul> + + <h3>Usage Examples</h3> + <blockquote> + + <pre> + @Component + class X implements Z { + @Inject + BundleContext bundleContext; + + @Inject + Component component; + + @Inject + DependencyManager manager; + + OtherService otherService; + + @Init + void init() { + System.out.println("Bundle Context: " + bundleContext); + System.out.println("Manager: " + manager); + + // Use DM API for defining an extra service dependency + componnent.add(manager.createServiceDependency() + .setService(OtherService.class) + .setRequired(true) + .setInstanceBound(true)); + } + + @Start + void start() { + System.out.println("OtherService: " + otherService); + } + } + </pre> + </blockquote></div> +</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Inject.html" target="_top">Frames</a></li> +<li><a href="Inject.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>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Element</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/LifecycleController.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/LifecycleController.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/LifecycleController.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/LifecycleController.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>LifecycleController</title> +<meta name="date" content="2018-10-22"> +<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="LifecycleController"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/LifecycleController.html" target="_top">Frames</a></li> +<li><a href="LifecycleController.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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type LifecycleController" class="title">Annotation Type LifecycleController</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Retention(value=CLASS) + @Target(value=FIELD) +public @interface <span class="memberNameLabel">LifecycleController</span></pre> +<div class="block">Injects a <code>Runnable</code> object in a Service for starting/stopping it programatically. + By default, a Service is implicitly started when the service's bundle is started and when + all required dependencies are satisfied. However, it is sometimes required to programatically + take control of when the service is started or stopped. In this case, the injected <code>Runnable</code> + can be invoked in order to start/register (or stop/unregister) a Service at any time. When this annotation + is used, then the Service on which this annotation is applied is not activated by default, and you have to + call the injected Runnable yourself. + + <h3>Usage Examples</h3> + <blockquote> + + <pre> + /** + * This Service will be registered programmatically into the OSGi registry, using the LifecycleController annotation. + */ + @Component + class X implements Z { + @LifecycleController + Runnable starter + + @LifecycleController(start=false) + Runnable stopper + + @Init + void init() { + // At this point, all required dependencies are there, but we'll activate our service in 2 seconds ... + Thread t = new Thread() { + public void run() { + sleep(2000); + // start our "Z" service (our "start" method will be called, juste before service registration + starter.run(); + + sleep(2000); + // now, stop/unregister the "Z" service (we'll then be called in our stop() method + stopper.run(); + } + }; + t.start(); + } + + @Start + public void start() { + // This method will be called after we invoke our starter Runnable, and our service will be + // published after our method returns, as in normal case. + } + + @Stop + public void stop() { + // This method will be called after we invoke our "stop" Runnable, and our service will be + // unregistered before our method is invoked, as in normal case. Notice that the service won't + // be destroyed here, and the "starter" runnable can be re-invoked later. + } + } + </pre> + </blockquote></div> +</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html#start--">start</a></span></code> +<div class="block">Specifies the action to be performed when the injected runnable is invoked.</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="start--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>start</h4> +<pre>public abstract boolean start</pre> +<div class="block">Specifies the action to be performed when the injected runnable is invoked. By default, the + Runnable will fire a Service Component activation, when invoked. If you specify this attribute + to false, then the Service Component will be stopped, when the runnable is invoked.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the component must be started when you invoke the injected runnable, or false if + the component must stopped when invoking the runnable.</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>true</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/LifecycleController.html" target="_top">Frames</a></li> +<li><a href="LifecycleController.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> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Property.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Property.html?rev=1844576&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Property.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r13/org/apache/felix/dm/annotation/api/Property.html Mon Oct 22 16:55:40 2018 @@ -0,0 +1,577 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:37:56 CEST 2018 --> +<title>Property</title> +<meta name="date" content="2018-10-22"> +<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="Property"; + } + } + 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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyType.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Property.html" target="_top">Frames</a></li> +<li><a href="Property.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.apache.felix.dm.annotation.api</div> +<h2 title="Annotation Type Property" class="title">Annotation Type Property</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Retention(value=CLASS) + @Target(value={TYPE,ANNOTATION_TYPE}) + @Repeatable(value=<a href="../../../../../../org/apache/felix/dm/annotation/api/RepeatableProperty.html" title="annotation in org.apache.felix.dm.annotation.api">RepeatableProperty.class</a>) +public @interface <span class="memberNameLabel">Property</span></pre> +<div class="block">Annotation used to describe a property key-value(s) pair. Such annotation can be applied on components.<p> + + Property value(s) type is String by default, and the type is scalar if the value is single-valued, + or an array if the value is multi-valued. You can apply this annotation on a component class multiple times + (it's a java8 repeatable property). + + Eight primitive types are supported: + <ul> + <li> String (default type) + <li> Long + <li> Double + <li> Float + <li> Integer + <li> Byte + <li> Boolean + <li> Short + </ul> + + You can specify the type of a property either using a combination of <code>value</code> and <code>type</code> attributes, + or using one of the <code>longValue/doubleValue/floatValue/intValue/byteValue/charValue/booleanValue/shortValue</code> attributes. + + Notice that you can also specify service properties dynamically by returning a Map from a method + annotated with <a href="../../../../../../org/apache/felix/dm/annotation/api/Start.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Start</code></a>. + + <h3>Usage Examples</h3> + <blockquote> + <pre> + @Component + @Property(name="p1", value="v") // String value type (scalar) + @Property(name="p2", value={"s1", "s2"}) // Array of Strings + @Property(name="service.ranking", intValue=10) // Integer value type (scalar) + @Property(name="p3", intValue={1,2}) // Array of Integers + @Property(name="p3", value="1", type=Long.class) // Long value (scalar) + class ServiceImpl implements Service { + } + </pre> + </blockquote></div> +</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.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#name--">name</a></span></code> +<div class="block">Returns the property name.</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/apache/felix/dm/annotation/api/Property.html#booleanValue--">booleanValue</a></span></code> +<div class="block">A Boolean value or an array of Boolean values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#byteValue--">byteValue</a></span></code> +<div class="block">A Byte value or an array of Byte values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#charValue--">charValue</a></span></code> +<div class="block">A Character value or an array of Character values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#doubleValue--">doubleValue</a></span></code> +<div class="block">A Double value or an array of Double values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#floatValue--">floatValue</a></span></code> +<div class="block">A Float value or an array of Float values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#intValue--">intValue</a></span></code> +<div class="block">An Integer value or an array of Integer values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#longValue--">longValue</a></span></code> +<div class="block">A Long value or an array of Long values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>short[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#shortValue--">shortValue</a></span></code> +<div class="block">A Short value or an array of Short values.</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/apache/felix/dm/annotation/api/Property.html#type--">type</a></span></code> +<div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value--"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values--"><code>values()</code></a> attributes are parsed.</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/apache/felix/dm/annotation/api/Property.html#value--">value</a></span></code> +<div class="block">Returns the property value(s).</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/apache/felix/dm/annotation/api/Property.html#values--">values</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value--"><code>value()</code></a> attribute.</span></div> +</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="blockListLast"> +<li class="blockList"> +<h4>name</h4> +<pre>public abstract java.lang.String name</pre> +<div class="block">Returns the property name.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this property name</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="value--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">Returns the property value(s). The property value(s) is (are) + parsed using the <code>valueOf</code> method of the class specified in the #type attribute + (which is <code>String</code> by default). When the property value is single-value, then + the value type is scalar (not an array). If the property value is multi-valued, then the value type + is an array of the type specified in the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#type--"><code>type()</code></a> attribute (String by default).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this property value(s).</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 java.lang.Class<?> type</pre> +<div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value--"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values--"><code>values()</code></a> attributes are parsed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the property value type (String by default) used to parse <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value--"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values--"><code>values()</code></a> + attribtues</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>java.lang.String.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="longValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>longValue</h4> +<pre>public abstract long[] longValue</pre> +<div class="block">A Long value or an array of Long values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the long value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="doubleValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doubleValue</h4> +<pre>public abstract double[] doubleValue</pre> +<div class="block">A Double value or an array of Double values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the double value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="floatValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>floatValue</h4> +<pre>public abstract float[] floatValue</pre> +<div class="block">A Float value or an array of Float values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the float value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="intValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>intValue</h4> +<pre>public abstract int[] intValue</pre> +<div class="block">An Integer value or an array of Integer values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the int value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="byteValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>byteValue</h4> +<pre>public abstract byte[] byteValue</pre> +<div class="block">A Byte value or an array of Byte values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the byte value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="charValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>charValue</h4> +<pre>public abstract char[] charValue</pre> +<div class="block">A Character value or an array of Character values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the char value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="booleanValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>booleanValue</h4> +<pre>public abstract boolean[] booleanValue</pre> +<div class="block">A Boolean value or an array of Boolean values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the boolean value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="shortValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shortValue</h4> +<pre>public abstract short[] shortValue</pre> +<div class="block">A Short value or an array of Short values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the short value(s).</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="values--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>values</h4> +<pre>public abstract java.lang.String[] values</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value--"><code>value()</code></a> attribute.</span></div> +<div class="block">Returns an array of property values. + The property value are parsed using the <code>valueOf</code> method of the class specified in the #type attribute + (which is <code>String</code> by default).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array of property values.</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="../../../../../../org/apache/felix/dm/annotation/api/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/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyType.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Property.html" target="_top">Frames</a></li> +<li><a href="Property.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>
