Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.11.2 / org / apache / felix / ipojo / annotations / Provides.html
blob: 2d2f52b8bc2a662c34a20ac84a92e44dfe16510d [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 Mon Mar 31 09:56:28 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Provides (Apache Felix iPOJO ~ JavaDoc 1.11.2 API)</title>
<meta name="date" content="2014-03-31">
<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="Provides (Apache Felix iPOJO ~ JavaDoc 1.11.2 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/Provides.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/annotations/Property.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/annotations/Provides.html" target="_top">Frames</a></li>
<li><a href="Provides.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>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#annotation_type_element_detail">Element</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.annotations</div>
<h2 title="Annotation Type Provides" class="title">Annotation Type Provides</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>})
public @interface <a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Provides.html#line.37">Provides</a></pre>
<div class="block">This annotation declares that the component instances will provide a service.
<pre>
<a href="../../../../../org/apache/felix/ipojo/annotations/Component.html" title="annotation in org.apache.felix.ipojo.annotations">@Component</a>
<code>@Provides</code>
public class MyComponent implements Service {
// ...
}
</pre></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">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_optional_element_summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/annotations/StaticServiceProperty.html" title="annotation in org.apache.felix.ipojo.annotations">StaticServiceProperty</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Provides.html#properties()">properties</a></strong></code>
<div class="block">Allows adding static properties to the service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/annotations/Provides.html#specifications()">specifications</a></strong></code>
<div class="block">Set the provided specifications.</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/annotations/Provides.html#strategy()">strategy</a></strong></code>
<div class="block">Set the service object creation strategy.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_element_detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="specifications()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>specifications</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Provides.html#line.53">specifications</a></pre>
<div class="block">Set the provided specifications.
It can be used to force the exposed service to use an implementation class
(not an interface) as specification.
Default : all implemented interfaces
<pre>
<a href="../../../../../org/apache/felix/ipojo/annotations/Component.html" title="annotation in org.apache.felix.ipojo.annotations">@Component</a>
<code>@Provides(specifications = AbsComponent.class)</code>
public class MyComponent extends AbsComponent {
// ...
}
</pre></div>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="strategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>strategy</h4>
<pre>public abstract&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/annotations/Provides.html#line.67">strategy</a></pre>
<div class="block">Set the service object creation strategy.
Multiple values are possible: SINGLETON, SERVICE,
METHOD, INSTANCE or the strategy fully qualified class name:
<ul>
<li>SINGLETON: Default strategy</li>
<li>SERVICE: OSGi Service Factory style, 1 POJO instance per consumer bundle</li>
<li>METHOD: Delegates the creation to the factory-method of the component, method will be called every time the service reference is get.</li>
<li>INSTANCE: Creates one service object per requiring instance</li>
<li>Any other value is interpreted as the qualified name of a <code>CreationStrategy</code> implementation</li>
</ul></div>
<dl>
<dt>Default:</dt>
<dd>"SINGLETON"</dd>
</dl>
</li>
</ul>
<a name="properties()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>properties</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/apache/felix/ipojo/annotations/StaticServiceProperty.html" title="annotation in org.apache.felix.ipojo.annotations">StaticServiceProperty</a>[]&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/annotations/Provides.html#line.91">properties</a></pre>
<div class="block">Allows adding static properties to the service.
Nested properties are static service properties, so <b>must</b> contain the name,
value and type as they are not attached to a field (cannot discover type through
introspection).
The array contains <a href="../../../../../org/apache/felix/ipojo/annotations/StaticServiceProperty.html" title="annotation in org.apache.felix.ipojo.annotations"><code>StaticServiceProperty</code></a> elements.
Default : No service properties
<pre>
<a href="../../../../../org/apache/felix/ipojo/annotations/Component.html" title="annotation in org.apache.felix.ipojo.annotations">@Component</a>
<code>@Provides</code>(
properties = {
<code>@StaticServiceProperty</code>(name = "size", type = "int", value = "5"),
<code>@StaticServiceProperty</code>(name = "name", type = "java.lang.String", value = "OSGi")
}
)
public class MyComponent implements Service {
// ...
}
</pre></div>
<dl>
<dt>Default:</dt>
<dd>{}</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/Provides.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/annotations/Property.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/felix/ipojo/annotations/Requires.html" title="annotation in org.apache.felix.ipojo.annotations"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/annotations/Provides.html" target="_top">Frames</a></li>
<li><a href="Provides.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>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#annotation_type_element_detail">Element</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>