| <!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_67) on Tue Mar 24 21:21:23 CET 2015 --> |
| <title>Property</title> |
| <meta name="date" content="2015-03-24"> |
| <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="Property"; |
| } |
| //--> |
| </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/dm/annotation/api/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Property.html" target="_top">Frames</a></li> |
| <li><a href="Property.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: </li> |
| <li><a href="#annotation_type_required_element_summary">Required</a> | </li> |
| <li><a href="#annotation_type_optional_element_summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </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.dm.annotation.api</div> |
| <h2 title="Annotation Type Property" class="title">Annotation Type Property</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Retention(value=CLASS) |
| @Target(value=ANNOTATION_TYPE) |
| public @interface <span class="strong">Property</span></pre> |
| <div class="block">Annotation used to describe a property key-value(s) pair. It is used for example when |
| declaring <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties()"><code>Component.properties()</code></a> attribute.<p> |
| |
| Property value(s) type is String by default, and the type is scalar if the value is single-valued, |
| or an array if the value is multi-valued. |
| |
| Eight primitive types are supported:<p> |
| <ul> |
| <li> String (default type) |
| <li> Long |
| <li> Double |
| <li> Float |
| <li> Integer |
| <li> Byte |
| <li> Boolean |
| <li> Short |
| </ul> |
| |
| You can specify the type of a property either using a combination of <code>value</code> and <code>type</code> attributes, |
| or using one of the <code>longValue/doubleValue/floatValue/intValue/byteValue/charValue/booleanValue/shortValue</code> attributes. |
| |
| Notice that you can also specify service properties dynamically by returning a Map from a method |
| annotated with <a href="../../../../../../org/apache/felix/dm/annotation/api/Start.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Start</code></a>. |
| |
| <p> |
| <h3>Usage Examples</h3> |
| <blockquote> |
| |
| <pre> |
| @Component(properties={ |
| @Property(name="p1", value="v")}) // String value type (scalar) |
| @Property(name="p2", value={"s1", "s2")}) // Array of Strings |
| @Property(name="service.ranking", intValue=10) // Integer value type (scalar) |
| @Property(name="p3", intValue={1,2}) // Array of Integers |
| @Property(name="p3", value={"1"), type=Long.class}) // Long value (scalar) |
| class ServiceImpl implements Service { |
| } |
| </pre> |
| </blockquote></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation_type_required_element_summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#name()">name</a></strong></code> |
| <div class="block">Returns the property name.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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"> </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>boolean[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#booleanValue()">booleanValue</a></strong></code> |
| <div class="block">A Boolean value or an array of Boolean values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#byteValue()">byteValue</a></strong></code> |
| <div class="block">A Byte value or an array of Byte values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>char[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#charValue()">charValue</a></strong></code> |
| <div class="block">A Character value or an array of Character values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#doubleValue()">doubleValue</a></strong></code> |
| <div class="block">A Double value or an array of Double values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>float[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#floatValue()">floatValue</a></strong></code> |
| <div class="block">A Float value or an array of Float values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#intValue()">intValue</a></strong></code> |
| <div class="block">An Integer value or an array of Integer values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#longValue()">longValue</a></strong></code> |
| <div class="block">A Long value or an array of Long values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>short[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#shortValue()">shortValue</a></strong></code> |
| <div class="block">A Short value or an array of Short values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#type()">type</a></strong></code> |
| <div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a> attributes are parsed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()">value</a></strong></code> |
| <div class="block">Returns the property value(s).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()">values</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> attribute.</i></div> |
| </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="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public abstract java.lang.String name</pre> |
| <div class="block">Returns the property name.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>this property name</dd></dl> |
| </li> |
| </ul> |
| <a name="value()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public abstract java.lang.String[] value</pre> |
| <div class="block">Returns the property value(s). The property value(s) is (are) |
| parsed using the <code>valueOf</code> method of the class specified in the #type attribute |
| (which is <code>String</code> by default). When the property value is single-value, then |
| the value type is scalar (not an array). If the property value is multi-valued, then the value type |
| is an array of the type specified in the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#type()"><code>type()</code></a> attribute (String by default).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>this property value(s).</dd></dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public abstract java.lang.Class<?> type</pre> |
| <div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a> attributes are parsed.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the property value type (String by default) used to parse <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a> |
| attribtues</dd></dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>java.lang.String.class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="longValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>longValue</h4> |
| <pre>public abstract long[] longValue</pre> |
| <div class="block">A Long value or an array of Long values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doubleValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValue</h4> |
| <pre>public abstract double[] doubleValue</pre> |
| <div class="block">A Double value or an array of Double values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="floatValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>floatValue</h4> |
| <pre>public abstract float[] floatValue</pre> |
| <div class="block">A Float value or an array of Float values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="intValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intValue</h4> |
| <pre>public abstract int[] intValue</pre> |
| <div class="block">An Integer value or an array of Integer values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="byteValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>byteValue</h4> |
| <pre>public abstract byte[] byteValue</pre> |
| <div class="block">A Byte value or an array of Byte values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="charValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>charValue</h4> |
| <pre>public abstract char[] charValue</pre> |
| <div class="block">A Character value or an array of Character values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="booleanValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>booleanValue</h4> |
| <pre>public abstract boolean[] booleanValue</pre> |
| <div class="block">A Boolean value or an array of Boolean values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shortValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shortValue</h4> |
| <pre>public abstract short[] shortValue</pre> |
| <div class="block">A Short value or an array of Short values.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="values()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public abstract java.lang.String[] values</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> attribute.</i></div> |
| <div class="block">Returns an array of property values. |
| The property value are parsed using the <code>valueOf</code> method of the class specified in the #type attribute |
| (which is <code>String</code> by default).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an array of property values.</dd></dl> |
| <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="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Property.html" target="_top">Frames</a></li> |
| <li><a href="Property.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: </li> |
| <li><a href="#annotation_type_required_element_summary">Required</a> | </li> |
| <li><a href="#annotation_type_optional_element_summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#annotation_type_element_detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |