Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/ComponentContext.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/ComponentContext.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/ComponentContext.html Mon Oct 22 16:46:37 2018 @@ -0,0 +1,735 @@ +<!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_172) on Mon Oct 22 18:34:41 CEST 2018 --> +<title>ComponentContext</title> +<meta name="date" content="2018-10-22"> +<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="ComponentContext"; + } + } + 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}; +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/context/AbstractDependency.html" title="class in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/ComponentContext.html" target="_top">Frames</a></li> +<li><a href="ComponentContext.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.context</div> +<h2 title="Interface ComponentContext" class="title">Interface ComponentContext<T extends <a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a><T>></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/AbstractComponent.html" title="interface in org.apache.felix.dm">AbstractComponent</a>, <a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a><T></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ComponentContext<T extends <a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a><T>></span> +extends <a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a><T></pre> +<div class="block">This interface is the entry point to the Component implementation context. + It is used by all DependencyManager Dependency implementations.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context"><code>interface</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.felix.dm.Component"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.felix.dm.<a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></h3> +<code><a href="../../../../../org/apache/felix/dm/Component.ServiceScope.html" title="enum in org.apache.felix.dm">Component.ServiceScope</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><U> U</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#createConfigurationType-java.lang.Class-java.util.Dictionary-">createConfigurationType</a></span>(java.lang.Class<U> type, + java.util.Dictionary<?,?> config)</code> +<div class="block">Creates a configuration for a given type backed by a given dictionary.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getAutoConfig-java.lang.Class-">getAutoConfig</a></span>(java.lang.Class<?> clazz)</code> +<div class="block">Indicates if an object of the given class can be injected in one field of the component</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/context/ComponentContext.html#getAutoConfigInstance-java.lang.Class-">getAutoConfigInstance</a></span>(java.lang.Class<?> clazz)</code> +<div class="block">Returns the component instance field that is assignable to a given class type</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>Bundle</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getBundle--">getBundle</a></span>()</code> +<div class="block">Returns the Compoent's bundle.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>BundleContext</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getBundleContext--">getBundleContext</a></span>()</code> +<div class="block">Returns the Component's bundle context</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getDependencies--">getDependencies</a></span>()</code> +<div class="block">Returns the list of dependencies that has been registered on this component</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getDependencyEvent-org.apache.felix.dm.context.DependencyContext-">getDependencyEvent</a></span>(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc)</code> +<div class="block">Returns the highest ranked dependency service instance for a given dependency</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getDependencyEvents-org.apache.felix.dm.context.DependencyContext-">getDependencyEvents</a></span>(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc)</code> +<div class="block">Returns all the available dependency services for a given dependency</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.util.concurrent.Executor</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getExecutor--">getExecutor</a></span>()</code> +<div class="block">Returns the Component Executor gate that can be used to ensure proper component event serialization.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getInstances--">getInstances</a></span>()</code> +<div class="block">Returns the component instances</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/Logger.html" title="class in org.apache.felix.dm">Logger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#getLogger--">getLogger</a></span>()</code> +<div class="block">Returns the logger which can be used by the DependencyManager Dependencies implementations.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#handleEvent-org.apache.felix.dm.context.DependencyContext-org.apache.felix.dm.context.EventType-org.apache.felix.dm.context.Event...-">handleEvent</a></span>(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc, + <a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context">EventType</a> type, + <a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>... event)</code> +<div class="block">Notifies the Component about a dependency event.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#injectionDisabled--">injectionDisabled</a></span>()</code> +<div class="block">Indicates if the component fields and methods injections are disabled.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#instantiateComponent--">instantiateComponent</a></span>()</code> +<div class="block">Instantiates the component instances.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#invokeCallback-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.util.function.Supplier:A:A-boolean-">invokeCallback</a></span>(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.util.function.Supplier<?>[][] paramsSupplier, + boolean logIfNotFound)</code> +<div class="block">Invokes a callback method on a given set of objects.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#invokeCallbackMethod-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.lang.Object:A:A-">invokeCallbackMethod</a></span>(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.lang.Object[][] parameters)</code> +<div class="block">Invokes a callback method on a given set of objects.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#invokeCallbackMethod-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.lang.Object:A:A-boolean-">invokeCallbackMethod</a></span>(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.lang.Object[][] parameters, + boolean logIfNotFound)</code> +<div class="block">Invokes a callback method on a given set of objects.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#isActive--">isActive</a></span>()</code> +<div class="block">Is this component already started ?</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#isAvailable--">isAvailable</a></span>()</code> +<div class="block">Is this component available (all required dependencies are available) ?</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#setThreadPool-java.util.concurrent.Executor-">setThreadPool</a></span>(java.util.concurrent.Executor threadPool)</code> +<div class="block">Sets a threadpool that the component will use when handling external events</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#start--">start</a></span>()</code> +<div class="block">Starts the component.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#stop--">stop</a></span>()</code> +<div class="block">Stops the component.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.Component"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></h3> +<code><a href="../../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.ComponentStateListener-">add</a>, <a href="../../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.Dependency...-">add</a>, <a href="../../../../../org/apache/felix/dm/Component.html#getServiceRegistration--">getServiceRegistration</a>, <a href="../../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.ComponentStateListener-">remove</a>, <a href="../../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.Dependency-">remove</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-boolean-">setAutoConfig</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-java.lang.String-">setAutoConfig</a>, <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 >, <a >href="../../../../../org/apache/felix/dm/Component.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.Object-java.lang.String-">setComposition</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.String-">setComposition</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setDebug-java.lang.String-">setDebug</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.Object-java.lang.String-">setFactory</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.String-">setFactory</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setImplementation-java.lang.Object-">setImplementation</a>, > <a >href="../../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.Class:A-java.util.Dictionary-">setInterface</a>, > <a href="../. ./../../../org/apache/felix/dm/Component.html#setInterface-java.lang.Class-java.util.Dictionary-">setInterface</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String:A-java.util.Dictionary-">setInterface</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String-java.util.Dictionary-">setInterface</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setScope-org.apache.felix.dm.Component.ServiceScope-">setScope</a>, <a href="../../../../../org/apache/felix/dm/Component.html#setServiceProperties-java.util.Dictionary-">setServiceProperties</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.AbstractComponent"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../../org/apache/felix/dm/AbstractComponent.html" title="interface in org.apache.felix.dm">AbstractComponent</a></h3> +<code><a href="../../../../../org/apache/felix/dm/AbstractComponent.html#getComponentDeclaration--">getComponentDeclaration</a>, <a href="../../../../../org/apache/felix/dm/AbstractComponent.html#getDependencyManager--">getDependencyManager</a>, <a href="../../../../../org/apache/felix/dm/AbstractComponent.html#getInstance--">getInstance</a>, <a href="../../../../../org/apache/felix/dm/AbstractComponent.html#getServiceProperties--">getServiceProperties</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="getExecutor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExecutor</h4> +<pre>java.util.concurrent.Executor getExecutor()</pre> +<div class="block">Returns the Component Executor gate that can be used to ensure proper component event serialization. + When you schedule a task in the component executor, your task is executed safely and you do not need + to managed synchronization (other external events, like service dependency events) will be queued + until your task has been executed).</div> +</li> +</ul> +<a name="getLogger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogger</h4> +<pre><a href="../../../../../org/apache/felix/dm/Logger.html" title="class in org.apache.felix.dm">Logger</a> getLogger()</pre> +<div class="block">Returns the logger which can be used by the DependencyManager Dependencies implementations.</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 Component's bundle context</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Component's bundle context</dd> +</dl> +</li> +</ul> +<a name="getBundle--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBundle</h4> +<pre>Bundle getBundle()</pre> +<div class="block">Returns the Compoent's bundle.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Compoent's bundle.</dd> +</dl> +</li> +</ul> +<a name="setThreadPool-java.util.concurrent.Executor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setThreadPool</h4> +<pre>void setThreadPool(java.util.concurrent.Executor threadPool)</pre> +<div class="block">Sets a threadpool that the component will use when handling external events</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>threadPool</code> - a threadpool used to handle component events and invoke the component's lifecycle callbacks</dd> +</dl> +</li> +</ul> +<a name="start--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>void start()</pre> +<div class="block">Starts the component. All initial dependencies previously added to the component will be started.</div> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop()</pre> +<div class="block">Stops the component.</div> +</li> +</ul> +<a name="isActive--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isActive</h4> +<pre>boolean isActive()</pre> +<div class="block">Is this component already started ?</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this component has been started</dd> +</dl> +</li> +</ul> +<a name="isAvailable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAvailable</h4> +<pre>boolean isAvailable()</pre> +<div class="block">Is this component available (all required dependencies are available) ?</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this component is available (all dependencies are available), or false</dd> +</dl> +</li> +</ul> +<a name="handleEvent-org.apache.felix.dm.context.DependencyContext-org.apache.felix.dm.context.EventType-org.apache.felix.dm.context.Event...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleEvent</h4> +<pre>void handleEvent(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc, + <a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context">EventType</a> type, + <a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>... event)</pre> +<div class="block">Notifies the Component about a dependency event. + An event is for example fired when:<p> + <ul> + <li> a dependency service becomes available <a href="../../../../../org/apache/felix/dm/context/EventType.html#ADDED"><code>EventType.ADDED</code></a>) + <li> a dependenc service has changed is changed <a href="../../../../../org/apache/felix/dm/context/EventType.html#CHANGED"><code>EventType.CHANGED</code></a>) + <li> a dependency service has been lost <a href="../../../../../org/apache/felix/dm/context/EventType.html#REMOVED"><code>EventType.REMOVED</code></a>) + <li> a dependency service has been swapped by another <a href="../../../../../org/apache/felix/dm/context/EventType.html#SWAPPED"><code>EventType.SWAPPED</code></a>) + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dc</code> - the dependency</dd> +<dd><code>type</code> - the dependency event type</dd> +<dd><code>e</code> - the dependency event</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context"><code>EventType</code></a></dd> +</dl> +</li> +</ul> +<a name="getDependencies--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDependencies</h4> +<pre>java.util.List<<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a>> getDependencies()</pre> +<div class="block">Returns the list of dependencies that has been registered on this component</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the list of dependencies that has been registered on this component</dd> +</dl> +</li> +</ul> +<a name="invokeCallbackMethod-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.lang.Object:A:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeCallbackMethod</h4> +<pre>void invokeCallbackMethod(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.lang.Object[][] parameters)</pre> +<div class="block">Invokes a callback method on a given set of objects. An error is logged if the callback is not found in any of the object instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instances</code> - the component instances</dd> +<dd><code>methodName</code> - the method name</dd> +<dd><code>signatures</code> - the method signatures (types)</dd> +<dd><code>parameters</code> - the method parameters</dd> +</dl> +</li> +</ul> +<a name="invokeCallbackMethod-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.lang.Object:A:A-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeCallbackMethod</h4> +<pre>void invokeCallbackMethod(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.lang.Object[][] parameters, + boolean logIfNotFound)</pre> +<div class="block">Invokes a callback method on a given set of objects.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instances</code> - the component instances</dd> +<dd><code>methodName</code> - the method name</dd> +<dd><code>signatures</code> - the method signatures (types)</dd> +<dd><code>parameters</code> - the method parameters</dd> +<dd><code>logIfNotFound</code> - true if a warning message should be logged in case the callback is not found in any of the object instances.</dd> +</dl> +</li> +</ul> +<a name="invokeCallback-java.lang.Object:A-java.lang.String-java.lang.Class:A:A-java.util.function.Supplier:A:A-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeCallback</h4> +<pre>void invokeCallback(java.lang.Object[] instances, + java.lang.String methodName, + java.lang.Class<?>[][] signatures, + java.util.function.Supplier<?>[][] paramsSupplier, + boolean logIfNotFound)</pre> +<div class="block">Invokes a callback method on a given set of objects. An error is logged if the callback is not found in any of the object instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instances</code> - the component instances</dd> +<dd><code>methodName</code> - the method name</dd> +<dd><code>signatures</code> - the method signatures (types)</dd> +<dd><code>paramsSupplier</code> - the supplier for the method parameters</dd> +<dd><code>logIfNotFound</code> - true if a warning message should be logged in case the callback is not found in any of the object 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 component instances</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/felix/dm/AbstractComponent.html#getInstances--">getInstances</a></code> in interface <code><a href="../../../../../org/apache/felix/dm/AbstractComponent.html" title="interface in org.apache.felix.dm">AbstractComponent</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component instances</dd> +</dl> +</li> +</ul> +<a name="getAutoConfigInstance-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoConfigInstance</h4> +<pre>java.lang.String getAutoConfigInstance(java.lang.Class<?> clazz)</pre> +<div class="block">Returns the component instance field that is assignable to a given class type</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clazz</code> - the type of an object that has to be injected in the component instance field</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the component instance field that can be assigned to an object having the same type as + the "clazz" parameter</dd> +</dl> +</li> +</ul> +<a name="getAutoConfig-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoConfig</h4> +<pre>boolean getAutoConfig(java.lang.Class<?> clazz)</pre> +<div class="block">Indicates if an object of the given class can be injected in one field of the component</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clazz</code> - the class of an object that has to be injected in one of the component fields</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the component can be injected with an object having the specified "clazz" type.</dd> +</dl> +</li> +</ul> +<a name="getDependencyEvent-org.apache.felix.dm.context.DependencyContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDependencyEvent</h4> +<pre><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a> getDependencyEvent(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc)</pre> +<div class="block">Returns the highest ranked dependency service instance for a given dependency</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dc</code> - the dependency</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the highest ranked dependency service instance for a given dependency</dd> +</dl> +</li> +</ul> +<a name="getDependencyEvents-org.apache.felix.dm.context.DependencyContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDependencyEvents</h4> +<pre>java.util.Set<<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>> getDependencyEvents(<a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> dc)</pre> +<div class="block">Returns all the available dependency services for a given dependency</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dc</code> - the dependency</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>all the available dependency services for a given dependency</dd> +</dl> +</li> +</ul> +<a name="createConfigurationType-java.lang.Class-java.util.Dictionary-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createConfigurationType</h4> +<pre><U> U createConfigurationType(java.lang.Class<U> type, + java.util.Dictionary<?,?> config)</pre> +<div class="block">Creates a configuration for a given type backed by a given dictionary. + This method can be used by any custom Dependency Manager dependency that + needs to expose some configuration through a dynamic proxy interface.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - the configuration class, cannot be <code>null</code>;</dd> +<dd><code>config</code> - the configuration to wrap, cannot be <code>null</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an instance of the given type that wraps the given configuration.</dd> +</dl> +</li> +</ul> +<a name="instantiateComponent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiateComponent</h4> +<pre><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a> instantiateComponent()</pre> +<div class="block">Instantiates the component instances.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this component context.</dd> +</dl> +</li> +</ul> +<a name="injectionDisabled--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>injectionDisabled</h4> +<pre>boolean injectionDisabled()</pre> +<div class="block">Indicates if the component fields and methods injections are disabled.</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/context/AbstractDependency.html" title="class in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/ComponentContext.html" target="_top">Frames</a></li> +<li><a href="ComponentContext.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/r13/org/apache/felix/dm/context/DependencyContext.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/DependencyContext.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/DependencyContext.html Mon Oct 22 16:46:37 2018 @@ -0,0 +1,526 @@ +<!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_172) on Mon Oct 22 18:34:41 CEST 2018 --> +<title>DependencyContext</title> +<meta name="date" content="2018-10-22"> +<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="DependencyContext"; + } + } + 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}; +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/context/ComponentContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/DependencyContext.html" target="_top">Frames</a></li> +<li><a href="DependencyContext.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.context</div> +<h2 title="Interface DependencyContext" class="title">Interface DependencyContext</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/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/felix/dm/context/AbstractDependency.html" title="class in org.apache.felix.dm.context">AbstractDependency</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DependencyContext</span> +extends <a href="../../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></pre> +<div class="block">Every DependencyManager Dependency implementations must implement this interface.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>AbstractDependency} which already implements most of the methods from this interface.</code></dd> +</dl> +</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#copyToCollection-java.util.Collection-">copyToCollection</a></span>(java.util.Collection<java.lang.Object> coll)</code> +<div class="block">Copies all the dependency service instances to the given collection.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#copyToMap-java.util.Map-">copyToMap</a></span>(java.util.Map<java.lang.Object,java.util.Dictionary<?,?>> map)</code> +<div class="block">Copies all the dependency service instances to the given map (key = dependency service, value = dependency servie properties).</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#createCopy--">createCopy</a></span>()</code> +<div class="block">Creates a clone of this dependency.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#getAutoConfigType--">getAutoConfigType</a></span>()</code> +<div class="block">Returns the type of the field which can be injected with the dependency service.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#getComponentContext--">getComponentContext</a></span>()</code> +<div class="block">Returns the Component implementation context associated to this Dependency context.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#getService--">getService</a></span>()</code> +<div class="block">Returns the highest ranked available dependency service instance, or null if the dependency is unavailable.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#invokeCallback-org.apache.felix.dm.context.EventType-org.apache.felix.dm.context.Event...-">invokeCallback</a></span>(<a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context">EventType</a> type, + <a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>... events)</code> +<div class="block">The Component implementation asks this dependency to invoke a component dependency callback.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#isInstanceBound--">isInstanceBound</a></span>()</code> +<div class="block">Is this dependency instance bound ?</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#isStarted--">isStarted</a></span>()</code> +<div class="block">Returns true if the dependency has been started, false if not</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#needsInstance--">needsInstance</a></span>()</code> +<div class="block">Does this dependency need the component instances to determine if the dependency is available or not.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#setAvailable-boolean-">setAvailable</a></span>(boolean available)</code> +<div class="block">Sets this dependency as available, meaning that at least one dependency service is available.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#setComponentContext-org.apache.felix.dm.context.ComponentContext-">setComponentContext</a></span>(<a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a> component)</code> +<div class="block">Stores the Component implementation context in the Dependency Implementation.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#setInstanceBound-boolean-">setInstanceBound</a></span>(boolean instanceBound)</code> +<div class="block">Sets this dependency as "instance bound".</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#start--">start</a></span>()</code> +<div class="block">Invoked by the component context when the dependency should start working.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html#stop--">stop</a></span>()</code> +<div class="block">Invoked by the component context when the dependency should stop working.</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>, <a href="../../../../../org/apache/felix/dm/Dependency.html#overrideServiceProperties--">overrideServiceProperties</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="setComponentContext-org.apache.felix.dm.context.ComponentContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setComponentContext</h4> +<pre>void setComponentContext(<a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a> component)</pre> +<div class="block">Stores the Component implementation context in the Dependency Implementation. This object is the entry point to + the Component implementation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>component</code> - the Component implementation context</dd> +</dl> +</li> +</ul> +<a name="getComponentContext--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComponentContext</h4> +<pre><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a> getComponentContext()</pre> +<div class="block">Returns the Component implementation context associated to this Dependency context.</div> +</li> +</ul> +<a name="invokeCallback-org.apache.felix.dm.context.EventType-org.apache.felix.dm.context.Event...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeCallback</h4> +<pre>void invokeCallback(<a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context">EventType</a> type, + <a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>... events)</pre> +<div class="block">The Component implementation asks this dependency to invoke a component dependency callback.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - the type of the callback to invoke (add/change/remove/swap ...)</dd> +<dd><code>events</code> - the dependency service event(s) that has previously been submitted to the component implementation using + the ComponentContext.handleEvent method. The number of events depends on the event type: one event for ADDED/CHANGED/REMOVED, + and two events for the SWAPPED event.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html#handleEvent-org.apache.felix.dm.context.DependencyContext-org.apache.felix.dm.context.EventType-org.apache.felix.dm.context.Event...-"><code>ComponentContext.handleEvent(DependencyContext, EventType, Event...)</code></a>, +<a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context"><code>EventType</code></a></dd> +</dl> +</li> +</ul> +<a name="start--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>void start()</pre> +<div class="block">Invoked by the component context when the dependency should start working.</div> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop()</pre> +<div class="block">Invoked by the component context when the dependency should stop working.</div> +</li> +</ul> +<a name="isStarted--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isStarted</h4> +<pre>boolean isStarted()</pre> +<div class="block">Returns true if the dependency has been started, false if not</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the dependency has been started, false if not</dd> +</dl> +</li> +</ul> +<a name="setAvailable-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAvailable</h4> +<pre>void setAvailable(boolean available)</pre> +<div class="block">Sets this dependency as available, meaning that at least one dependency service is available.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>available</code> - true to mark this dependency as available, false to mark it as unavailable</dd> +</dl> +</li> +</ul> +<a name="setInstanceBound-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInstanceBound</h4> +<pre>void setInstanceBound(boolean instanceBound)</pre> +<div class="block">Sets this dependency as "instance bound". A dependency is "instance bound" if it is defined from the + component's init method.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>true</code> - if the dependency has to be marked as "intance bound", false if not.</dd> +</dl> +</li> +</ul> +<a name="isInstanceBound--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInstanceBound</h4> +<pre>boolean isInstanceBound()</pre> +<div class="block">Is this dependency instance bound ?</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this dependency is instance bound, false if not</dd> +</dl> +</li> +</ul> +<a name="needsInstance--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>needsInstance</h4> +<pre>boolean needsInstance()</pre> +<div class="block">Does this dependency need the component instances to determine if the dependency is available or not.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the dependency need the component instances before it can be started, false if not.</dd> +</dl> +</li> +</ul> +<a name="getAutoConfigType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoConfigType</h4> +<pre>java.lang.Class<?> getAutoConfigType()</pre> +<div class="block">Returns the type of the field which can be injected with the dependency service.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the type of the field which can be injected with the dependency service, or null if the dependency does not + support auto config mode.</dd> +</dl> +</li> +</ul> +<a name="getService--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getService</h4> +<pre><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a> getService()</pre> +<div class="block">Returns the highest ranked available dependency service instance, or null if the dependency is unavailable.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the highest ranked available dependency service instance, or null</dd> +</dl> +</li> +</ul> +<a name="copyToCollection-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToCollection</h4> +<pre>void copyToCollection(java.util.Collection<java.lang.Object> coll)</pre> +<div class="block">Copies all the dependency service instances to the given collection.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>coll</code> - the collection where the dependency service instances will be copied</dd> +</dl> +</li> +</ul> +<a name="copyToMap-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToMap</h4> +<pre>void copyToMap(java.util.Map<java.lang.Object,java.util.Dictionary<?,?>> map)</pre> +<div class="block">Copies all the dependency service instances to the given map (key = dependency service, value = dependency servie properties).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>map</code> - the map where the dependency service instances (with the corresponding service properties)</dd> +</dl> +</li> +</ul> +<a name="createCopy--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createCopy</h4> +<pre><a href="../../../../../org/apache/felix/dm/context/DependencyContext.html" title="interface in org.apache.felix.dm.context">DependencyContext</a> createCopy()</pre> +<div class="block">Creates a clone of this dependency.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a clone of this 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><a href="../../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/DependencyContext.html" target="_top">Frames</a></li> +<li><a href="DependencyContext.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/r13/org/apache/felix/dm/context/Event.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/Event.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r13/org/apache/felix/dm/context/Event.html Mon Oct 22 16:46:37 2018 @@ -0,0 +1,398 @@ +<!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_172) on Mon Oct 22 18:34:41 CEST 2018 --> +<title>Event</title> +<meta name="date" content="2018-10-22"> +<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="Event"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/context/DependencyContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/Event.html" target="_top">Frames</a></li> +<li><a href="Event.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.context</div> +<h2 title="Class Event" class="title">Class Event</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.felix.dm.context.Event</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Event</span> +extends java.lang.Object +implements java.lang.Comparable<<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>></pre> +<div class="block">An event holds all data that belongs to some external event as it comes in via + the 'changed' callback of a dependency.</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>protected static java.util.Dictionary<java.lang.Object,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#EMPTY_PROPERTIES">EMPTY_PROPERTIES</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#Event-java.lang.Object-">Event</a></span>(java.lang.Object event)</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#close--">close</a></span>()</code> +<div class="block">Release the resources this event is holding (like service reference for example).</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#compareTo-org.apache.felix.dm.context.Event-">compareTo</a></span>(<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a> o)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#getEvent--">getEvent</a></span>()</code> +<div class="block">Returns the actual event object wrapped by this event (a Service Dependency, a Bundle for Bundle Dependency, etc...).</div> +</td> +</tr> +<tr id="i4" 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/context/Event.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Returns the properties of the actual event object wrapped by this event (Service Dependency properties, ...).</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/context/Event.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</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="EMPTY_PROPERTIES"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY_PROPERTIES</h4> +<pre>protected static final java.util.Dictionary<java.lang.Object,java.lang.Object> EMPTY_PROPERTIES</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Event-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Event</h4> +<pre>public Event(java.lang.Object event)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getEvent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvent</h4> +<pre>public <T> T getEvent()</pre> +<div class="block">Returns the actual event object wrapped by this event (a Service Dependency, a Bundle for Bundle Dependency, etc...).</div> +</li> +</ul> +<a name="getProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <K,V> java.util.Dictionary<K,V> getProperties()</pre> +<div class="block">Returns the properties of the actual event object wrapped by this event (Service Dependency properties, ...).</div> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="compareTo-org.apache.felix.dm.context.Event-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a> o)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../../org/apache/felix/dm/context/Event.html" title="class in org.apache.felix.dm.context">Event</a>></code></dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Release the resources this event is holding (like service reference for example).</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/context/DependencyContext.html" title="interface in org.apache.felix.dm.context"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/felix/dm/context/EventType.html" title="enum in org.apache.felix.dm.context"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/felix/dm/context/Event.html" target="_top">Frames</a></li> +<li><a href="Event.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>