blob: e41c89f4861f943be7704616a1379479ac6e6820 [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:25 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>InstanceDeclaration (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="InstanceDeclaration (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/InstanceDeclaration.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/extender/ExtensionDeclaration.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/extender/InstanceDeclaration.html" target="_top">Frames</a></li>
<li><a href="InstanceDeclaration.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.extender</div>
<h2 title="Interface InstanceDeclaration" class="title">Interface InstanceDeclaration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender">Declaration</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/DefaultInstanceDeclaration.html" title="class in org.apache.felix.ipojo.extender.internal.declaration">DefaultInstanceDeclaration</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/felix/ipojo/extender/InstanceDeclaration.html#line.27">InstanceDeclaration</a>
extends <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender">Declaration</a></pre>
<div class="block">Service published to instruct an instance creation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="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/extender/InstanceDeclaration.html#COMPONENT_NAME_PROPERTY">COMPONENT_NAME_PROPERTY</a></strong></code>
<div class="block">Service property specifying the component type's name.</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/extender/InstanceDeclaration.html#COMPONENT_VERSION_PROPERTY">COMPONENT_VERSION_PROPERTY</a></strong></code>
<div class="block">Service property specifying the component type's version.</div>
</td>
</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/extender/InstanceDeclaration.html#INSTANCE_NAME">INSTANCE_NAME</a></strong></code>
<div class="block">Service property specifying the instance name.</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/extender/InstanceDeclaration.html#UNNAMED_INSTANCE">UNNAMED_INSTANCE</a></strong></code>
<div class="block">Value used when an instance configuration does not declare its name.</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/extender/InstanceDeclaration.html#getComponentName()">getComponentName</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/extender/InstanceDeclaration.html#getComponentVersion()">getComponentVersion</a></strong>()</code>&nbsp;</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/extender/InstanceDeclaration.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">The instance configuration.</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/extender/InstanceDeclaration.html#getInstanceName()">getInstanceName</a></strong>()</code>
<div class="block">Gets the instance name.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.extender.Declaration">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.felix.ipojo.extender.<a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender">Declaration</a></h3>
<code><a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html#bind()">bind</a>, <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html#getStatus()">getStatus</a>, <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html#unbind(java.lang.String)">unbind</a>, <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html#unbind(java.lang.String, java.lang.Throwable)">unbind</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="COMPONENT_NAME_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPONENT_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/extender/InstanceDeclaration.html#line.31">COMPONENT_NAME_PROPERTY</a></pre>
<div class="block">Service property specifying the component type's name.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.felix.ipojo.extender.InstanceDeclaration.COMPONENT_NAME_PROPERTY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COMPONENT_VERSION_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPONENT_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/extender/InstanceDeclaration.html#line.36">COMPONENT_VERSION_PROPERTY</a></pre>
<div class="block">Service property specifying the component type's version.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.felix.ipojo.extender.InstanceDeclaration.COMPONENT_VERSION_PROPERTY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INSTANCE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INSTANCE_NAME</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/extender/InstanceDeclaration.html#line.41">INSTANCE_NAME</a></pre>
<div class="block">Service property specifying the instance name.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.felix.ipojo.extender.InstanceDeclaration.INSTANCE_NAME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNNAMED_INSTANCE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UNNAMED_INSTANCE</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/extender/InstanceDeclaration.html#line.46">UNNAMED_INSTANCE</a></pre>
<div class="block">Value used when an instance configuration does not declare its name.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.felix.ipojo.extender.InstanceDeclaration.UNNAMED_INSTANCE">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="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><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/extender/InstanceDeclaration.html#line.53">getConfiguration</a>()</pre>
<div class="block">The instance configuration.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance configuration</dd></dl>
</li>
</ul>
<a name="getComponentName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentName</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/extender/InstanceDeclaration.html#line.58">getComponentName</a>()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type's name.</dd></dl>
</li>
</ul>
<a name="getComponentVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentVersion</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/extender/InstanceDeclaration.html#line.63">getComponentVersion</a>()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the component type's version, null if not set.</dd></dl>
</li>
</ul>
<a name="getInstanceName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstanceName</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/extender/InstanceDeclaration.html#line.70">getInstanceName</a>()</pre>
<div class="block">Gets the instance name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance name, unnamed if not specified.</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/InstanceDeclaration.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/extender/ExtensionDeclaration.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/extender/InstanceDeclaration.html" target="_top">Frames</a></li>
<li><a href="InstanceDeclaration.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; 2013. All rights reserved.</small></p>
</body>
</html>