documentation/_attachments/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/PropertyMetaData.html - felix-site-pub - Git at Google

 <!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 (1.8.0_74) on Wed Feb 24 01:07:22 CET 2016 -->
 <title>PropertyMetaData</title>
 <meta name="date" content="2016-02-24">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="PropertyMetaData";
         }
     }
     catch(err) {
     }
 //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <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/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/Registered.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/PropertyMetaData.html" target="_top">Frames</a></li>
 <li><a href="PropertyMetaData.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&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.dm.annotation.api</div>
 <h2 title="Annotation Type PropertyMetaData" class="title">Annotation Type PropertyMetaData</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="memberNameLabel">PropertyMetaData</span></pre>
 <div class="block">This annotation describes the data types of a configuration Property.
  It can be used by other annotations which require meta type support.
  For now, the following annotations are using <code>PropertyMetaData</code>:
  <ul>
    <li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a>: This dependency allows to define a
    dependency over a <code>Configuration Admin</code> configuration dictionaries, whose
    metadata can be described using <code>PropertyMetaData</code> annotation.
    <li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>FactoryConfigurationAdapterService</code></a>: This service adapter allows
    to dynamically create Services on behalf of <code>Factory Configuration Admin</code>
    configuration dictionaries, whose metadata can be described using this <code>PropertyMetaData</code> annotation.
  </ul></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="memberSummary" 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">&nbsp;</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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#description--">description</a></span></code>
 <div class="block">Returns the property description.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#heading--">heading</a></span></code>
 <div class="block">The label used to display the property.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#id--">id</a></span></code>
 <div class="block">The key of a ConfigurationAdmin property.</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="memberSummary" 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>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#cardinality--">cardinality</a></span></code>
 <div class="block">Return the cardinality of this property.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#defaults--">defaults</a></span></code>
 <div class="block">Return default value(s) for this property.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels--">optionLabels</a></span></code>
 <div class="block">Return a list of valid option labels for this property.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--">optionValues</a></span></code>
 <div class="block">Return a list of option values that this property can take.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#required--">required</a></span></code>
 <div class="block">Tells if this property is required or not.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#type--">type</a></span></code>
 <div class="block">Return the property primitive type.</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="heading--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>heading</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;heading</pre>
 <div class="block">The label used to display the property. Example: "Log Level".</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The label used to display the property</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="id--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>id</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;id</pre>
 <div class="block">The key of a ConfigurationAdmin property. Example: "printer.logLevel"</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The Configuration Admin property name</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="description--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>description</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;description</pre>
 <div class="block">Returns the property description. The description may be localized and must describe the semantics of this type and any
  constraints. Example: "Select the log level for the Printer Service".</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The localized description of the definition.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="type--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>type</h4>
 <pre>public abstract&nbsp;java.lang.Class&lt;?&gt;&nbsp;type</pre>
 <div class="block">Return the property primitive type. If must be either one of the following types:
  <ul>
     <li>String.class</li>
     <li>Long.class</li>
     <li>Integer.class</li>
     <li>Character.class</li>
     <li>Byte.class</li>
     <li>Double.class</li>
     <li>Float.class</li>
     <li>Boolean.class</li>
  </ul></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the property type</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>java.lang.String.class</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="defaults--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>defaults</h4>
 <pre>public abstract&nbsp;java.lang.String[]&nbsp;defaults</pre>
 <div class="block">Return default value(s) for this property. The object must be of the appropriate type as defined by the cardinality and getType().
  The return type is a list of String  objects that can be converted to the appropriate type. The cardinality of the return
  array must follow the absolute cardinality of this type. E.g. if the cardinality = 0, the array must contain 1 element.
  If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain from 0 to max 5 elements. Note that
  the special case of a 0 cardinality, meaning a single value, does not allow arrays or vectors of 0 elements.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the default values</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="cardinality--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cardinality</h4>
 <pre>public abstract&nbsp;int&nbsp;cardinality</pre>
 <div class="block">Return the cardinality of this property. The OSGi environment handles multi valued properties in arrays ([]) or in Vector objects.
  The return value is defined as follows:

  <ul>
  <li> x = Integer.MIN_VALUE    no limit, but use Vector</li>
  <li> x lower than 0                    -x = max occurrences, store in Vector</li>
  <li> x greater than 0                     x = max occurrences, store in array []</li>
  <li> x equals Integer.MAX_VALUE    no limit, but use array []</li>
  <li> x equals 0                     1 occurrence required</li>
  </ul></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the property cardinality</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>0</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="required--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>required</h4>
 <pre>public abstract&nbsp;boolean&nbsp;required</pre>
 <div class="block">Tells if this property is required or not.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the property is required, false if not</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="optionLabels--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>optionLabels</h4>
 <pre>public abstract&nbsp;java.lang.String[]&nbsp;optionLabels</pre>
 <div class="block">Return a list of valid option labels for this property. The purpose of this method is to allow menus with localized labels.
  It is associated with the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute. The labels returned here are ordered in the same way as the
  <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute values.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the list of valid option labels for this property.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="optionValues--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>optionValues</h4>
 <pre>public abstract&nbsp;java.lang.String[]&nbsp;optionValues</pre>
 <div class="block">Return a list of option values that this property can take. This list must be in the same sequence as the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels--"><code>optionLabels()</code></a>
  attribute.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the option 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>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <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/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/Registered.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/PropertyMetaData.html" target="_top">Frames</a></li>
 <li><a href="PropertyMetaData.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&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 ======= -->
 </body>
 </html>
	<!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 (1.8.0_74) on Wed Feb 24 01:07:22 CET 2016 -->
	<title>PropertyMetaData</title>
	<meta name="date" content="2016-02-24">
	<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="PropertyMetaData";
	}
	}
	catch(err) {
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<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/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Registered.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/PropertyMetaData.html" target="_top">Frames</a></li>
	<li><a href="PropertyMetaData.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>Field \| </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>Field \| </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 PropertyMetaData" class="title">Annotation Type PropertyMetaData</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="memberNameLabel">PropertyMetaData</span></pre>
	<div class="block">This annotation describes the data types of a configuration Property.
	It can be used by other annotations which require meta type support.
	For now, the following annotations are using <code>PropertyMetaData</code>:
	<ul>
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a>: This dependency allows to define a
	dependency over a <code>Configuration Admin</code> configuration dictionaries, whose
	metadata can be described using <code>PropertyMetaData</code> annotation.
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>FactoryConfigurationAdapterService</code></a>: This service adapter allows
	to dynamically create Services on behalf of <code>Factory Configuration Admin</code>
	configuration dictionaries, whose metadata can be described using this <code>PropertyMetaData</code> annotation.
	</ul></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#description--">description</a></span></code>
	<div class="block">Returns the property description.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#heading--">heading</a></span></code>
	<div class="block">The label used to display the property.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#id--">id</a></span></code>
	<div class="block">The key of a ConfigurationAdmin property.</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="memberSummary" 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>int</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#cardinality--">cardinality</a></span></code>
	<div class="block">Return the cardinality of this property.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#defaults--">defaults</a></span></code>
	<div class="block">Return default value(s) for this property.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels--">optionLabels</a></span></code>
	<div class="block">Return a list of valid option labels for this property.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--">optionValues</a></span></code>
	<div class="block">Return a list of option values that this property can take.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#required--">required</a></span></code>
	<div class="block">Tells if this property is required or not.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.Class<?></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#type--">type</a></span></code>
	<div class="block">Return the property primitive type.</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="heading--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>heading</h4>
	<pre>public abstract java.lang.String heading</pre>
	<div class="block">The label used to display the property. Example: "Log Level".</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The label used to display the property</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="id--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>id</h4>
	<pre>public abstract java.lang.String id</pre>
	<div class="block">The key of a ConfigurationAdmin property. Example: "printer.logLevel"</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The Configuration Admin property name</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="description--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>description</h4>
	<pre>public abstract java.lang.String description</pre>
	<div class="block">Returns the property description. The description may be localized and must describe the semantics of this type and any
	constraints. Example: "Select the log level for the Printer Service".</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The localized description of the definition.</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="type--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>type</h4>
	<pre>public abstract java.lang.Class<?> type</pre>
	<div class="block">Return the property primitive type. If must be either one of the following types:
	<ul>
	<li>String.class</li>
	<li>Long.class</li>
	<li>Integer.class</li>
	<li>Character.class</li>
	<li>Byte.class</li>
	<li>Double.class</li>
	<li>Float.class</li>
	<li>Boolean.class</li>
	</ul></div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the property type</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>java.lang.String.class</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="defaults--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>defaults</h4>
	<pre>public abstract java.lang.String[] defaults</pre>
	<div class="block">Return default value(s) for this property. The object must be of the appropriate type as defined by the cardinality and getType().
	The return type is a list of String objects that can be converted to the appropriate type. The cardinality of the return
	array must follow the absolute cardinality of this type. E.g. if the cardinality = 0, the array must contain 1 element.
	If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain from 0 to max 5 elements. Note that
	the special case of a 0 cardinality, meaning a single value, does not allow arrays or vectors of 0 elements.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the default values</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="cardinality--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>cardinality</h4>
	<pre>public abstract int cardinality</pre>
	<div class="block">Return the cardinality of this property. The OSGi environment handles multi valued properties in arrays ([]) or in Vector objects.
	The return value is defined as follows:

	<ul>
	<li> x = Integer.MIN_VALUE no limit, but use Vector</li>
	<li> x lower than 0 -x = max occurrences, store in Vector</li>
	<li> x greater than 0 x = max occurrences, store in array []</li>
	<li> x equals Integer.MAX_VALUE no limit, but use array []</li>
	<li> x equals 0 1 occurrence required</li>
	</ul></div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the property cardinality</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>0</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="required--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>required</h4>
	<pre>public abstract boolean required</pre>
	<div class="block">Tells if this property is required or not.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>true if the property is required, false if not</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="optionLabels--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>optionLabels</h4>
	<pre>public abstract java.lang.String[] optionLabels</pre>
	<div class="block">Return a list of valid option labels for this property. The purpose of this method is to allow menus with localized labels.
	It is associated with the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute. The labels returned here are ordered in the same way as the
	<a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues--"><code>optionValues()</code></a> attribute values.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the list of valid option labels for this property.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="optionValues--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>optionValues</h4>
	<pre>public abstract java.lang.String[] optionValues</pre>
	<div class="block">Return a list of option values that this property can take. This list must be in the same sequence as the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels--"><code>optionLabels()</code></a>
	attribute.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the option 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>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<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/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Registered.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/PropertyMetaData.html" target="_top">Frames</a></li>
	<li><a href="PropertyMetaData.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>Field \| </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>Field \| </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>