| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ObjectValue (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.ObjectValue class"> |
| <meta name="keywords" content="getValueType()"> |
| <meta name="keywords" content="getValues()"> |
| <meta name="keywords" content="getKeys()"> |
| <meta name="keywords" content="getPropertyValue()"> |
| <meta name="keywords" content="getValue()"> |
| <meta name="keywords" content="setValue()"> |
| <meta name="keywords" content="getOrSetValue()"> |
| <meta name="keywords" content="getSize()"> |
| <meta name="keywords" content="setValues()"> |
| <meta name="keywords" content="toObjectValue()"> |
| <meta name="keywords" content="toListValue()"> |
| <meta name="keywords" content="iterator()"> |
| <meta name="keywords" content="setPropertyValue()"> |
| <meta name="keywords" content="addList()"> |
| <meta name="keywords" content="addObject()"> |
| <meta name="keywords" content="setValueWithCompositeKey()"> |
| <meta name="keywords" content="toMap()"> |
| <meta name="keywords" content="toLocalMap()"> |
| <meta name="keywords" content="mutable()"> |
| <meta name="keywords" content="deepClone()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="from()"> |
| <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="ObjectValue (Apache Tamaya Base 0.4-incubating API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ObjectValue.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>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 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 ObjectValue" class="title">Class ObjectValue</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><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">org.apache.tamaya.spi.PropertyValue</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.tamaya.spi.ObjectValue</li> |
| </ul> |
| </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> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ObjectValue</span> |
| extends <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 value. A property value is basically identified by its key. |
| There might be reasons, where one want to further analyze, which PropertySources provided a value and which not, so |
| it is possible to createObject a PropertyValue with a null value. |
| |
| 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.ObjectValue">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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.tamaya.spi.PropertyValue"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.tamaya.spi.<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></h3> |
| <code><a href="PropertyValue.ValueType.html" title="enum in org.apache.tamaya.spi">PropertyValue.ValueType</a></code></li> |
| </ul> |
| </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></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><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="#addList(java.lang.String)">addList</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">Sets the given list value.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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="#addObject(java.lang.String)">addObject</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">Sets the given object vaöue.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <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="#deepClone()">deepClone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a deep clone of this intance.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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="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="#from(java.util.Collection)">from</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> values)</code></th> |
| <td class="colLast"> |
| <div class="block">Merges multiple values into one single node.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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="#getKeys()">getKeys</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access the current present field names/keys.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrSetValue(java.lang.String,java.util.function.Supplier)">getOrSetValue</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> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><T> valueSupplier)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a single child getValue with the given name, creates it if not existing.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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="#getPropertyValue(java.lang.String)">getPropertyValue</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> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a single child getValue by name.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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 value's number of elements.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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="#getValue()">getValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the node's createValue.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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(java.lang.String)">getValue</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">Get a String value with the given key, if possible.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</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="#getValues()">getValues</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the fields of this instance.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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 value type.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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="i14" class="altColor"> |
| <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="i15" class="rowColor"> |
| <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="#mutable()">mutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clones this instance and all it's children, marking as mutable value.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected <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="#setPropertyValue(org.apache.tamaya.spi.PropertyValue)">setPropertyValue</a></span>​(<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds another existing node, hereby setting the corresponding parent node.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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="i18" 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="#setValue(java.lang.String,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> k, |
| <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> v)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the given key, value pair.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <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="#setValues(java.util.Map)">setValues</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)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies a mapProperties of <code>Map<String,String></code> to this instance as values.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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="#setValues(java.util.Map,java.lang.String,boolean)">setValues</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, |
| boolean overwriteExisting)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies a mapProperties of <code>Map<String,String></code> to this instance as values.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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="#setValueWithCompositeKey(java.lang.String,java.lang.String)">setValueWithCompositeKey</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">Adds a new child getValue, where the getValue is given in '.'</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</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="#setValueWithCompositeKey(java.util.Map)">setValueWithCompositeKey</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>> values)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds multiple values, where the keys are given in '.'</div> |
| </td> |
| </tr> |
| <tr id="i23" 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="i24" 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 local property map.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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="i26" 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="i27" 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.org.apache.tamaya.spi.PropertyValue"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.tamaya.spi.<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></h3> |
| <code><a href="PropertyValue.html#checkImmutable()">checkImmutable</a>, <a href="PropertyValue.html#createList()">createList</a>, <a href="PropertyValue.html#createList(java.lang.String)">createList</a>, <a href="PropertyValue.html#createObject()">createObject</a>, <a href="PropertyValue.html#createObject(java.lang.String)">createObject</a>, <a href="PropertyValue.html#createValue(java.lang.String,java.lang.String)">createValue</a>, <a href="PropertyValue.html#getKey()">getKey</a>, <a href="PropertyValue.html#getMeta()">getMeta</a>, <a href="PropertyValue.html#getMeta(java.lang.String)">getMeta</a>, <a href="PropertyValue.html#getMetaEntry(java.lang.String)">getMetaEntry</a>, <a href="PropertyValue.html#getParent()">getParent</a>, <a href="PropertyValue.html#getQualifiedKey()">getQualifiedKey</a>, <a href="PropertyValue.html#getSource()">getSource</a>, <a href="PropertyValue.html#getVersion()">getVersion</a>, <a href="PropertyValue.html#immutable()">immutable</a>, <a href="PropertyValue.html#incrementVersion()">incrementVersion</a>, <a href="PropertyValue.html#isImmutable()">isImmutable</a>, <a href="PropertyValue.html#isLeaf()">isLeaf</a>, <a href="PropertyValue.html#isRoot()">isRoot</a>, <a href="PropertyValue.html#mapProperties(java.util.Map,java.lang.String)">mapProperties</a>, <a href="PropertyValue.html#mapProperties(java.util.Map,java.lang.String,java.util.Map)">mapProperties</a>, <a href="PropertyValue.html#mapProperties(java.util.Map,java.lang.String,java.util.Map,java.lang.String)">mapProperties</a>, <a href="PropertyValue.html#removeMeta(java.lang.String)">removeMeta</a>, <a href="PropertyValue.html#setKey(java.lang.String)">setKey</a>, <a href="PropertyValue.html#setMeta(java.lang.String,java.lang.Object)">setMeta</a>, <a href="PropertyValue.html#setMeta(java.util.Map)">setMeta</a>, <a href="PropertyValue.html#setParent(org.apache.tamaya.spi.PropertyValue)">setParent</a>, <a href="PropertyValue.html#setVersion(int)">setVersion</a></code></li> |
| </ul> |
| <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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <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 value type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#getValueType()">getValueType</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value type, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> getValues()</pre> |
| <div class="block">Get the fields of this instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current fields, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeys</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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>> getKeys()</pre> |
| <div class="block">Access the current present field names/keys.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the keys present, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPropertyValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyValue</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> getPropertyValue​(<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> name)</pre> |
| <div class="block">Get a single child getValue by name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the child's name, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the child found, or null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if multiple getPropertyValues with the given name are existing (ambigous).</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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#getValue()">getValue</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the createValue, 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PropertyValue.html#setValue(java.lang.String)">PropertyValue</a></code></span></div> |
| <div class="block">Sets the createValue.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#setValue(java.lang.String)">setValue</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <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="seeLabel">See Also:</span></dt> |
| <dd><a href="PropertyValue.html#isImmutable()"><code>PropertyValue.isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValue(java.lang.String)"> |
| <!-- --> |
| </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​(<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">Get a String value with the given key, if possible. If a node is present, but no value is setPropertyValue, then the |
| node's <code>toString()</code> method is used as a result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value found, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrSetValue(java.lang.String,java.util.function.Supplier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrSetValue</h4> |
| <pre class="methodSignature">public <T extends <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> T getOrSetValue​(<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> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><T> valueSupplier)</pre> |
| <div class="block">Get a single child getValue with the given name, creates it if not existing.</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>name</code> - the child's name, not null.</dd> |
| <dd><code>valueSupplier</code> - the supplier to create a new instance, if no value is present, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the child found or created, never null.</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="PropertyValue.html#isImmutable()"><code>PropertyValue.isImmutable()</code></a></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 value's number of elements.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#getSize()">getSize</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the getNumChilds of this multi value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValues(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValues</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> setValues​(<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)</pre> |
| <div class="block">Applies a mapProperties of <code>Map<String,String></code> to this instance as values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the String based mapProperties, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding createValue based mapProperties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValues(java.util.Map,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValues</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> setValues​(<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, |
| boolean overwriteExisting)</pre> |
| <div class="block">Applies a mapProperties of <code>Map<String,String></code> to this instance as values.</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, optional.</dd> |
| <dd><code>overwriteExisting</code> - if true, existing values will be overridden.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding createValue based mapProperties.</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PropertyValue.html#toObjectValue()">PropertyValue</a></code></span></div> |
| <div class="block">Convert an instance to a Object PropertyValue.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#toObjectValue()">toObjectValue</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PropertyValue.html#toListValue()">PropertyValue</a></code></span></div> |
| <div class="block">Convert an instance to a List PropertyValue.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#toListValue()">toListValue</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list value, never null.</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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#iterator()">iterator</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPropertyValue(org.apache.tamaya.spi.PropertyValue)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPropertyValue</h4> |
| <pre class="methodSignature">protected <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> setPropertyValue​(<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> value)</pre> |
| <div class="block">Adds another existing node, hereby setting the corresponding parent node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value, not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value added, not null.</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="PropertyValue.html#isImmutable()"><code>PropertyValue.isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValue(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</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> k, |
| <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> v)</pre> |
| <div class="block">Sets the given key, value pair.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>k</code> - the key, not null.</dd> |
| <dd><code>v</code> - the value, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value added, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addList</h4> |
| <pre class="methodSignature">public <a href="ListValue.html" title="class in org.apache.tamaya.spi">ListValue</a> addList​(<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">Sets the given list value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value added, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addObject(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addObject</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> addObject​(<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">Sets the given object vaöue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value added, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValueWithCompositeKey(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueWithCompositeKey</h4> |
| <pre class="methodSignature">public <a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> setValueWithCompositeKey​(<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">Adds a new child getValue, where the getValue is given in '.'-separated property notation, |
| e.g. <code>a.b.c</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property key, e.g. <code>a.b.c</code></dd> |
| <dd><code>value</code> - the property value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new leaf-getValue created.</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="PropertyValue.html#isImmutable()"><code>PropertyValue.isImmutable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValueWithCompositeKey(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueWithCompositeKey</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> setValueWithCompositeKey​(<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>> values)</pre> |
| <div class="block">Adds multiple values, where the keys are given in '.'-separated property notation, |
| e.g. <code>a.b.c</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the values, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value instances created.</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="PropertyValue.html#isImmutable()"><code>PropertyValue.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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#toMap()">toMap</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <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 local property map.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#toLocalMap()">toLocalMap</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding local map, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mutable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mutable</h4> |
| <pre class="methodSignature">public <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> mutable()</pre> |
| <div class="block">Clones this instance and all it's children, marking as mutable value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#mutable()">mutable</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new value clone.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deepClone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deepClone</h4> |
| <pre class="methodSignature">protected <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> deepClone()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PropertyValue.html#deepClone()">PropertyValue</a></code></span></div> |
| <div class="block">Creates a deep clone of this intance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#deepClone()">deepClone</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone, 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="PropertyValue.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <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="PropertyValue.html#hashCode()">hashCode</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PropertyValue.html#toString()">PropertyValue</a></code></span></div> |
| <div class="block">Create a String representation of the tree.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="PropertyValue.html#toString()">toString</a></code> in class <code><a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding String representation, not null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="from(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre class="methodSignature">public static <a href="ObjectValue.html" title="class in org.apache.tamaya.spi">ObjectValue</a> from​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> values)</pre> |
| <div class="block">Merges multiple values into one single node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the values to merge, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the merged instance, or null.</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/ObjectValue.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>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 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> |