blob: 4060e8038ff1949fb913c95764485325f5b1f3e4 [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 Jun 29 08:36:29 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>HandlerManagerFactory.HandlerTypeDescription (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="HandlerManagerFactory.HandlerTypeDescription (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/HandlerManagerFactory.HandlerTypeDescription.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/HandlerManagerFactory.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/InstanceManager.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/HandlerManagerFactory.HandlerTypeDescription.html" target="_top">Frames</a></li>
<li><a href="HandlerManagerFactory.HandlerTypeDescription.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>Field&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>Field&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</div>
<h2 title="Class HandlerManagerFactory.HandlerTypeDescription" class="title">Class HandlerManagerFactory.HandlerTypeDescription</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/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">org.apache.felix.ipojo.architecture.ComponentTypeDescription</a></li>
<li>
<ul class="inheritance">
<li>org.apache.felix.ipojo.HandlerManagerFactory.HandlerTypeDescription</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/apache/felix/ipojo/HandlerManagerFactory.html" title="class in org.apache.felix.ipojo">HandlerManagerFactory</a></dd>
</dl>
<hr>
<br>
<pre>private class <a href="../../../../src-html/org/apache/felix/ipojo/HandlerManagerFactory.html#line.188">HandlerManagerFactory.HandlerTypeDescription</a>
extends <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a></pre>
<div class="block">Defines the handler type description.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture"><code>ComponentTypeDescription</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/HandlerManagerFactory.HandlerTypeDescription.html#HandlerManagerFactory.HandlerTypeDescription(org.apache.felix.ipojo.IPojoFactory)">HandlerManagerFactory.HandlerTypeDescription</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">Creates the HandlerTypeDescription.</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><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/HandlerManagerFactory.HandlerTypeDescription.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="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/HandlerManagerFactory.HandlerTypeDescription.html#getPropertiesToPublish()">getPropertiesToPublish</a></strong>()</code>
<div class="block">Add properties to publish.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.architecture.ComponentTypeDescription">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.felix.ipojo.architecture.<a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a></h3>
<code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProperty(org.apache.felix.ipojo.architecture.PropertyDescription)">addProperty</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProperty(java.lang.String, java.lang.String)">addProperty</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProperty(java.lang.String, java.lang.String, boolean)">addProperty</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#addProvidedServiceSpecification(java.lang.String)">addProvidedServiceSpecification</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getBundleContext()">getBundleContext</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getClassName()">getClassName</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getDescription()">getDescription</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getFactory()">getFactory</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getHandlerInfo(java.lang.String, java.lang.String)">getHandlerInfo</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getName()">getName</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getprovidedServiceSpecification()">getprovidedServiceSpecification</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#setHandlerInfo(java.lang.String, java.lang.String, org.apache.felix.ipojo.architecture.CustomHandlerInfo)">setHandlerInfo</a>, <a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#toString()">toString</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&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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HandlerManagerFactory.HandlerTypeDescription(org.apache.felix.ipojo.IPojoFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HandlerManagerFactory.HandlerTypeDescription</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerManagerFactory.HandlerTypeDescription.html#line.194">HandlerManagerFactory.HandlerTypeDescription</a>(<a href="../../../../org/apache/felix/ipojo/IPojoFactory.html" title="class in org.apache.felix.ipojo">IPojoFactory</a>&nbsp;factory)</pre>
<div class="block">Creates the HandlerTypeDescription.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the 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="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>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerManagerFactory.HandlerTypeDescription.html#line.207">getPropertiesToPublish</a>()</pre>
<div class="block">Add properties to publish.
<li>handler.name</li>
<li>handler.namespace</li>
<li>handler.type</li>
<li>handler.level if the level is not Integer.MAX</li></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getPropertiesToPublish()">getPropertiesToPublish</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>returns the dictionary to publish.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getPropertiesToPublish()"><code>ComponentTypeDescription.getPropertiesToPublish()</code></a></dd></dl>
</li>
</ul>
<a name="getFactoryInterfacesToPublish()">
<!-- -->
</a>
<ul class="blockListLast">
<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/HandlerManagerFactory.HandlerTypeDescription.html#line.219">getFactoryInterfacesToPublish</a>()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getFactoryInterfacesToPublish()">ComponentTypeDescription</a></code></strong></div>
<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><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html#getFactoryInterfacesToPublish()">getFactoryInterfacesToPublish</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>: the list of interface published by the factory.</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/HandlerManagerFactory.HandlerTypeDescription.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/HandlerManagerFactory.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/InstanceManager.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/HandlerManagerFactory.HandlerTypeDescription.html" target="_top">Frames</a></li>
<li><a href="HandlerManagerFactory.HandlerTypeDescription.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>Field&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>Field&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>