| <!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_191) on Sun Dec 23 12:06:06 CET 2018 --> |
| <title>PropertyMetaData</title> |
| <meta name="date" content="2018-12-23"> |
| <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) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="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/Logger.html" title="class in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.dm</div> |
| <h2 title="Interface PropertyMetaData" class="title">Interface PropertyMetaData</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PropertyMetaData</span></pre> |
| <div class="block">This interface defines meta data regarding a given configuration property.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#addOption-java.lang.String-java.lang.String-">addOption</a></span>(java.lang.String optionLabel, |
| java.lang.String optionValue)</code> |
| <div class="block">Return a list of valid options for this property (the labels may be localized).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setCardinality-int-">setCardinality</a></span>(int cardinality)</code> |
| <div class="block">Return the cardinality of this property.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setDefaults-java.lang.String:A-">setDefaults</a></span>(java.lang.String[] defaults)</code> |
| <div class="block">Returns a default for this property.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setDefaults-java.lang.String-java.lang.String...-">setDefaults</a></span>(java.lang.String def, |
| java.lang.String... defaults)</code> |
| <div class="block">Returns some defaults for this property.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Returns the property description.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setHeading-java.lang.String-">setHeading</a></span>(java.lang.String heading)</code> |
| <div class="block">The label used to display the property.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setId-java.lang.String-">setId</a></span>(java.lang.String id)</code> |
| <div class="block">The key of a ConfigurationAdmin property.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setRequired-boolean-">setRequired</a></span>(boolean required)</code> |
| <div class="block">Tells if this property is required or not.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setType-java.lang.Class-">setType</a></span>(java.lang.Class<?> type)</code> |
| <div class="block">Returns the property primitive type.</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="setHeading-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeading</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setHeading(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 (may be localized)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setId(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> |
| <a name="setType-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setType(java.lang.Class<?> type)</pre> |
| <div class="block">Returns the property primitive type. If must be either one of the following types:<p> |
| <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> |
| </li> |
| </ul> |
| <a name="setDefaults-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaults</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setDefaults(java.lang.String[] defaults)</pre> |
| <div class="block">Returns a default 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> |
| </li> |
| </ul> |
| <a name="setDefaults-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaults</h4> |
| <pre>default <a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setDefaults(java.lang.String def, |
| java.lang.String... defaults)</pre> |
| <div class="block">Returns some defaults 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> |
| </li> |
| </ul> |
| <a name="setDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setDescription(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>a localizable description of the property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCardinality-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCardinality</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setCardinality(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:<p> |
| |
| <ul> |
| <li> x = Integer.MIN_VALUE no limit, but use Vector</li> |
| <li> x < 0 -x = max occurrences, store in Vector</li> |
| <li> x > 0 x = max occurrences, store in array []</li> |
| <li> x = Integer.MAX_VALUE no limit, but use array []</li> |
| <li> x = 0 1 occurrence required</li> |
| </ul></div> |
| </li> |
| </ul> |
| <a name="setRequired-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequired</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setRequired(boolean required)</pre> |
| <div class="block">Tells if this property is required or not.</div> |
| </li> |
| </ul> |
| <a name="addOption-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addOption</h4> |
| <pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> addOption(java.lang.String optionLabel, |
| java.lang.String optionValue)</pre> |
| <div class="block">Return a list of valid options for this property (the labels may be localized).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of valid options for this property.</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="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="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/Logger.html" title="class in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
