| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 15:13:30 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Reference (Apache Felix Declarative Services 1.6.0 API)</title> |
| <meta name="date" content="2013-07-01"> |
| <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="Reference (Apache Felix Declarative Services 1.6.0 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="../../../../org/apache/felix/scr/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Reference.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> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/scr/Reference.html" target="_top">Frames</a></li> |
| <li><a href="Reference.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</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.scr</div> |
| <h2 title="Interface Reference" class="title">Interface Reference</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Reference</span></pre> |
| <div class="block">The <code>Reference</code> interface represents a single reference (or |
| dependency) to a service used by a Component.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </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/scr/Reference.html#getBindMethodName()">getBindMethodName</a></strong>()</code> |
| <div class="block">Returns the name of the method called if a service is being bound to |
| the Component or <code>null</code> if no such method is configued.</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/scr/Reference.html#getName()">getName</a></strong>()</code> |
| <div class="block">Returns the name of this Reference.</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/scr/Reference.html#getServiceName()">getServiceName</a></strong>()</code> |
| <div class="block">Returns the name of the service used by this Reference.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.osgi.framework.ServiceReference[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/Reference.html#getServiceReferences()">getServiceReferences</a></strong>()</code> |
| <div class="block">Returns an array of references to the services bound to this Reference |
| or <code>null</code> if no services are currently bound.</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/scr/Reference.html#getTarget()">getTarget</a></strong>()</code> |
| <div class="block">Returns the value of the target property of this reference.</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/scr/Reference.html#getUnbindMethodName()">getUnbindMethodName</a></strong>()</code> |
| <div class="block">Returns the name of the method called if a service is being unbound from |
| the Component or <code>null</code> if no such method is configued.</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/scr/Reference.html#getUpdatedMethodName()">getUpdatedMethodName</a></strong>()</code> |
| <div class="block">Returns the name of the method called if a bound service updates its |
| service registration properties or <code>null</code> if no such method |
| is configued.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/Reference.html#isMultiple()">isMultiple</a></strong>()</code> |
| <div class="block">Returns whether this reference is multiple.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/Reference.html#isOptional()">isOptional</a></strong>()</code> |
| <div class="block">Returns whether this reference is optional.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/Reference.html#isSatisfied()">isSatisfied</a></strong>()</code> |
| <div class="block">Returns whether this reference is satisified.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/Reference.html#isStatic()">isStatic</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if the reference is defined with static policy.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><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> getName()</pre> |
| <div class="block">Returns the name of this Reference. This method provides access to the |
| <code>name</code> attribute of the <code>referenec</code> element.</div> |
| </li> |
| </ul> |
| <a name="getServiceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceName</h4> |
| <pre><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> getServiceName()</pre> |
| <div class="block">Returns the name of the service used by this Reference. This method |
| provides access to the <code>interface</code> attribute of the |
| <code>reference</code> element.</div> |
| </li> |
| </ul> |
| <a name="getServiceReferences()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceReferences</h4> |
| <pre>org.osgi.framework.ServiceReference[] getServiceReferences()</pre> |
| <div class="block">Returns an array of references to the services bound to this Reference |
| or <code>null</code> if no services are currently bound.</div> |
| </li> |
| </ul> |
| <a name="isSatisfied()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSatisfied</h4> |
| <pre>boolean isSatisfied()</pre> |
| <div class="block">Returns whether this reference is satisified. A <a href="../../../../org/apache/felix/scr/Reference.html#isOptional()"><code>optional</code></a> |
| component is always satsified. Otherwise <code>true</code> is only |
| returned if at least one service is bound.</div> |
| </li> |
| </ul> |
| <a name="isOptional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>boolean isOptional()</pre> |
| <div class="block">Returns whether this reference is optional. This method provides access |
| to the lower bound of the <code>cardinality</code> attribute of the |
| <code>reference</code> element. In other words, this method returns |
| <code>true</code> if the cardinality is <em>0..1</em> or <em>0..n</em>.</div> |
| </li> |
| </ul> |
| <a name="isMultiple()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMultiple</h4> |
| <pre>boolean isMultiple()</pre> |
| <div class="block">Returns whether this reference is multiple. This method provides access |
| to the upper bound of the <code>cardinality</code> attribute of the |
| <code>reference</code> element. In other words, this method returns |
| <code>true</code> if the cardinality is <em>0..n</em> or <em>1..n</em>.</div> |
| </li> |
| </ul> |
| <a name="isStatic()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStatic</h4> |
| <pre>boolean isStatic()</pre> |
| <div class="block">Returns <code>true</code> if the reference is defined with static policy. |
| This method provides access to the <code>policy</code> element of the |
| <code>reference</code> element. <code>true</code> is returned if the |
| policy is defined as <em>static</em>.</div> |
| </li> |
| </ul> |
| <a name="getTarget()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTarget</h4> |
| <pre><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> getTarget()</pre> |
| <div class="block">Returns the value of the target property of this reference. Initially |
| (without overwriting configuration) this method provides access to the |
| <code>target</code> attribute of the <code>reference</code> element. If |
| configuration overwrites the target property, this method returns the |
| value of the Component property whose name is derived from the |
| <a href="../../../../org/apache/felix/scr/Reference.html#getName()"><code>reference name</code></a> plus the suffix <em>.target</em>. If |
| no target property exists this method returns <code>null</code>.</div> |
| </li> |
| </ul> |
| <a name="getBindMethodName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindMethodName</h4> |
| <pre><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> getBindMethodName()</pre> |
| <div class="block">Returns the name of the method called if a service is being bound to |
| the Component or <code>null</code> if no such method is configued. This |
| method provides access to the <code>bind</code> attribute of the |
| <code>reference</code> element.</div> |
| </li> |
| </ul> |
| <a name="getUnbindMethodName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnbindMethodName</h4> |
| <pre><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> getUnbindMethodName()</pre> |
| <div class="block">Returns the name of the method called if a service is being unbound from |
| the Component or <code>null</code> if no such method is configued. This |
| method provides access to the <code>unbind</code> attribute of the |
| <code>reference</code> element.</div> |
| </li> |
| </ul> |
| <a name="getUpdatedMethodName()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUpdatedMethodName</h4> |
| <pre><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> getUpdatedMethodName()</pre> |
| <div class="block">Returns the name of the method called if a bound service updates its |
| service registration properties or <code>null</code> if no such method |
| is configued. This method provides access to the <code>updated</code> |
| attribute of the <code>reference</code> element. |
| <p> |
| For a component declared in a Declarative Services 1.0 and 1.1 |
| descriptor, this method always returns <code>null</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.4</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="../../../../org/apache/felix/scr/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Reference.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> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/scr/Reference.html" target="_top">Frames</a></li> |
| <li><a href="Reference.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |