Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.0 / org / apache / felix / ipojo / Factory.html
blob: b3dce1391e2d056c50c3c75001b3183240541eab [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Sat May 17 12:14:24 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Factory (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)</title>
<meta name="date" content="2014-05-17">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Factory (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Factory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/FactoryClassloader.html" title="class in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/Factory.html" target="_top">Frames</a></li>
<li><a href="Factory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.ipojo</div>
<h2 title="Interface Factory" class="title">Interface Factory</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/ipojo/HandlerFactory.html" title="interface in org.apache.felix.ipojo">HandlerFactory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/felix/ipojo/ComponentFactory.html" title="class in org.apache.felix.ipojo">ComponentFactory</a>, <a href="../../../../org/apache/felix/ipojo/composite/CompositeFactory.html" title="class in org.apache.felix.ipojo.composite">CompositeFactory</a>, <a href="../../../../org/apache/felix/ipojo/composite/FactoryProxy.html" title="class in org.apache.felix.ipojo.composite">FactoryProxy</a>, <a href="../../../../org/apache/felix/ipojo/HandlerManagerFactory.html" title="class in org.apache.felix.ipojo">HandlerManagerFactory</a>, <a href="../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.33">Factory</a></pre>
<div class="block">Component Type Factory Service. This service is exposed by a instance manager factory, and allows the dynamic creation of component instance.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:dev@felix.apache.org">Felix Project Team</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#FACTORY_VERSION_PROPERTY">FACTORY_VERSION_PROPERTY</a></strong></code>
<div class="block">Instance configuration can set the factory version they target using this property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#INSTANCE_NAME_PROPERTY">INSTANCE_NAME_PROPERTY</a></strong></code>
<div class="block">Instance configuration can set the instance name using this property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#INVALID">INVALID</a></strong></code>
<div class="block">Factory State.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#VALID">VALID</a></strong></code>
<div class="block">Factory State.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#addFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">addFactoryStateListener</a></strong>(<a href="../../../../org/apache/felix/ipojo/FactoryStateListener.html" title="interface in org.apache.felix.ipojo">FactoryStateListener</a>&nbsp;listener)</code>
<div class="block">Adds a factory state listener on the current factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#createComponentInstance(java.util.Dictionary)">createComponentInstance</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;configuration)</code>
<div class="block">Creates an instance manager (i.e.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#createComponentInstance(java.util.Dictionary, org.apache.felix.ipojo.ServiceContext)">createComponentInstance</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;configuration,
<a href="../../../../org/apache/felix/ipojo/ServiceContext.html" title="interface in org.apache.felix.ipojo">ServiceContext</a>&nbsp;serviceContext)</code>
<div class="block">Creates an instance manager (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>BundleContext</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getBundleContext()">getBundleContext</a></strong>()</code>
<div class="block">Gets the bundle context of the factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getClassName()">getClassName</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getComponentDescription()">getComponentDescription</a></strong>()</code>
<div class="block">Gets the component type description.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getComponentMetadata()">getComponentMetadata</a></strong>()</code>
<div class="block">Gets the component type metadata (Element - Attribute structure)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getDescription()">getDescription</a></strong>()</code>
<div class="block">Gets the component type information containing provided service,
configuration properties ...</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getInstances()">getInstances</a></strong>()</code>
<div class="block">Gets the list of instances created by the factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getInstancesNames()">getInstancesNames</a></strong>()</code>
<div class="block">Gets the list of the names of the instances created by the factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getMissingHandlers()">getMissingHandlers</a></strong>()</code>
<div class="block">Gets the list of missing handlers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the factory name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getRequiredHandlers()">getRequiredHandlers</a></strong>()</code>
<div class="block">Get the list of required handlers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getState()">getState</a></strong>()</code>
<div class="block">Returns the state of the factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#getVersion()">getVersion</a></strong>()</code>
<div class="block">Gets the version of the component type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#isAcceptable(java.util.Dictionary)">isAcceptable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;conf)</code>
<div class="block">Checks if the given configuration is acceptable as a configuration
of a component instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#reconfigure(java.util.Dictionary)">reconfigure</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;conf)</code>
<div class="block">Reconfigures an instance already created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Factory.html#removeFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">removeFactoryStateListener</a></strong>(<a href="../../../../org/apache/felix/ipojo/FactoryStateListener.html" title="interface in org.apache.felix.ipojo">FactoryStateListener</a>&nbsp;listener)</code>
<div class="block">Removes the given factory state listener from the listener list.</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="VALID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALID</h4>
<pre>static final&nbsp;int <a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.39">VALID</a></pre>
<div class="block">Factory State.
A valid factory is a factory where all required handlers are available.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Factory.VALID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INVALID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVALID</h4>
<pre>static final&nbsp;int <a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.45">INVALID</a></pre>
<div class="block">Factory State.
An invalid factory is a factory where at least one required handler is
unavailable. Creating an instance with an invalid factory failed.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Factory.INVALID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INSTANCE_NAME_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INSTANCE_NAME_PROPERTY</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.49">INSTANCE_NAME_PROPERTY</a></pre>
<div class="block">Instance configuration can set the instance name using this property.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Factory.INSTANCE_NAME_PROPERTY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FACTORY_VERSION_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FACTORY_VERSION_PROPERTY</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.53">FACTORY_VERSION_PROPERTY</a></pre>
<div class="block">Instance configuration can set the factory version they target using this property.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Factory.FACTORY_VERSION_PROPERTY">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="createComponentInstance(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createComponentInstance</h4>
<pre><a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.64">createComponentInstance</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;configuration)
throws <a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a>,
<a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a>,
<a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></pre>
<div class="block">Creates an instance manager (i.e. component type instance).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the configuration properties for this component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created instance manager.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - if the given configuration is not valid.</dd>
<dd><code><a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - if an handler is missing.</dd>
<dd><code><a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - if the instance configuration failed.</dd></dl>
</li>
</ul>
<a name="createComponentInstance(java.util.Dictionary, org.apache.felix.ipojo.ServiceContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createComponentInstance</h4>
<pre><a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.77">createComponentInstance</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;configuration,
<a href="../../../../org/apache/felix/ipojo/ServiceContext.html" title="interface in org.apache.felix.ipojo">ServiceContext</a>&nbsp;serviceContext)
throws <a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a>,
<a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a>,
<a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></pre>
<div class="block">Creates an instance manager (i.e. component type instance).
The instance is created in the scope given in argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the configuration properties for this component.</dd><dd><code>serviceContext</code> - the service context of the component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created instance manager.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - if the given configuration is not valid.</dd>
<dd><code><a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - if an handler is missing.</dd>
<dd><code><a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - if the instance configuration failed.</dd></dl>
</li>
</ul>
<a name="getDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.85">getDescription</a>()</pre>
<div class="block">Gets the component type information containing provided service,
configuration properties ...</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type information.</dd></dl>
</li>
</ul>
<a name="getComponentDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentDescription</h4>
<pre><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.92">getComponentDescription</a>()</pre>
<div class="block">Gets the component type description.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type description object</dd></dl>
</li>
</ul>
<a name="isAcceptable(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAcceptable</h4>
<pre>boolean&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.101">isAcceptable</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;conf)</pre>
<div class="block">Checks if the given configuration is acceptable as a configuration
of a component instance.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the configuration to test</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the configuration is acceptable</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.108">getName</a>()</pre>
<div class="block">Returns the factory name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the factory.</dd></dl>
</li>
</ul>
<a name="reconfigure(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconfigure</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.119">reconfigure</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a>&nbsp;conf)
throws <a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a>,
<a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></pre>
<div class="block">Reconfigures an instance already created. This configuration needs to
have the name property to identify the instance.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the configuration to reconfigure the instance. The instance.name property must be set to identify
the instance to reconfigure.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - if the given configuration is not consistent for the targeted instance.</dd>
<dd><code><a href="../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - if an handler is missing.</dd></dl>
</li>
</ul>
<a name="addFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFactoryStateListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.126">addFactoryStateListener</a>(<a href="../../../../org/apache/felix/ipojo/FactoryStateListener.html" title="interface in org.apache.felix.ipojo">FactoryStateListener</a>&nbsp;listener)</pre>
<div class="block">Adds a factory state listener on the current factory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to add</dd></dl>
</li>
</ul>
<a name="removeFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFactoryStateListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.133">removeFactoryStateListener</a>(<a href="../../../../org/apache/felix/ipojo/FactoryStateListener.html" title="interface in org.apache.felix.ipojo">FactoryStateListener</a>&nbsp;listener)</pre>
<div class="block">Removes the given factory state listener from the listener list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to remove</dd></dl>
</li>
</ul>
<a name="getMissingHandlers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMissingHandlers</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.141">getMissingHandlers</a>()</pre>
<div class="block">Gets the list of missing handlers.
The handlers are given under the form namespace:name</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list containing the name of missing handlers</dd></dl>
</li>
</ul>
<a name="getRequiredHandlers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredHandlers</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.149">getRequiredHandlers</a>()</pre>
<div class="block">Get the list of required handlers.
The handlers are given under the form namespace:name</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list containing the name of required handlers</dd></dl>
</li>
</ul>
<a name="getClassName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassName</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.158">getClassName</a>()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i></i></div>
<div class="block">Returns the class name of the component type.
For factories which does not contains a class, return "composite"</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the class name of the component type or "composite"</dd></dl>
</li>
</ul>
<a name="getState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre>int&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.165">getState</a>()</pre>
<div class="block">Returns the state of the factory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the state of the factory</dd></dl>
</li>
</ul>
<a name="getBundleContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundleContext</h4>
<pre>BundleContext&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.172">getBundleContext</a>()</pre>
<div class="block">Gets the bundle context of the factory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the bundle context of the factory.</dd></dl>
</li>
</ul>
<a name="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.180">getVersion</a>()</pre>
<div class="block">Gets the version of the component type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type version or <code>null</code> if
not specified.</dd></dl>
</li>
</ul>
<a name="getComponentMetadata()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentMetadata</h4>
<pre><a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.187">getComponentMetadata</a>()</pre>
<div class="block">Gets the component type metadata (Element - Attribute structure)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the root element of the component metadata. The result must <b>not</b> be modified.</dd></dl>
</li>
</ul>
<a name="getInstances()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstances</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.195">getInstances</a>()</pre>
<div class="block">Gets the list of instances created by the factory. The instances must be still alive.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of created (and living) instances</dd><dt><span class="strong">Since:</span></dt>
<dd>1.11.0</dd></dl>
</li>
</ul>
<a name="getInstancesNames()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstancesNames</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/Factory.html#line.203">getInstancesNames</a>()</pre>
<div class="block">Gets the list of the names of the instances created by the factory. The instances must be still alive.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of the names of created (and living) instances</dd><dt><span class="strong">Since:</span></dt>
<dd>1.11.0</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Factory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/FactoryClassloader.html" title="class in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/Factory.html" target="_top">Frames</a></li>
<li><a href="Factory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All rights reserved.</small></p>
</body>
</html>