| <!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_75) on Tue Dec 01 13:56:20 CET 2015 --> |
| <title>ComponentDeclaration</title> |
| <meta name="date" content="2015-12-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="ComponentDeclaration"; |
| } |
| //--> |
| </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="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/Component.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/ComponentDeclaration.html" target="_top">Frames</a></li> |
| <li><a href="ComponentDeclaration.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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.dm</div> |
| <h2 title="Interface ComponentDeclaration" class="title">Interface ComponentDeclaration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ComponentDeclaration</span></pre> |
| <div class="block">Describes a component. Component declarations form descriptions of components |
| that are managed by the dependency manager. They can be used to query their state |
| for monitoring tools. The dependency manager shell command is an example of |
| such a tool.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_NAMES">STATE_NAMES</a></strong></code> |
| <div class="block">Names for the states of this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_REGISTERED">STATE_REGISTERED</a></strong></code> |
| <div class="block">State constant for a registered component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_UNREGISTERED">STATE_UNREGISTERED</a></strong></code> |
| <div class="block">State constant for an unregistered component.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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>BundleContext</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getBundleContext()">getBundleContext</a></strong>()</code> |
| <div class="block">Returns the bundle context associated with this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Long></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getCallbacksTime()">getCallbacksTime</a></strong>()</code> |
| <div class="block">Returns the execution time in nanos for each component callbacks (init/start/stop/destroy)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getClassName()">getClassName</a></strong>()</code> |
| <div class="block">Returns the class name of the Component implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getComponentDependencies()">getComponentDependencies</a></strong>()</code> |
| <div class="block">Returns a list of dependencies associated with this component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm">DependencyManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getDependencyManager()">getDependencyManager</a></strong>()</code> |
| <div class="block">Returns the dependency manager for this component</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getId()">getId</a></strong>()</code> |
| <div class="block">Returns the instance id of this component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getName()">getName</a></strong>()</code> |
| <div class="block">Returns the description of this component (the classname or the provided service(s))</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><K,V> java.util.Dictionary<K,V></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getServiceProperties()">getServiceProperties</a></strong>()</code> |
| <div class="block">Returns the service properties, or null</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getServices()">getServices</a></strong>()</code> |
| <div class="block">Returns the service optionally provided by this component, or null</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getState()">getState</a></strong>()</code> |
| <div class="block">Returns the state of this component.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="STATE_NAMES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STATE_NAMES</h4> |
| <pre>static final java.lang.String[] STATE_NAMES</pre> |
| <div class="block">Names for the states of this component.</div> |
| </li> |
| </ul> |
| <a name="STATE_UNREGISTERED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STATE_UNREGISTERED</h4> |
| <pre>static final int STATE_UNREGISTERED</pre> |
| <div class="block">State constant for an unregistered component.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ComponentDeclaration.STATE_UNREGISTERED">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="STATE_REGISTERED"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>STATE_REGISTERED</h4> |
| <pre>static final int STATE_REGISTERED</pre> |
| <div class="block">State constant for a registered component.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ComponentDeclaration.STATE_REGISTERED">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getComponentDependencies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentDependencies</h4> |
| <pre><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>[] getComponentDependencies()</pre> |
| <div class="block">Returns a list of dependencies associated with this component.</div> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block">Returns the description of this component (the classname or the provided service(s))</div> |
| </li> |
| </ul> |
| <a name="getClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassName</h4> |
| <pre>java.lang.String getClassName()</pre> |
| <div class="block">Returns the class name of the Component implementation.</div> |
| </li> |
| </ul> |
| <a name="getServices()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServices</h4> |
| <pre>java.lang.String[] getServices()</pre> |
| <div class="block">Returns the service optionally provided by this component, or null</div> |
| </li> |
| </ul> |
| <a name="getServiceProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceProperties</h4> |
| <pre><K,V> java.util.Dictionary<K,V> getServiceProperties()</pre> |
| <div class="block">Returns the service properties, or null</div> |
| </li> |
| </ul> |
| <a name="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>int getState()</pre> |
| <div class="block">Returns the state of this component.</div> |
| </li> |
| </ul> |
| <a name="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>long getId()</pre> |
| <div class="block">Returns the instance id of this component.</div> |
| </li> |
| </ul> |
| <a name="getBundleContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBundleContext</h4> |
| <pre>BundleContext getBundleContext()</pre> |
| <div class="block">Returns the bundle context associated with this component.</div> |
| </li> |
| </ul> |
| <a name="getDependencyManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDependencyManager</h4> |
| <pre><a href="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm">DependencyManager</a> getDependencyManager()</pre> |
| <div class="block">Returns the dependency manager for this component</div> |
| </li> |
| </ul> |
| <a name="getCallbacksTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCallbacksTime</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.Long> getCallbacksTime()</pre> |
| <div class="block">Returns the execution time in nanos for each component callbacks (init/start/stop/destroy)</div> |
| </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="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/Component.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/ComponentDeclaration.html" target="_top">Frames</a></li> |
| <li><a href="ComponentDeclaration.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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 ======= --> |
| </body> |
| </html> |
