| <!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 Jun 29 08:36:31 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SingletonComponentType (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)</title> |
| <meta name="date" content="2013-06-29"> |
| <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="SingletonComponentType (Apache Felix iPOJO ~ JavaDoc 1.10.1 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/SingletonComponentType.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/api/ServiceProperty.html" title="class in org.apache.felix.ipojo.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/ipojo/api/TemporalDependency.html" title="class in org.apache.felix.ipojo.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/ipojo/api/SingletonComponentType.html" target="_top">Frames</a></li> |
| <li><a href="SingletonComponentType.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.ipojo.api</div> |
| <h2 title="Class SingletonComponentType" class="title">Class SingletonComponentType</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html" title="class in org.apache.felix.ipojo.api">org.apache.felix.ipojo.api.ComponentType</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html" title="class in org.apache.felix.ipojo.api">org.apache.felix.ipojo.api.PrimitiveComponentType</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.felix.ipojo.api.SingletonComponentType</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.34">SingletonComponentType</a> |
| extends <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html" title="class in org.apache.felix.ipojo.api">PrimitiveComponentType</a></pre> |
| <div class="block">Allows defining a primitive component type that create an unique |
| instance when created. The factory is set to private by default.</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"> </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>private <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/api/SingletonComponentType.html#m_pojo">m_pojo</a></strong></code> |
| <div class="block">The POJO object to inject through the |
| instance configuration.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" 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><strong><a href="../../../../../org/apache/felix/ipojo/api/SingletonComponentType.html#SingletonComponentType()">SingletonComponentType</a></strong>()</code> |
| <div class="block">Creates a SingletonComponentType.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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/api/SingletonComponentType.html#create()">create</a></strong>()</code> |
| <div class="block">Starts the component type and creates the singleton |
| instance.</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/api/SingletonComponentType.html#create(java.util.Dictionary)">create</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> conf)</code> |
| <div class="block">Starts the component type and creates the singleton |
| instance.</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/api/SingletonComponentType.html#create(java.lang.String)">create</a></strong>(<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> name)</code> |
| <div class="block">Starts the component type and creates the singleton |
| instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/api/SingletonComponentType.html" title="class in org.apache.felix.ipojo.api">SingletonComponentType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/api/SingletonComponentType.html#setObject(java.lang.Object)">setObject</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Sets the pojo object used by the instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.api.PrimitiveComponentType"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.felix.ipojo.api.<a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html" title="class in org.apache.felix.ipojo.api">PrimitiveComponentType</a></h3> |
| <code><a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addDependency(org.apache.felix.ipojo.api.Dependency)">addDependency</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addDependency(org.apache.felix.ipojo.api.TemporalDependency)">addDependency</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addHandler(org.apache.felix.ipojo.api.HandlerConfiguration)">addHandler</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addProperty(org.apache.felix.ipojo.api.Property)">addProperty</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addProperty(java.lang.String, java.lang.Object)">addProperty</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#addService(org.apache.felix.ipojo.api.Service)">addService</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#getFactory()">getFactory</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setBundleContext(org.osgi.framework.BundleContext)">setBundleContext</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setClassName(java.lang.String)">setClassName</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setComponentTypeName(java.lang.String)">setComponentTypeName</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setComponentTypeVersion(java.lang.String)">setComponentTypeVersion</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setFactoryMethod(java.lang.String)">setFactoryMethod</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setImmediate(boolean)">setImmediate</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setInvalidateMethod(java.lang.String)">setInvalidateMethod</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setManagedServicePID(java.lang.String)">setManagedServicePID</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setPropagation(boolean)">setPropagation</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setPublic(boolean)">setPublic</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setUpdatedMethod(java.lang.String)">setUpdatedMethod</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#setValidateMethod(java.lang.String)">setValidateMethod</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#start()">start</a>, <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#stop()">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.api.ComponentType"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.felix.ipojo.api.<a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html" title="class in org.apache.felix.ipojo.api">ComponentType</a></h3> |
| <code><a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()">createInstance</a>, <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance(java.util.Dictionary)">createInstance</a>, <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance(java.lang.String)">createInstance</a>, <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#disposeInstance(org.apache.felix.ipojo.ComponentInstance)">disposeInstance</a>, <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#disposeInstance(java.lang.String)">disposeInstance</a>, <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#getInstanceByName(java.lang.String)">getInstanceByName</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="m_pojo"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>m_pojo</h4> |
| <pre>private <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.40">m_pojo</a></pre> |
| <div class="block">The POJO object to inject through the |
| instance configuration.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SingletonComponentType()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SingletonComponentType</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.46">SingletonComponentType</a>()</pre> |
| <div class="block">Creates a SingletonComponentType. |
| This type is set to private by default.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setObject(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObject</h4> |
| <pre>public <a href="../../../../../org/apache/felix/ipojo/api/SingletonComponentType.html" title="class in org.apache.felix.ipojo.api">SingletonComponentType</a> <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.57">setObject</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block">Sets the pojo object used by the instance. |
| The object must be compatible with the |
| implementation class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the object.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the current singleton component type.</dd></dl> |
| </li> |
| </ul> |
| <a name="create()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a> <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.76">create</a>() |
| 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">Starts the component type and creates the singleton |
| instance. This method has to be called in place of the |
| <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#start()"><code>PrimitiveComponentType.start()</code></a> and the |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a> methods.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the created component instance.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - occurs if the type description is |
| incorrect</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - occurs if a handler is not available</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - occurs if the configuration is not |
| acceptable by the instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#start()"><code>ComponentType.start()</code></a>, |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="create(java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a> <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.102">create</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> 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>, |
| <a href="../../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></pre> |
| <div class="block">Starts the component type and creates the singleton |
| instance. This method has to be called in place of the |
| <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#start()"><code>PrimitiveComponentType.start()</code></a> and the |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a> methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the instance configuration</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created component instance</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - occurs if the type description is |
| incorrect</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - occurs if a handler is not available</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - occurs if the configuration is not |
| acceptable by the instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#start()"><code>ComponentType.start()</code></a>, |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="create(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a> <a href="../../../../../src-html/org/apache/felix/ipojo/api/SingletonComponentType.html#line.126">create</a>(<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> name) |
| 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">Starts the component type and creates the singleton |
| instance. This method has to be called in place of the |
| <a href="../../../../../org/apache/felix/ipojo/api/PrimitiveComponentType.html#start()"><code>PrimitiveComponentType.start()</code></a> and the |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a> methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the instance to create. This parameter will |
| be used as the <code>instance.name</code> property.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created component instance.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - occurs if the type description is |
| incorrect</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/MissingHandlerException.html" title="class in org.apache.felix.ipojo">MissingHandlerException</a></code> - occurs if a handler is not available</dd> |
| <dd><code><a href="../../../../../org/apache/felix/ipojo/UnacceptableConfiguration.html" title="class in org.apache.felix.ipojo">UnacceptableConfiguration</a></code> - occurs if the configuration is not |
| acceptable by the instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#start()"><code>ComponentType.start()</code></a>, |
| <a href="../../../../../org/apache/felix/ipojo/api/ComponentType.html#createInstance()"><code>ComponentType.createInstance()</code></a></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/SingletonComponentType.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/api/ServiceProperty.html" title="class in org.apache.felix.ipojo.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/ipojo/api/TemporalDependency.html" title="class in org.apache.felix.ipojo.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/ipojo/api/SingletonComponentType.html" target="_top">Frames</a></li> |
| <li><a href="SingletonComponentType.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2013. All rights reserved.</small></p> |
| </body> |
| </html> |
