blob: 7c483355e941cebea598da9d355b5abd021ed26c [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 Tue Oct 08 19:30:27 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ComponentTypeDescription (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)</title>
<meta name="date" content="2013-10-08">
<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="ComponentTypeDescription (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/ComponentTypeDescription.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/architecture/Architecture.html" title="interface in org.apache.felix.ipojo.architecture"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" target="_top">Frames</a></li>
<li><a href="ComponentTypeDescription.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.architecture</div>
<h2 title="Class ComponentTypeDescription" class="title">Class ComponentTypeDescription</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>org.apache.felix.ipojo.architecture.ComponentTypeDescription</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/felix/ipojo/HandlerManagerFactory.HandlerTypeDescription.html" title="class in org.apache.felix.ipojo">HandlerManagerFactory.HandlerTypeDescription</a>, <a href="../../../../../org/apache/felix/ipojo/PrimitiveTypeDescription.html" title="class in org.apache.felix.ipojo">PrimitiveTypeDescription</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.38">ComponentTypeDescription</a>
extends <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></pre>
<div class="block">Component Type description.</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>private <a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#m_factory">m_factory</a></strong></code>
<div class="block">Represented factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <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></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#m_handlerInfoSlot">m_handlerInfoSlot</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#m_properties">m_properties</a></strong></code>
<div class="block">Configuration Properties accepted by the component type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <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/architecture/ComponentTypeDescription.html#m_providedServiceSpecification">m_providedServiceSpecification</a></strong></code>
<div class="block">Provided service by the component type.</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">&nbsp;</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/architecture/ComponentTypeDescription.html#ComponentTypeDescription(org.apache.felix.ipojo.IPojoFactory)">ComponentTypeDescription</a></strong>(<a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a>&nbsp;factory)</code>
<div class="block">Constructor.</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/architecture/ComponentTypeDescription.html#addProperty(org.apache.felix.ipojo.architecture.PropertyDescription)">addProperty</a></strong>(<a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>&nbsp;pd)</code>
<div class="block">Adds a configuration properties to the component type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProperty(java.lang.String, java.lang.String)">addProperty</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>&nbsp;name,
<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;value)</code>
<div class="block">Adds a String property in the component type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProperty(java.lang.String, java.lang.String, boolean)">addProperty</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>&nbsp;name,
<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;value,
boolean&nbsp;immutable)</code>
<div class="block">Adds a String property in the component type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProvidedServiceSpecification(java.lang.String)">addProvidedServiceSpecification</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>&nbsp;serviceSpecification)</code>
<div class="block">Adds a provided service to the component type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework">BundleContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getBundleContext()">getBundleContext</a></strong>()</code>&nbsp;</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/architecture/ComponentTypeDescription.html#getClassName()">getClassName</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;&nbsp;</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/architecture/ComponentTypeDescription.html#getDescription()">getDescription</a></strong>()</code>
<div class="block">Gets the component type description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getFactory()">getFactory</a></strong>()</code>
<div class="block">Gets the attached 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/architecture/ComponentTypeDescription.html#getFactoryInterfacesToPublish()">getFactoryInterfacesToPublish</a></strong>()</code>
<div class="block">Gets the interfaces published by the factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture">CustomHandlerInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getHandlerInfo(java.lang.String, java.lang.String)">getHandlerInfo</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>&nbsp;handlerNs,
<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;handlerName)</code>&nbsp;</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/architecture/ComponentTypeDescription.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the component-type name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">Gets component-type properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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>&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>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getPropertiesToPublish()">getPropertiesToPublish</a></strong>()</code>
<div class="block">Computes the default service properties to publish :
factory.name, service.pid, component.providedServiceSpecification, component.properties, component.description, factory.State.</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/architecture/ComponentTypeDescription.html#getprovidedServiceSpecification()">getprovidedServiceSpecification</a></strong>()</code>
<div class="block">Gets the list of provided service offered by instances of this type.</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/architecture/ComponentTypeDescription.html#getVersion()">getVersion</a></strong>()</code>
<div class="block">Gets the component type version.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#setHandlerInfo(java.lang.String, java.lang.String, org.apache.felix.ipojo.architecture.CustomHandlerInfo)">setHandlerInfo</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>&nbsp;handlerNs,
<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;handlerName,
<a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture">CustomHandlerInfo</a>&nbsp;info)</code>
<div class="block">Adds the HandlerInfo for specified handler.</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/architecture/ComponentTypeDescription.html#toString()">toString</a></strong>()</code>
<div class="block">Gets a printable form of the current component type description.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#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_factory">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_factory</h4>
<pre>private final&nbsp;<a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a> <a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.43">m_factory</a></pre>
<div class="block">Represented factory.</div>
</li>
</ul>
<a name="m_providedServiceSpecification">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_providedServiceSpecification</h4>
<pre>private&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/architecture/ComponentTypeDescription.html#line.47">m_providedServiceSpecification</a></pre>
<div class="block">Provided service by the component type.</div>
</li>
</ul>
<a name="m_properties">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_properties</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>[] <a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.51">m_properties</a></pre>
<div class="block">Configuration Properties accepted by the component type.</div>
</li>
</ul>
<a name="m_handlerInfoSlot">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m_handlerInfoSlot</h4>
<pre>private&nbsp;<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> <a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.55">m_handlerInfoSlot</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ComponentTypeDescription(org.apache.felix.ipojo.IPojoFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ComponentTypeDescription</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.62">ComponentTypeDescription</a>(<a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a>&nbsp;factory)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - : represented factory.</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="getFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.71">getFactory</a>()</pre>
<div class="block">Gets the attached factory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the factory</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.81">toString</a>()</pre>
<div class="block">Gets a printable form of the current component type description.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></dd>
<dt><span class="strong">Returns:</span></dt><dd>printable form of the component type description</dd><dt><span class="strong">See Also:</span></dt><dd><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"><code>Object.toString()</code></a></dd></dl>
</li>
</ul>
<a name="getClassName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassName</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.91">getClassName</a>()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i></i></div>
<div class="block">Gets the implementation class of this component type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type implementation class name.</dd></dl>
</li>
</ul>
<a name="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.101">getVersion</a>()</pre>
<div class="block">Gets the component type version.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type version or
<code>null</code> if not set.</dd></dl>
</li>
</ul>
<a name="getProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>[]&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.110">getProperties</a>()</pre>
<div class="block">Gets component-type properties.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of configuration properties accepted by the component type type.</dd></dl>
</li>
</ul>
<a name="addProperty(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.120">addProperty</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>&nbsp;name,
<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;value)</pre>
<div class="block">Adds a String property in the component type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - : property name.</dd><dd><code>value</code> - : property value.</dd></dl>
</li>
</ul>
<a name="addProperty(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.131">addProperty</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>&nbsp;name,
<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;value,
boolean&nbsp;immutable)</pre>
<div class="block">Adds a String property in the component type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - : property name.</dd><dd><code>value</code> - : property value.</dd><dd><code>immutable</code> - : the property is immutable.</dd></dl>
</li>
</ul>
<a name="addProperty(org.apache.felix.ipojo.architecture.PropertyDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.140">addProperty</a>(<a href="../../../../../org/apache/felix/ipojo/architecture/PropertyDescription.html" title="class in org.apache.felix.ipojo.architecture">PropertyDescription</a>&nbsp;pd)</pre>
<div class="block">Adds a configuration properties to the component type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pd</code> - : the property to add</dd></dl>
</li>
</ul>
<a name="setHandlerInfo(java.lang.String, java.lang.String, org.apache.felix.ipojo.architecture.CustomHandlerInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandlerInfo</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.164">setHandlerInfo</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>&nbsp;handlerNs,
<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;handlerName,
<a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture">CustomHandlerInfo</a>&nbsp;info)</pre>
<div class="block">Adds the HandlerInfo for specified handler.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handlerNs</code> - Handler's namespace</dd><dd><code>handlerName</code> - Handler's name</dd><dd><code>info</code> - HandlerInfo associated with the given custom handler.</dd></dl>
</li>
</ul>
<a name="getHandlerInfo(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerInfo</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture">CustomHandlerInfo</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.174">getHandlerInfo</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>&nbsp;handlerNs,
<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;handlerName)</pre>
</li>
</ul>
<a name="getprovidedServiceSpecification()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getprovidedServiceSpecification</h4>
<pre>public&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>[]&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.184">getprovidedServiceSpecification</a>()</pre>
<div class="block">Gets the list of provided service offered by instances of this type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of the provided service.</dd></dl>
</li>
</ul>
<a name="addProvidedServiceSpecification(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProvidedServiceSpecification</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.193">addProvidedServiceSpecification</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>&nbsp;serviceSpecification)</pre>
<div class="block">Adds a provided service to the component type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceSpecification</code> - : the provided service to add (interface name)</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.205">getName</a>()</pre>
<div class="block">Returns the component-type name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of this component type</dd></dl>
</li>
</ul>
<a name="getPropertiesToPublish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertiesToPublish</h4>
<pre>public&nbsp;<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>&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>,<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.215">getPropertiesToPublish</a>()</pre>
<div class="block">Computes the default service properties to publish :
factory.name, service.pid, component.providedServiceSpecification, component.properties, component.description, factory.State.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>: the dictionary of properties to publish.</dd></dl>
</li>
</ul>
<a name="getFactoryInterfacesToPublish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactoryInterfacesToPublish</h4>
<pre>public&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>[]&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.251">getFactoryInterfacesToPublish</a>()</pre>
<div class="block">Gets the interfaces published by the factory.
By default publish both <a href="../../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo"><code>Factory</code></a> and <a href="http://www.osgi.org/javadoc/r4v43/cmpn/org/osgi/service/cm/ManagedServiceFactory.html?is-external=true" title="class or interface in org.osgi.service.cm"><code>ManagedServiceFactory</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>: the list of interface published by the factory.</dd></dl>
</li>
</ul>
<a name="getDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>public&nbsp;<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/architecture/ComponentTypeDescription.html#line.260">getDescription</a>()</pre>
<div class="block">Gets the component type description.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>: the description</dd></dl>
</li>
</ul>
<a name="getBundleContext()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBundleContext</h4>
<pre>public&nbsp;<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework">BundleContext</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#line.314">getBundleContext</a>()</pre>
</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/ComponentTypeDescription.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/architecture/Architecture.html" title="interface in org.apache.felix.ipojo.architecture"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/architecture/CustomHandlerInfo.html" title="interface in org.apache.felix.ipojo.architecture"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" target="_top">Frames</a></li>
<li><a href="ComponentTypeDescription.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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; 2013. All rights reserved.</small></p>
</body>
</html>