blob: fd9925f1c09d1590e191680f4344119da52fb3e1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Sat May 17 12:14:25 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DeclarationHandle (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)</title>
<meta name="date" content="2014-05-17">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DeclarationHandle (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DeclarationHandle.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/DeclarationBuilderService.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/Extender.html" title="annotation 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/DeclarationHandle.html" target="_top">Frames</a></li>
<li><a href="DeclarationHandle.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>Constr&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>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 DeclarationHandle" class="title">Interface DeclarationHandle</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/AbstractDeclaration.html" title="class in org.apache.felix.ipojo.extender.internal.declaration">AbstractDeclaration</a>, <a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/DefaultExtensionDeclaration.html" title="class in org.apache.felix.ipojo.extender.internal.declaration">DefaultExtensionDeclaration</a>, <a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/DefaultInstanceDeclaration.html" title="class in org.apache.felix.ipojo.extender.internal.declaration">DefaultInstanceDeclaration</a>, <a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/DefaultTypeDeclaration.html" title="class in org.apache.felix.ipojo.extender.internal.declaration">DefaultTypeDeclaration</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/felix/ipojo/extender/DeclarationHandle.html#line.29">DeclarationHandle</a></pre>
<div class="block">Handle on the associated <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</code></a> service.
It can be used to start and/or stop the underlying declaration as well as retrieving its
<a href="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender">status</a> (bound or not).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.11.2</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender">Status</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html#getStatus()">getStatus</a></strong>()</code>
<div class="block">Return the current (instant) status of the declaration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html#publish()">publish</a></strong>()</code>
<div class="block">Publish the <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html#retract()">retract</a></strong>()</code>
<div class="block">Retract the <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</code></a> service.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="publish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publish</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/DeclarationHandle.html#line.35">publish</a>()</pre>
<div class="block">Publish the <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</code></a>. If the declaration
is already registered, it's a no-op operation.</div>
</li>
</ul>
<a name="retract()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/DeclarationHandle.html#line.41">retract</a>()</pre>
<div class="block">Retract the <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</code></a> service. If the
declaration is not registered, it's a no-op operation.</div>
</li>
</ul>
<a name="getStatus()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStatus</h4>
<pre><a href="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender">Status</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/DeclarationHandle.html#line.49">getStatus</a>()</pre>
<div class="block">Return the current (instant) status of the declaration. Remember that
<a href="../../../../../org/apache/felix/ipojo/extender/Status.html" title="interface in org.apache.felix.ipojo.extender"><code>Status</code></a> is immutable (status does not change over time).
If you want an updated status, call again the <a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html#getStatus()"><code>getStatus()</code></a> method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instant status of the <a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><code>Declaration</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/DeclarationHandle.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/DeclarationBuilderService.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/Extender.html" title="annotation 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/DeclarationHandle.html" target="_top">Frames</a></li>
<li><a href="DeclarationHandle.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All rights reserved.</small></p>
</body>
</html>