| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PropertyValue (Apache Tamaya Base 0.4-incubating API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="keywords" content="org.apache.tamaya.spi.PropertyValue class"> |
| <meta name="keywords" content="createObject()"> |
| <meta name="keywords" content="createList()"> |
| <meta name="keywords" content="createValue()"> |
| <meta name="keywords" content="mapProperties()"> |
| <meta name="keywords" content="isImmutable()"> |
| <meta name="keywords" content="immutable()"> |
| <meta name="keywords" content="mutable()"> |
| <meta name="keywords" content="getValueType()"> |
| <meta name="keywords" content="getKey()"> |
| <meta name="keywords" content="getValue()"> |
| <meta name="keywords" content="getSource()"> |
| <meta name="keywords" content="setValue()"> |
| <meta name="keywords" content="getQualifiedKey()"> |
| <meta name="keywords" content="getParent()"> |
| <meta name="keywords" content="getVersion()"> |
| <meta name="keywords" content="isRoot()"> |
| <meta name="keywords" content="isLeaf()"> |
| <meta name="keywords" content="getMeta()"> |
| <meta name="keywords" content="getMetaEntry()"> |
| <meta name="keywords" content="getSize()"> |
| <meta name="keywords" content="iterator()"> |
| <meta name="keywords" content="setMeta()"> |
| <meta name="keywords" content="removeMeta()"> |
| <meta name="keywords" content="toMap()"> |
| <meta name="keywords" content="toLocalMap()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="toObjectValue()"> |
| <meta name="keywords" content="toListValue()"> |
| <meta name="keywords" content="deepClone()"> |
| <meta name="keywords" content="checkImmutable()"> |
| <meta name="keywords" content="incrementVersion()"> |
| <meta name="keywords" content="setVersion()"> |
| <meta name="keywords" content="setKey()"> |
| <meta name="keywords" content="setParent()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PropertyValue (Apache Tamaya Base 0.4-incubating API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":42,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":9,"i27":9,"i28":9,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertyValue.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.tamaya.spi</a></div> |
| <h2 title="Class PropertyValue" class="title">Class PropertyValue</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.tamaya.spi.PropertyValue</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a></code>, <code><a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">PropertyValue</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></pre> |
| <div class="block">Class modelling the result of a request for a property createValue. A property createValue is basically identified by its key. |
| There might be reasons, where one want to further analyze, which PropertySources provided a createValue and which not, so |
| it is possible to createObject a PropertyValue with a null createValue. |
| |
| A PropertyValue represents an abstract data point in a configuration structure read. PropertyValues actually |
| represent a tree, with additional functionality for representing data lists/arrays using indexed children |
| names. This allows to support a full mapping of common document based configuration formats, such as JSON, YAML, |
| XML and more.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.tamaya.spi.PropertyValue">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PropertyValue.ValueType.html" title="enum in org.apache.tamaya.spi">PropertyValue.ValueType</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Enum of the different supported value types.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">PropertyValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String)">PropertyValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkImmutable()">checkImmutable</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createList()">createList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new (invisible) root, which is a node with an empty name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createList(java.lang.String)">createList</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#ARRAY"><code>PropertyValue.ValueType.ARRAY</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createObject()">createObject</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new (invisible) root, which is a node with an empty name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createObject(java.lang.String)">createObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#MAP"><code>PropertyValue.ValueType.MAP</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createValue(java.lang.String,java.lang.String)">createValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#VALUE"><code>PropertyValue.ValueType.VALUE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deepClone()">deepClone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a deep clone of this intance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKey()">getKey</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The requested key.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMeta()">getMeta</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a full configuration map for this key, createValue pair and all its getMeta context data.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMeta(java.lang.String)">getMeta</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Access the given key from this createValue.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaEntry(java.lang.String)">getMetaEntry</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getMeta(java.lang.String)"><code>getMeta(String)</code></a> instead of.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the value's parent.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQualifiedKey()">getQualifiedKey</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get a qualified name of a value in property format using '.' as separator, e.g.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSize()">getSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the createValue's number of elements.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource()">getSource</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <code>getMeta("source")</code>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the node's createValue.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="PropertyValue.ValueType.html" title="enum in org.apache.tamaya.spi">PropertyValue.ValueType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the item's current createValue type.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the values version, the version is updated with each change written.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#immutable()">immutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sets this instance and also all its direct an indirect children to immutable.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#incrementVersion()">incrementVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called to mark a change on this instance.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isImmutable()">isImmutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if the instance is immutable.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLeaf()">isLeaf</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if the value is a leaf value (has no values).</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRoot()">isRoot</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if the value is a root value.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapProperties(java.util.Map,java.lang.String)">mapProperties</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</code></th> |
| <td class="colLast"> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapProperties(java.util.Map,java.lang.String,java.util.Map)">mapProperties</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaData)</code></th> |
| <td class="colLast"> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapProperties(java.util.Map,java.lang.String,java.util.Map,java.lang.String)">mapProperties</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefix)</code></th> |
| <td class="colLast"> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mutable()">mutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clones this instance and all it's children, marking as mutable createValue.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMeta(java.lang.String)">removeMeta</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes a getMeta entry.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKey(java.lang.String)">setKey</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the entry's key, mapping also corresponding context entries.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMeta(java.lang.String,java.lang.Object)">setMeta</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Add an additional context data information.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMeta(java.util.Map)">setMeta</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaEntries)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces/sets the context data.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParent(org.apache.tamaya.spi.PropertyValue)">setParent</a></span>​(<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> parent)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the new parent, used iternally when converting between value types.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValue(java.lang.String)">setValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the createValue.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVersion(int)">setVersion</a></span>​(int version)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the new version, used iternally when cloning.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toListValue()">toListValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convert an instance to a List PropertyValue.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toLocalMap()">toLocalMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convert the value tree to a property mapProperties using local keys.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toMap()">toMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convert the value tree to a property map.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toObjectValue()">toObjectValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convert an instance to a Object PropertyValue.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a String representation of the tree.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator()" title="class or interface in java.lang" class="externalLink">spliterator</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PropertyValue</h4> |
| <pre>public PropertyValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Creates a new instance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PropertyValue</h4> |
| <pre>protected PropertyValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> |
| <div class="block">Creates a new instance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dd><code>value</code> - the initial text createValue.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="createObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createObject</h4> |
| <pre class="methodSignature">public static <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> createObject()</pre> |
| <div class="block">Creates a new (invisible) root, which is a node with an empty name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new empty root, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createList</h4> |
| <pre class="methodSignature">public static <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a> createList()</pre> |
| <div class="block">Creates a new (invisible) root, which is a node with an empty name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new empty root, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createValue(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createValue</h4> |
| <pre class="methodSignature">public static <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> createValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#VALUE"><code>PropertyValue.ValueType.VALUE</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dd><code>value</code> - the createValue, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new createValue instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createList</h4> |
| <pre class="methodSignature">public static <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a> createList​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#ARRAY"><code>PropertyValue.ValueType.ARRAY</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new createValue instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createObject(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createObject</h4> |
| <pre class="methodSignature">public static <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> createObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Creates a new createValue of type <a href="PropertyValue.ValueType.html#MAP"><code>PropertyValue.ValueType.MAP</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new createValue instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mapProperties(java.util.Map,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mapProperties</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> mapProperties​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</pre> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the String based mapProperties, not <code>null</code>.</dd> |
| <dd><code>source</code> - the source name, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding createValue based mapProperties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mapProperties(java.util.Map,java.lang.String,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mapProperties</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> mapProperties​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaData)</pre> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the String based mapProperties, not <code>null</code>.</dd> |
| <dd><code>source</code> - the source name, not <code>null</code>.</dd> |
| <dd><code>metaData</code> - additional metadata, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding createValue based mapProperties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mapProperties(java.util.Map,java.lang.String,java.util.Map,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mapProperties</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> mapProperties​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefix)</pre> |
| <div class="block">Maps a mapProperties of <code>Map<String,String></code> to a <code>Map<String,PropertyValue></code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the String based mapProperties, not <code>null</code>.</dd> |
| <dd><code>source</code> - the source name, not <code>null</code>.</dd> |
| <dd><code>metaData</code> - additional metadata, not <code>null</code>.</dd> |
| <dd><code>prefix</code> - the prefix to add (optional).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding createValue based mapProperties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isImmutable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isImmutable</h4> |
| <pre class="methodSignature">public final boolean isImmutable()</pre> |
| <div class="block">Checks if the instance is immutable.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if the instance is immutable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="immutable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>immutable</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> immutable()</pre> |
| <div class="block">Sets this instance and also all its direct an indirect children to immutable. Any further changes will throw |
| an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mutable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mutable</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> mutable()</pre> |
| <div class="block">Clones this instance and all it's children, marking as mutable createValue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new createValue clone.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValueType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.ValueType.html" title="enum in org.apache.tamaya.spi">PropertyValue.ValueType</a> getValueType()</pre> |
| <div class="block">Get the item's current createValue type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the createValue type, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKey</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getKey()</pre> |
| <div class="block">The requested key.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the, key never <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getValue()</pre> |
| <div class="block">Get the node's createValue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the createValue, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSource</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getSource()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <code>getMeta("source")</code>.</div> |
| </div> |
| <div class="block">Get the source.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the source, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> |
| <div class="block">Sets the createValue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the createValue</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this value for chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isImmutable()"><code>isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQualifiedKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifiedKey</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getQualifiedKey()</pre> |
| <div class="block">Get a qualified name of a value in property format using '.' as separator, e.g. |
| <code>a.b.c</code> or <code>a.b.c[0]</code> for indexed entries. Entries hereby also can have multiple |
| levels of indexing, e.g. <code>a[1].b.c[14].d</code> is a valid option. |
| |
| The qualified key is defined by <a href="#getQualifiedKey()"><code>getQualifiedKey()</code></a> of it's parent concatenated with the key |
| of this node. If there is no parent, or the parent's qualified key is empty only <a href="#getKey()"><code>getKey()</code></a> |
| is returned. Additionally if the current values is an indeyed createValue the key is extended by the |
| index in brackets, e.g. <code>[0], [1], ...</code>. All the subsequent keys are valid qualified keys: |
| <pre> |
| a |
| a.b |
| a[0].b |
| [0] |
| a.b[4].c.d[0].[1].any |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the qualified key, never null..</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature">public final <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> getParent()</pre> |
| <div class="block">Get the value's parent.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parent, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre class="methodSignature">public final int getVersion()</pre> |
| <div class="block">Get the values version, the version is updated with each change written.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRoot()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRoot</h4> |
| <pre class="methodSignature">public final boolean isRoot()</pre> |
| <div class="block">Checks if the value is a root value.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if the current value is a root value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLeaf()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLeaf</h4> |
| <pre class="methodSignature">public final boolean isLeaf()</pre> |
| <div class="block">Checks if the value is a leaf value (has no values).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if the current value is a leaf value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMeta()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMeta</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getMeta()</pre> |
| <div class="block">Creates a full configuration map for this key, createValue pair and all its getMeta context data. This map |
| is also used for subsequent processing, like createValue filtering.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property createValue entry map.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetaEntry(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaEntry</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getMetaEntry​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getMeta(java.lang.String)"><code>getMeta(String)</code></a> instead of.</div> |
| </div> |
| <div class="block">Access the given key from this createValue. Valid keys are the key or any getMeta-context key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the createValue found, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMeta(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMeta</h4> |
| <pre class="methodSignature">public final <T> T getMeta​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Access the given key from this createValue. Valid keys are the key or any getMeta-context key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the target type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the createValue found, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSize</h4> |
| <pre class="methodSignature">public int getSize()</pre> |
| <div class="block">Get the createValue's number of elements.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the getNumChilds of this multi createValue.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> iterator()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang" class="externalLink">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMeta(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMeta</h4> |
| <pre class="methodSignature">public final <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setMeta​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> metaEntries)</pre> |
| <div class="block">Replaces/sets the context data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metaEntries</code> - the context data to be applied, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder for chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isImmutable()"><code>isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMeta(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMeta</h4> |
| <pre class="methodSignature">public final <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setMeta​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Add an additional context data information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the context data key, not <code>null</code>.</dd> |
| <dd><code>value</code> - the context createValue, not <code>null</code> (will be converted to String).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder for chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isImmutable()"><code>isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeMeta(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMeta</h4> |
| <pre class="methodSignature">public final <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> removeMeta​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Removes a getMeta entry.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the entry's key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder for chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isImmutable()"><code>isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMap</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> toMap()</pre> |
| <div class="block">Convert the value tree to a property map.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding property map, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toLocalMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toLocalMap</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> toLocalMap()</pre> |
| <div class="block">Convert the value tree to a property mapProperties using local keys.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding property mapProperties, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString()</pre> |
| <div class="block">Create a String representation of the tree.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding String representation, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toObjectValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toObjectValue</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> toObjectValue()</pre> |
| <div class="block">Convert an instance to a Object PropertyValue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list value, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toListValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toListValue</h4> |
| <pre class="methodSignature">public <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a> toListValue()</pre> |
| <div class="block">Convert an instance to a List PropertyValue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list value, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deepClone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deepClone</h4> |
| <pre class="methodSignature">protected <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> deepClone()</pre> |
| <div class="block">Creates a deep clone of this intance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkImmutable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkImmutable</h4> |
| <pre class="methodSignature">protected final void checkImmutable()</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="incrementVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incrementVersion</h4> |
| <pre class="methodSignature">protected final int incrementVersion()</pre> |
| <div class="block">Called to mark a change on this instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setVersion(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre class="methodSignature">protected final void setVersion​(int version)</pre> |
| <div class="block">Sets the new version, used iternally when cloning.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - the new version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKey</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setKey​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Changes the entry's key, mapping also corresponding context entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the new key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder for chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the instance is immutable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isImmutable()"><code>isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setParent(org.apache.tamaya.spi.PropertyValue)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParent</h4> |
| <pre class="methodSignature">protected <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setParent​(<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> parent)</pre> |
| <div class="block">Sets the new parent, used iternally when converting between value types.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - the parent value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the simple value, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertyValue.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2014–2019 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |