| <!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 (version 1.7.0_25) on Mon Mar 31 09:56:28 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Requires (Apache Felix iPOJO ~ JavaDoc 1.11.2 API)</title> |
| <meta name="date" content="2014-03-31"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Requires (Apache Felix iPOJO ~ JavaDoc 1.11.2 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Requires.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/felix/ipojo/annotations/Provides.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/ipojo/annotations/ServiceController.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/ipojo/annotations/Requires.html" target="_top">Frames</a></li> |
| <li><a href="Requires.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>Required | </li> |
| <li><a href="#annotation_type_optional_element_summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#annotation_type_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.ipojo.annotations</div> |
| <h2 title="Annotation Type Requires" class="title">Annotation Type Requires</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>}) |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> |
| public @interface <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.32">Requires</a></pre> |
| <div class="block">This annotation declares a service requirement.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="mailto:dev@felix.apache.org">Felix Project Team</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation_type_optional_element_summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="overviewSummary" 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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#comparator()">comparator</a></strong></code> |
| <div class="block">Set the comparator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#defaultimplementation()">defaultimplementation</a></strong></code> |
| <div class="block">Set the default-implementation to use if the dependency is optional, |
| and no providers are available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#exception()">exception</a></strong></code> |
| <div class="block">Set the exception to throw when the service is not available.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#filter()">filter</a></strong></code> |
| <div class="block">Set the LDAP filter of the dependency.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#from()">from</a></strong></code> |
| <div class="block">Set the from attribute.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#id()">id</a></strong></code> |
| <div class="block">Set the dependency id.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#nullable()">nullable</a></strong></code> |
| <div class="block">Enable / Disable nullable pattern.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#optional()">optional</a></strong></code> |
| <div class="block">Set if the dependency is optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/annotations/BindingPolicy.html" title="enum in org.apache.felix.ipojo.annotations">BindingPolicy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#policy()">policy</a></strong></code> |
| <div class="block">Set the binding policy.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#proxy()">proxy</a></strong></code> |
| <div class="block">Set to true if the service dependency is injected |
| as a proxy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#specification()">specification</a></strong></code> |
| <div class="block">Set the required service specification.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html#timeout()">timeout</a></strong></code> |
| <div class="block">Set the time to wait before applying the 'no service available' action.</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="filter()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filter</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.38">filter</a></pre> |
| <div class="block">Set the LDAP filter of the dependency. |
| Default : no filter</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optional</h4> |
| <pre>public abstract boolean <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.44">optional</a></pre> |
| <div class="block">Set if the dependency is optional. |
| Default : false</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="id()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>id</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.50">id</a></pre> |
| <div class="block">Set the dependency id. |
| Default : empty</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nullable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullable</h4> |
| <pre>public abstract boolean <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.56">nullable</a></pre> |
| <div class="block">Enable / Disable nullable pattern. |
| Default : true</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>true</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="defaultimplementation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultimplementation</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.64">defaultimplementation</a></pre> |
| <div class="block">Set the default-implementation to use if the dependency is optional, |
| and no providers are available. |
| The class must implement the required service interface. |
| Default : no default-implementation</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>java.lang.Class.class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exception()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exception</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a>> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.71">exception</a></pre> |
| <div class="block">Set the exception to throw when the service is not available. This attribute can only be used for optional |
| dependencies. It must be a subclass of <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a>. |
| Default: no exception.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>java.lang.RuntimeException.class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="policy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>policy</h4> |
| <pre>public abstract <a href="../../../../../org/apache/felix/ipojo/annotations/BindingPolicy.html" title="enum in org.apache.felix.ipojo.annotations">BindingPolicy</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.78">policy</a></pre> |
| <div class="block">Set the binding policy. |
| Acceptable policy are dynamic, static and dynamic-priority. |
| Default: dynamic.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>org.apache.felix.ipojo.annotations.BindingPolicy.DYNAMIC</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="comparator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>comparator</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.84">comparator</a></pre> |
| <div class="block">Set the comparator. |
| The indicated class must implement <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a></div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>java.util.Comparator.class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="from()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.89">from</a></pre> |
| <div class="block">Set the from attribute.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="specification()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>specification</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.95">specification</a></pre> |
| <div class="block">Set the required service specification. |
| This attribute is required for Collection field.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>java.lang.Object.class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="proxy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proxy</h4> |
| <pre>public abstract boolean <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.102">proxy</a></pre> |
| <div class="block">Set to true if the service dependency is injected |
| as a proxy. |
| Default: true</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>true</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="timeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>timeout</h4> |
| <pre>public abstract int <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Requires.html#line.111">timeout</a></pre> |
| <div class="block">Set the time to wait before applying the 'no service available' action. |
| This attribute is only valid for optional dependencies. |
| The time is set in milliseconds. |
| Default: no timeout</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>-1</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Requires.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/felix/ipojo/annotations/Provides.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/ipojo/annotations/ServiceController.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/ipojo/annotations/Requires.html" target="_top">Frames</a></li> |
| <li><a href="Requires.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>Required | </li> |
| <li><a href="#annotation_type_optional_element_summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#annotation_type_element_detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2014. All rights reserved.</small></p> |
| </body> |
| </html> |