blob: 46e9fc8a228f10073c1293a0ac4cd8a4eb446963 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 15:13:21 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ScrService (Apache Felix Declarative Services 1.2.0 API)</title>
<meta name="date" content="2013-07-01">
<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="ScrService (Apache Felix Declarative Services 1.2.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="../../../../org/apache/felix/scr/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScrService.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>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/scr/ScrService.html" target="_top">Frames</a></li>
<li><a href="ScrService.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.scr</div>
<h2 title="Interface ScrService" class="title">Interface ScrService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">ScrService</span></pre>
<div class="block">The <code>ScrService</code> represents the Declarative Services main
controller also known as the Service Component Runtime or SCR for short.
It provides access to the components managed the SCR.</div>
</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/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/ScrService.html#getComponent(long)">getComponent</a></strong>(long&nbsp;componentId)</code>
<div class="block">Returns the component whose component.id matches the given
<code>componentId</code> or <code>null</code> if no component with the
given id is currently managed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/ScrService.html#getComponents()">getComponents</a></strong>()</code>
<div class="block">Returns an array of all components managed by this SCR instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/scr/ScrService.html#getComponents(org.osgi.framework.Bundle)">getComponents</a></strong>(org.osgi.framework.Bundle&nbsp;bundle)</code>
<div class="block">Reuturns an array of all components managed by this SCR instance on
behalf of the given bundle.</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="getComponents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponents</h4>
<pre><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a>[]&nbsp;getComponents()</pre>
<div class="block">Returns an array of all components managed by this SCR instance. The
components are returned in ascending order of their component.id. If
there are no components currently managed by the SCR, <code>null</code>
is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The components or <code>null</code> if there are none.</dd></dl>
</li>
</ul>
<a name="getComponent(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponent</h4>
<pre><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a>&nbsp;getComponent(long&nbsp;componentId)</pre>
<div class="block">Returns the component whose component.id matches the given
<code>componentId</code> or <code>null</code> if no component with the
given id is currently managed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>componentId</code> - The ID of the component to return</dd>
<dt><span class="strong">Returns:</span></dt><dd>The indicated component or <code>null</code> if no such
component exists.</dd></dl>
</li>
</ul>
<a name="getComponents(org.osgi.framework.Bundle)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getComponents</h4>
<pre><a href="../../../../org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a>[]&nbsp;getComponents(org.osgi.framework.Bundle&nbsp;bundle)</pre>
<div class="block">Reuturns an array of all components managed by this SCR instance on
behalf of the given bundle. The components are returned in ascending
order of their component.id. If there are no components managed by the
SCR for the given bundle, <code>null</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bundle</code> - The <code>Bundle</code> whose components are to be
returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The bundle's components or <code>null</code> if the bundle
has none.</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="../../../../org/apache/felix/scr/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScrService.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>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/scr/ScrService.html" target="_top">Frames</a></li>
<li><a href="ScrService.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; 2006&#x2013;2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>