Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/index.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/index.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/index.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_74) on Wed Feb 24 01:07:11 CET 2016 --> +<title>Generated Documentation (Untitled)</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/BundleDependency.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/BundleDependency.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/BundleDependency.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,527 @@ +<!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:11 CET 2016 --> +<title>BundleDependency</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="BundleDependency"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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="../../../../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>Prev Class</li> +<li><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/BundleDependency.html" target="_top">Frames</a></li> +<li><a href="BundleDependency.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.dm</div> +<h2 title="Interface BundleDependency" class="title">Interface BundleDependency</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>, <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">BundleDependency</span> +extends <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></pre> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_OPTIONAL">STATE_AVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_REQUIRED">STATE_AVAILABLE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_NAMES">STATE_NAMES</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_OPTIONAL">STATE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_REQUIRED">STATE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_OPTIONAL">STATE_UNAVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_REQUIRED">STATE_UNAVAILABLE_REQUIRED</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setAutoConfig-boolean-">setAutoConfig</a></span>(boolean autoConfig)</code> +<div class="block">Enables auto configuration for this dependency.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setBundle-org.osgi.framework.Bundle-">setBundle</a></span>(org.osgi.framework.Bundle bundle)</code> +<div class="block">Sets the bundle to depend on directly.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this dependency.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this dependency.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setCallbacks-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this dependency.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this dependency.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setFilter-java.lang.String-">setFilter</a></span>(java.lang.String filter)</code> +<div class="block">Sets the filter condition to depend on.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setPropagate-boolean-">setPropagate</a></span>(boolean propagate)</code> +<div class="block">Sets property propagation.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setPropagate-java.lang.Object-java.lang.String-">setPropagate</a></span>(java.lang.Object instance, + java.lang.String method)</code> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setRequired-boolean-">setRequired</a></span>(boolean required)</code> +<div class="block">Sets the dependency to be required.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/BundleDependency.html#setStateMask-int-">setStateMask</a></span>(int mask)</code> +<div class="block">Sets the bundle state mask to depend on.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.Dependency"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></h3> +<code><a href="../../../../org/apache/felix/dm/Dependency.html#getAutoConfigName--">getAutoConfigName</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#getProperties--">getProperties</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAutoConfig--">isAutoConfig</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAvailable--">isAvailable</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isPropagated--">isPropagated</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isRequired--">isRequired</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getFilter--">getFilter</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getName--">getName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getSimpleName--">getSimpleName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getState--">getState</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getType--">getType</a></code></li> +</ul> +</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="setCallbacks-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setCallbacks(java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this dependency. These callbacks can be used as hooks whenever a dependency is added or removed. + When you specify callbacks, the auto configuration feature is automatically turned off, because we're assuming you don't + need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>added</code> - the method to call when a bundle was added</dd> +<dd><code>removed</code> - the method to call when a bundle was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setCallbacks(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this dependency. These callbacks can be used as hooks whenever a dependency is added, changed or + removed. When you specify callbacks, the auto configuration feature is automatically turned off, because we're assuming + you don't need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>added</code> - the method to call when a bundle was added</dd> +<dd><code>changed</code> - the method to call when a bundle was changed</dd> +<dd><code>removed</code> - the method to call when a bundle was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.Object-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this dependency. These callbacks can be used as hooks whenever a dependency is added or removed. + They are called on the instance you provide. When you specify callbacks, the auto configuration feature is automatically + turned off, because we're assuming you don't need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the instance to call the callbacks on</dd> +<dd><code>added</code> - the method to call when a bundle was added</dd> +<dd><code>removed</code> - the method to call when a bundle was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this dependency. These callbacks can be used as hooks whenever a dependency is added, changed or + removed. They are called on the instance you provide. When you specify callbacks, the auto configuration feature is + automatically turned off, because we're assuming you don't need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the instance to call the callbacks on</dd> +<dd><code>added</code> - the method to call when a bundle was added</dd> +<dd><code>changed</code> - the method to call when a bundle was changed</dd> +<dd><code>removed</code> - the method to call when a bundle was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setAutoConfig-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setAutoConfig(boolean autoConfig)</pre> +<div class="block">Enables auto configuration for this dependency. This means the component implementation (composition) will be + injected with this bundle dependency automatically.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>autoConfig</code> - <code>true</code> to enable auto configuration</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setRequired-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequired</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setRequired(boolean required)</pre> +<div class="block">Sets the dependency to be required.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>required</code> - <code>true</code> if this bundle dependency is required</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setBundle-org.osgi.framework.Bundle-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBundle</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setBundle(org.osgi.framework.Bundle bundle)</pre> +<div class="block">Sets the bundle to depend on directly.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bundle</code> - the bundle to depend on</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setFilter-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilter</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setFilter(java.lang.String filter) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Sets the filter condition to depend on. Filters are matched against the full manifest of a bundle.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filter</code> - the filter condition</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if the filter is invalid</dd> +</dl> +</li> +</ul> +<a name="setStateMask-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStateMask</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setStateMask(int mask)</pre> +<div class="block">Sets the bundle state mask to depend on. The OSGi BundleTracker explains this mask in more detail, but + it is basically a mask with flags for each potential state a bundle can be in.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mask</code> - the mask to use</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setPropagate-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setPropagate(boolean propagate)</pre> +<div class="block">Sets property propagation. If set to <code>true</code> any bundle manifest properties will be added + to the service properties of the component that has this dependency (if it registers as a service).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>propagate</code> - <code>true</code> to propagate the bundle manifest properties</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the bundle dependency</dd> +</dl> +</li> +</ul> +<a name="setPropagate-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm">BundleDependency</a> setPropagate(java.lang.Object instance, + java.lang.String method)</pre> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties. + The method will be invoked on the specified object instance and must have one of the following signatures: + <ul><li>Dictionary callback(ServiceReference, Object service) + <li>Dictionary callback(ServiceReference) + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the Object instance which is used to retrieve propagated service properties</dd> +<dd><code>method</code> - the method to invoke for retrieving the properties to be propagated to the service properties.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency.</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="../../../../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>Prev Class</li> +<li><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/BundleDependency.html" target="_top">Frames</a></li> +<li><a href="BundleDependency.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 ======= --> +</body> +</html> Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/Component.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/Component.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/Component.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,819 @@ +<!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:11 CET 2016 --> +<title>Component</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="Component"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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="../../../../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/BundleDependency.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/Component.html" target="_top">Frames</a></li> +<li><a href="Component.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.dm</div> +<h2 title="Interface Component" class="title">Interface Component</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Component</span></pre> +<div class="block">Component interface. Components are the main building blocks for OSGi applications. + They can publish themselves as a service, and they can have dependencies. These + dependencies will influence their life cycle as component will only be activated + when all required dependencies are available.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.ComponentStateListener-">add</a></span>(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</code> +<div class="block">Adds a component state listener to this component.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.Dependency...-">add</a></span>(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>... dependencies)</code> +<div class="block">Adds dependency(ies) to this component, atomically.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm">ComponentDeclaration</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getComponentDeclaration--">getComponentDeclaration</a></span>()</code> +<div class="block">Returns the component description (dependencies, service provided, etc ...).</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getDependencyManager--">getDependencyManager</a></span>()</code> +<div class="block">Returns the dependency manager associated with this component.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getInstance--">getInstance</a></span>()</code> +<div class="block">Returns the instance that make up this component.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getInstances--">getInstances</a></span>()</code> +<div class="block">Returns the composition instances that make up this component, or just the + component instance if it does not have a composition, or an empty array if + the component has not even been instantiated.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><K,V> java.util.Dictionary<K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getServiceProperties--">getServiceProperties</a></span>()</code> +<div class="block">Returns the service properties associated with the component.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>org.osgi.framework.ServiceRegistration</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#getServiceRegistration--">getServiceRegistration</a></span>()</code> +<div class="block">Returns the service registration for this component.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.ComponentStateListener-">remove</a></span>(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</code> +<div class="block">Removes a component state listener from this component.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.Dependency-">remove</a></span>(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a> d)</code> +<div class="block">Removes a dependency from the component.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-boolean-">setAutoConfig</a></span>(java.lang.Class<?> clazz, + boolean autoConfig)</code> +<div class="block">Configures auto configuration of injected classes in the component instance.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-java.lang.String-">setAutoConfig</a></span>(java.lang.Class<?> clazz, + java.lang.String instanceName)</code> +<div class="block">Configures auto configuration of injected classes in the component instance.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.Object instance, + java.lang.String init, + java.lang.String start, + java.lang.String stop, + java.lang.String destroy)</code> +<div class="block">Sets the names of the methods used as callbacks.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.String init, + java.lang.String start, + java.lang.String stop, + java.lang.String destroy)</code> +<div class="block">Sets the names of the methods used as callbacks.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.Object-java.lang.String-">setComposition</a></span>(java.lang.Object instance, + java.lang.String getMethod)</code> +<div class="block">Sets the instance and method to invoke to get back all instances that + are part of a composition and need dependencies injected.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.String-">setComposition</a></span>(java.lang.String getMethod)</code> +<div class="block">Sets the method to invoke on the service implementation to get back all + instances that are part of a composition and need dependencies injected.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setDebug-java.lang.String-">setDebug</a></span>(java.lang.String label)</code> +<div class="block">Activate debug for this component.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.Object-java.lang.String-">setFactory</a></span>(java.lang.Object factory, + java.lang.String createMethod)</code> +<div class="block">Sets the factory to use to create the implementation.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.String-">setFactory</a></span>(java.lang.String createMethod)</code> +<div class="block">Sets the factory to use to create the implementation.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setImplementation-java.lang.Object-">setImplementation</a></span>(java.lang.Object implementation)</code> +<div class="block">Sets the implementation for this component.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String:A-java.util.Dictionary-">setInterface</a></span>(java.lang.String[] serviceNames, + java.util.Dictionary<?,?> properties)</code> +<div class="block">Sets the public interfaces under which this component should be registered + in the OSGi service registry.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String-java.util.Dictionary-">setInterface</a></span>(java.lang.String serviceName, + java.util.Dictionary<?,?> properties)</code> +<div class="block">Sets the public interface under which this component should be registered + in the OSGi service registry.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/Component.html#setServiceProperties-java.util.Dictionary-">setServiceProperties</a></span>(java.util.Dictionary<?,?> serviceProperties)</code> +<div class="block">Sets the service properties associated with the component.</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="setImplementation-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setImplementation</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setImplementation(java.lang.Object implementation)</pre> +<div class="block">Sets the implementation for this component. You can actually specify + an instance you have instantiated manually, or a <code>Class</code> + that will be instantiated using its default constructor when the + required dependencies are resolved, effectively giving you a lazy + instantiation mechanism. + + There are four special methods that are called when found through + reflection to give you life cycle management options: + <ol> + <li><code>init()</code> is invoked after the instance has been + created and dependencies have been resolved, and can be used to + initialize the internal state of the instance or even to add more + dependencies based on runtime state</li> + <li><code>start()</code> is invoked right before the service is + registered</li> + <li><code>stop()</code> is invoked right after the service is + unregistered</li> + <li><code>destroy()</code> is invoked after all dependencies are + removed</li> + </ol> + In short, this allows you to initialize your instance before it is + registered, perform some post-initialization and pre-destruction code + as well as final cleanup. If a method is not defined, it simply is not + called, so you can decide which one(s) you need. If you need even more + fine-grained control, you can register as a service state listener too.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>implementation</code> - the implementation</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm"><code>ComponentStateListener</code></a></dd> +</dl> +</li> +</ul> +<a name="add-org.apache.felix.dm.Dependency...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> add(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>... dependencies)</pre> +<div class="block">Adds dependency(ies) to this component, atomically. If the component is already active or if you add + dependencies from the init method, then you should add all the dependencies in one single add method call + (using the varargs argument), because this method may trigger component activation (like + the ServiceTracker.open() method does).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dependencies</code> - the dependencies to add.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="remove-org.apache.felix.dm.Dependency-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> remove(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a> d)</pre> +<div class="block">Removes a dependency from the component.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>d</code> - the dependency to remove</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="add-org.apache.felix.dm.ComponentStateListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> add(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</pre> +<div class="block">Adds a component state listener to this component.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - the state listener</dd> +</dl> +</li> +</ul> +<a name="remove-org.apache.felix.dm.ComponentStateListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> remove(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</pre> +<div class="block">Removes a component state listener from this component.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - the state listener</dd> +</dl> +</li> +</ul> +<a name="setInterface-java.lang.String-java.util.Dictionary-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInterface</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setInterface(java.lang.String serviceName, + java.util.Dictionary<?,?> properties)</pre> +<div class="block">Sets the public interface under which this component should be registered + in the OSGi service registry.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>serviceName</code> - the name of the service interface</dd> +<dd><code>properties</code> - the properties for this service</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setInterface-java.lang.String:A-java.util.Dictionary-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInterface</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setInterface(java.lang.String[] serviceNames, + java.util.Dictionary<?,?> properties)</pre> +<div class="block">Sets the public interfaces under which this component should be registered + in the OSGi service registry.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>serviceNames</code> - the names of the service interface</dd> +<dd><code>properties</code> - the properties for these services</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setAutoConfig-java.lang.Class-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setAutoConfig(java.lang.Class<?> clazz, + boolean autoConfig)</pre> +<div class="block">Configures auto configuration of injected classes in the component instance. + The following injections are currently performed, unless you explicitly + turn them off: + <dl> + <dt>BundleContext</dt><dd>the bundle context of the bundle</dd> + <dt>ServiceRegistration</dt><dd>the service registration used to register your service</dd> + <dt>DependencyManager</dt><dd>the dependency manager instance</dd> + <dt>Component</dt><dd>the component instance of the dependency manager</dd> + </dl></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clazz</code> - the class (from the list above)</dd> +<dd><code>autoConfig</code> - <code>false</code> to turn off auto configuration</dd> +</dl> +</li> +</ul> +<a name="setAutoConfig-java.lang.Class-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setAutoConfig(java.lang.Class<?> clazz, + java.lang.String instanceName)</pre> +<div class="block">Configures auto configuration of injected classes in the component instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clazz</code> - the class (from the list above)</dd> +<dd><code>instanceName</code> - the name of the instance to inject the class into</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-boolean-"><code>setAutoConfig(Class, boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="getServiceRegistration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServiceRegistration</h4> +<pre>org.osgi.framework.ServiceRegistration getServiceRegistration()</pre> +<div class="block">Returns the service registration for this component. The method + will return <code>null</code> if no service registration is + available, for example if this component is not registered as a + service at all.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the service registration</dd> +</dl> +</li> +</ul> +<a name="getInstance--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstance</h4> +<pre><T> T getInstance()</pre> +<div class="block">Returns the instance that make up this component. If the component has a composition of instances, + then the first instance of the composition is returned. Null is returned if the component has not + even been instantiated.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component instances</dd> +</dl> +</li> +</ul> +<a name="getInstances--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstances</h4> +<pre>java.lang.Object[] getInstances()</pre> +<div class="block">Returns the composition instances that make up this component, or just the + component instance if it does not have a composition, or an empty array if + the component has not even been instantiated.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component instances</dd> +</dl> +</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 associated with the component.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the properties or <code>null</code> if there are none</dd> +</dl> +</li> +</ul> +<a name="setServiceProperties-java.util.Dictionary-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setServiceProperties</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setServiceProperties(java.util.Dictionary<?,?> serviceProperties)</pre> +<div class="block">Sets the service properties associated with the component. If the service + was already registered, it will be updated.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>serviceProperties</code> - the properties</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setCallbacks(java.lang.String init, + java.lang.String start, + java.lang.String stop, + java.lang.String destroy)</pre> +<div class="block">Sets the names of the methods used as callbacks. These methods, when found, are + invoked as part of the life cycle management of the component implementation. The + dependency manager will look for a method of this name with the following signatures, + in this order: + <ol> + <li>method(Component component)</li> + <li>method()</li> + </ol></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>init</code> - the name of the init method</dd> +<dd><code>start</code> - the name of the start method</dd> +<dd><code>stop</code> - the name of the stop method</dd> +<dd><code>destroy</code> - the name of the destroy method</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setCallbacks(java.lang.Object instance, + java.lang.String init, + java.lang.String start, + java.lang.String stop, + java.lang.String destroy)</pre> +<div class="block">Sets the names of the methods used as callbacks. These methods, when found, are + invoked on the specified instance as part of the life cycle management of the component + implementation. + <p> + See setCallbacks(String init, String start, String stop, String destroy) for more + information on the signatures. Specifying an instance means you can create a manager + that will be invoked whenever the life cycle of a component changes and this manager + can then decide how to expose this life cycle to the actual component, offering an + important indirection when developing your own component models.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setFactory-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFactory</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setFactory(java.lang.Object factory, + java.lang.String createMethod)</pre> +<div class="block">Sets the factory to use to create the implementation. You can specify + both the factory class and method to invoke. The method should return + the implementation, and can use any method to create it. Actually, this + can be used together with <code>setComposition</code> to create a + composition of instances that work together to implement a component. The + factory itself can also be instantiated lazily by not specifying an + instance, but a <code>Class</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>factory</code> - the factory instance or class</dd> +<dd><code>createMethod</code> - the name of the create method</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setFactory-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFactory</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setFactory(java.lang.String createMethod)</pre> +<div class="block">Sets the factory to use to create the implementation. You specify the + method to invoke. The method should return the implementation, and can + use any method to create it. Actually, this can be used together with + <code>setComposition</code> to create a composition of instances that + work together to implement a component. + <p> + Note that currently, there is no default for the factory, so please use + <code>setFactory(factory, createMethod)</code> instead.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>createMethod</code> - the name of the create method</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setComposition-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setComposition</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setComposition(java.lang.Object instance, + java.lang.String getMethod)</pre> +<div class="block">Sets the instance and method to invoke to get back all instances that + are part of a composition and need dependencies injected. All of them + will be searched for any of the dependencies. The method that is + invoked must return an <code>Object[]</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the instance that has the method</dd> +<dd><code>getMethod</code> - the method to invoke</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</li> +</ul> +<a name="setComposition-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setComposition</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setComposition(java.lang.String getMethod)</pre> +<div class="block">Sets the method to invoke on the service implementation to get back all + instances that are part of a composition and need dependencies injected. + All of them will be searched for any of the dependencies. The method that + is invoked must return an <code>Object[]</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>getMethod</code> - the method to invoke</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component</dd> +</dl> +</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 associated with this component.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the dependency manager associated with this component.</dd> +</dl> +</li> +</ul> +<a name="getComponentDeclaration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComponentDeclaration</h4> +<pre><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm">ComponentDeclaration</a> getComponentDeclaration()</pre> +<div class="block">Returns the component description (dependencies, service provided, etc ...).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component description (dependencies, service provided, etc ...).</dd> +</dl> +</li> +</ul> +<a name="setDebug-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setDebug</h4> +<pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setDebug(java.lang.String label)</pre> +<div class="block">Activate debug for this component. Informations related to dependency processing will be displayed + using osgi log service, our to standard output if no log service is currently available.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>label</code> - </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="../../../../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/BundleDependency.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/Component.html" target="_top">Frames</a></li> +<li><a href="Component.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 ======= --> +</body> +</html> Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/ComponentDeclaration.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/ComponentDeclaration.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r7/org/apache/felix/dm/ComponentDeclaration.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,449 @@ +<!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:11 CET 2016 --> +<title>ComponentDeclaration</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="ComponentDeclaration"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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="../../../../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="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">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="typeNameLabel">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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_NAMES">STATE_NAMES</a></span></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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_REGISTERED">STATE_REGISTERED</a></span></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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#STATE_UNREGISTERED">STATE_UNREGISTERED</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>org.osgi.framework.BundleContext</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getBundleContext--">getBundleContext</a></span>()</code> +<div class="block">Returns the bundle context associated with this component.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Long></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getCallbacksTime--">getCallbacksTime</a></span>()</code> +<div class="block">Returns the execution time in nanos for each component callbacks (init/start/stop/destroy)</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getClassName--">getClassName</a></span>()</code> +<div class="block">Returns the class name of the Component implementation.</div> +</td> +</tr> +<tr id="i3" 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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getComponentDependencies--">getComponentDependencies</a></span>()</code> +<div class="block">Returns a list of dependencies associated with this component.</div> +</td> +</tr> +<tr id="i4" 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><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getDependencyManager--">getDependencyManager</a></span>()</code> +<div class="block">Returns the dependency manager for this component</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getId--">getId</a></span>()</code> +<div class="block">Returns the instance id of this component.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getName--">getName</a></span>()</code> +<div class="block">Returns the description of this component (the classname or the provided service(s))</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><K,V> java.util.Dictionary<K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getServiceProperties--">getServiceProperties</a></span>()</code> +<div class="block">Returns the service properties, or null</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getServices--">getServices</a></span>()</code> +<div class="block">Returns the service optionally provided by this component, or null</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html#getState--">getState</a></span>()</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="seeLabel">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="seeLabel">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>org.osgi.framework.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> +<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="../../../../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="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">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>
