Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Init.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Init.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Init.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Init.html Wed Feb 24 00:11:41 2016 @@ -0,0 +1,224 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Init</title> +<meta name="date" content="2016-02-24"> +<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/FactoryConfigurationAdapterService.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 dynamic + dependencies are injected, then the start method (annotated with @Start) is then invoked. + + <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. + @ServiceDependency + LogService log; + + // 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; + + // Injected after init (dependency filter is defined dynamically from our init method). + @ServiceDependency(name="storage") + Storage storage; + + // Dynamically configure the dependency declared with a "storage" name. + @Init + Map<String, String> init() { + log.log(LogService.LOG_WARNING, "init: storage type=" + storageType + ", storageRequired=" + storageRequired); + Map<String, String> props = new HashMap<>(); + props.put("storage.required", Boolean.toString(_xmlConfiguration.isStorageRequired())) + props.put("storage.filter", "(type=" + _xmlConfiguration.getStorageType() + ")"); + return props; + } + + // 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/FactoryConfigurationAdapterService.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/r7/org/apache/felix/dm/annotation/api/Inject.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Inject.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Inject.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Inject.html Wed Feb 24 00:11:41 2016 @@ -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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Inject</title> +<meta name="date" content="2016-02-24"> +<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/r7/org/apache/felix/dm/annotation/api/LifecycleController.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/LifecycleController.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/LifecycleController.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/LifecycleController.html Wed Feb 24 00:11:41 2016 @@ -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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>LifecycleController</title> +<meta name="date" content="2016-02-24"> +<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/r7/org/apache/felix/dm/annotation/api/Property.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Property.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Property.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Property.html Wed Feb 24 00:11:41 2016 @@ -0,0 +1,578 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Property</title> +<meta name="date" content="2016-02-24"> +<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/PropertyMetaData.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. It is used for example when + declaring <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties--"><code>Component.properties()</code></a> attribute.<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/PropertyMetaData.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> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/PropertyMetaData.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/PropertyMetaData.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/PropertyMetaData.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/PropertyMetaData.html Wed Feb 24 00:11:41 2016 @@ -0,0 +1,478 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>PropertyMetaData</title> +<meta name="date" content="2016-02-24"> +<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="PropertyMetaData"; + } + } + 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/Property.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/Registered.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/PropertyMetaData.html" target="_top">Frames</a></li> +<li><a href="PropertyMetaData.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 PropertyMetaData" class="title">Annotation Type PropertyMetaData</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Retention(value=CLASS) + @Target(value=ANNOTATION_TYPE) +public @interface <span class="memberNameLabel">PropertyMetaData</span></pre> +<div class="block">This annotation describes the data types of a configuration Property. + It can be used by other annotations which require meta type support. + For now, the following annotations are using <code>PropertyMetaData</code>: + <ul> + <li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a>: This dependency allows to define a + dependency over a <code>Configuration Admin</code> configuration dictionaries, whose + metadata can be described using <code>PropertyMetaData</code> annotation. + <li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>FactoryConfigurationAdapterService</code></a>: This service adapter allows + to dynamically create Services on behalf of <code>Factory Configuration Admin</code> + configuration dictionaries, whose metadata can be described using this <code>PropertyMetaData</code> annotation. + </ul></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/PropertyMetaData.html#description--">description</a></span></code> +<div class="block">Returns the property description.</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/PropertyMetaData.html#heading--">heading</a></span></code> +<div class="block">The label used to display the property.</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/PropertyMetaData.html#id--">id</a></span></code> +<div class="block">The key of a ConfigurationAdmin property.</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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#cardinality--">cardinality</a></span></code> +<div class="block">Return the cardinality of this property.</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/PropertyMetaData.html#defaults--">defaults</a></span></code> +<div class="block">Return default value(s) for this property.</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/PropertyMetaData.html#optionLabels--">optionLabels</a></span></code> +<div class="block">Return a list of valid option labels for this property.</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/PropertyMetaData.html#optionValues--">optionValues</a></span></code> +<div class="block">Return a list of option values that this property can take.</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/PropertyMetaData.html#required--">required</a></span></code> +<div class="block">Tells if this property is required or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#type--">type</a></span></code> +<div class="block">Return the property primitive type.</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="heading--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>heading</h4> +<pre>public abstract java.lang.String heading</pre> +<div class="block">The label used to display the property. Example: "Log Level".</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The label used to display the property</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="id--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>id</h4> +<pre>public abstract java.lang.String id</pre> +<div class="block">The key of a ConfigurationAdmin property. Example: "printer.logLevel"</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The Configuration Admin property name</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="description--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>description</h4> +<pre>public abstract java.lang.String description</pre> +<div class="block">Returns the property description. The description may be localized and must describe the semantics of this type and any + constraints. Example: "Select the log level for the Printer Service".</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The localized description of the definition.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<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">Return the property primitive type. If must be either one of the following types: + <ul> + <li>String.class</li> + <li>Long.class</li> + <li>Integer.class</li> + <li>Character.class</li> + <li>Byte.class</li> + <li>Double.class</li> + <li>Float.class</li> + <li>Boolean.class</li> + </ul></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the property type</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="defaults--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>defaults</h4> +<pre>public abstract java.lang.String[] defaults</pre> +<div class="block">Return default value(s) for this property. The object must be of the appropriate type as defined by the cardinality and getType(). + The return type is a list of String objects that can be converted to the appropriate type. The cardinality of the return + array must follow the absolute cardinality of this type. E.g. if the cardinality = 0, the array must contain 1 element. + If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain from 0 to max 5 elements. Note that + the special case of a 0 cardinality, meaning a single value, does not allow arrays or vectors of 0 elements.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the default values</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="cardinality--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cardinality</h4> +<pre>public abstract int cardinality</pre> +<div class="block">Return the cardinality of this property. The OSGi environment handles multi valued properties in arrays ([]) or in Vector objects. + The return value is defined as follows: + + <ul> + <li> x = Integer.MIN_VALUE no limit, but use Vector</li> + <li> x lower than 0 -x = max occurrences, store in Vector</li> + <li> x greater than 0 x = max occurrences, store in array []</li> + <li> x equals Integer.MAX_VALUE no limit, but use array []</li> + <li> x equals 0 1 occurrence required</li> + </ul></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the property cardinality</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>0</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">Tells if this property is required or not.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the property is required, false if not</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>true</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="optionLabels--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>optionLabels</h4> +<pre>public abstract java.lang.String[] optionLabels</pre> +<div class="block">Return a list of valid option labels for this property. The purpose of this method is to allow menus with localized labels. + It is associated with the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute. The labels returned here are ordered in the same way as the + <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the list of valid option labels for this property.</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="optionValues--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>optionValues</h4> +<pre>public abstract java.lang.String[] optionValues</pre> +<div class="block">Return a list of option values that this property can take. This list must be in the same sequence as the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels--"><code>optionLabels()</code></a> + attribute.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the option 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/Property.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/Registered.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/PropertyMetaData.html" target="_top">Frames</a></li> +<li><a href="PropertyMetaData.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> Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Registered.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Registered.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Registered.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Registered.html Wed Feb 24 00:11:41 2016 @@ -0,0 +1,184 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Registered</title> +<meta name="date" content="2016-02-24"> +<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="Registered"; + } + } + 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/PropertyMetaData.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/RepeatableProperty.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/Registered.html" target="_top">Frames</a></li> +<li><a href="Registered.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 Registered" class="title">Annotation Type Registered</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">Registered</span></pre> +<div class="block">This annotation can be used to be notified when a component is registered. At this point, the + component has been registered into the OSGI registry (if it provides some services). + When a service is registered, the ServiceRegistration used to register the service is + also passed to the method (if it takes a ServiceRegistration as parameter). + + <h3>Usage Examples</h3> + <blockquote> + + <pre> + @Component + class X implements Z { + @Start + void start() { + // Our Z Service is about to be registered into the OSGi registry. + } + + @Registered + void registered(ServiceRegistration sr) { + // At this point, our service has been registered into the registry. + } + } + </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/PropertyMetaData.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/RepeatableProperty.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/Registered.html" target="_top">Frames</a></li> +<li><a href="Registered.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/r7/org/apache/felix/dm/annotation/api/RepeatableProperty.html URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/RepeatableProperty.html?rev=1731995&view=auto ============================================================================== --- felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/RepeatableProperty.html (added) +++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/RepeatableProperty.html Wed Feb 24 00:11:41 2016 @@ -0,0 +1,218 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>RepeatableProperty</title> +<meta name="date" content="2016-02-24"> +<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="RepeatableProperty"; + } + } + 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/Registered.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/ResourceAdapterService.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/RepeatableProperty.html" target="_top">Frames</a></li> +<li><a href="RepeatableProperty.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>Optional</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 RepeatableProperty" class="title">Annotation Type RepeatableProperty</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}) +public @interface <span class="memberNameLabel">RepeatableProperty</span></pre> +<div class="block">Annotation used to describe repeated Property annotation. You actually don't have to use directly this annotation, + which is used to allow repeating several times the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation on a given component class.</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><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/RepeatableProperty.html#value--">value</a></span></code> +<div class="block">Returns the set of repeated <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> applied on a given component class.</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="value--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[] value</pre> +<div class="block">Returns the set of repeated <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> applied on a given component class.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the set of repeated <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> applied on a given component class.</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/Registered.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/ResourceAdapterService.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/RepeatableProperty.html" target="_top">Frames</a></li> +<li><a href="RepeatableProperty.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>Optional</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>
