| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Configuration (Apache Tamaya Base 0.5-incubating-SNAPSHOT API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="keywords" content="org.apache.tamaya.Configuration interface"> |
| <meta name="keywords" content="EMPTY"> |
| <meta name="keywords" content="get()"> |
| <meta name="keywords" content="getOrDefault()"> |
| <meta name="keywords" content="getOptional()"> |
| <meta name="keywords" content="getProperties()"> |
| <meta name="keywords" content="with()"> |
| <meta name="keywords" content="map()"> |
| <meta name="keywords" content="query()"> |
| <meta name="keywords" content="adapt()"> |
| <meta name="keywords" content="getContext()"> |
| <meta name="keywords" content="getSnapshot()"> |
| <meta name="keywords" content="toBuilder()"> |
| <meta name="keywords" content="setCurrent()"> |
| <meta name="keywords" content="current()"> |
| <meta name="keywords" content="releaseConfiguration()"> |
| <meta name="keywords" content="createConfigurationBuilder()"> |
| <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="Configuration (Apache Tamaya Base 0.5-incubating-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":1,"i2":1,"i3":1,"i4":18,"i5":18,"i6":18,"i7":18,"i8":18,"i9":6,"i10":6,"i11":18,"i12":18,"i13":18,"i14":18,"i15":18,"i16":18,"i17":18,"i18":18,"i19":18,"i20":18,"i21":18,"i22":6,"i23":6,"i24":6,"i25":18,"i26":18,"i27":50,"i28":1,"i29":1,"i30":1,"i31":18,"i32":50}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Configuration.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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</a></div> |
| <h2 title="Interface Configuration" class="title">Interface Configuration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ConfigurationSnapshot.html" title="interface in org.apache.tamaya">ConfigurationSnapshot</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="core/internal/CoreConfiguration.html" title="class in org.apache.tamaya.core.internal">CoreConfiguration</a></code>, <code><a href="spisupport/DefaultConfiguration.html" title="class in org.apache.tamaya.spisupport">DefaultConfiguration</a></code>, <code><a href="spisupport/DefaultConfigurationSnapshot.html" title="class in org.apache.tamaya.spisupport">DefaultConfigurationSnapshot</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Configuration</span></pre> |
| <div class="block"><p>A configuration models an aggregated setPropertyValue of current properties, identified by |
| a unique key, but adds higher level access functions to |
| a <a href="spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a>. Hereby in most |
| cases a configuration is a wrapper around a composite |
| <a href="spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> instance, which may combine |
| multiple child configurations in a well defined tree like structure, |
| where nodes define logically the rules' current priority, filtering, |
| combination and overriding. |
| </p> |
| <h3>Implementation Requirements</h3> |
| Implementations of this interface must be |
| <ul> |
| <li>Thread safe</li> |
| <li>Immutable</li> |
| </ul> |
| |
| <p>It is not recommended that implementations also are serializable, since the any configuration can be <i>frozen</i> |
| by reading out its complete configuration mapProperties into a serializable and remotable structure. This helps significantly |
| by simplifying the development of this interface, e.g. for being backed up by systems and stores that are not part of |
| this library at all.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY">EMPTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Immutable and reusable, thread-safe implementation of an empty propertySource.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><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>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#adapt(java.util.function.Function)">adapt</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a><<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a>,​T> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Query a configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="spi/ConfigurationBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createConfigurationBuilder()">createConfigurationBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access a new configuration builder initialized with the current thread's context classloader.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#current()">current</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access the configuration instance for the current thread's context classloader.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#current(java.lang.ClassLoader)">current</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classloader)</code></th> |
| <td class="colLast"> |
| <div class="block">Accesses the configuration for a given classloader.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <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="#get(java.lang.Iterable)">get</a></span>​(<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="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>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.Iterable,java.lang.Class)">get</a></span>​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.Iterable,org.apache.tamaya.TypeLiteral)">get</a></span>​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default <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="#get(java.lang.String)">get</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 a property.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.String,java.lang.Class)">get</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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.String,org.apache.tamaya.TypeLiteral)">get</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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access a configuration's context.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</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="#getOptional(java.lang.Iterable)">getOptional</a></span>​(<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="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>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a String property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptional(java.lang.Iterable,java.lang.Class)">getOptional</a></span>​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptional(java.lang.Iterable,org.apache.tamaya.TypeLiteral)">getOptional</a></span>​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</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="#getOptional(java.lang.String)">getOptional</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 a String property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptional(java.lang.String,java.lang.Class)">getOptional</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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptional(java.lang.String,org.apache.tamaya.TypeLiteral)">getOptional</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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrDefault(java.lang.Iterable,java.lang.Class,T)">getOrDefault</a></span>​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type, |
| T defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>default <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="#getOrDefault(java.lang.Iterable,java.lang.String)">getOrDefault</a></span>​(<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="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>> keys, |
| <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> defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrDefault(java.lang.Iterable,org.apache.tamaya.TypeLiteral,T)">getOrDefault</a></span>​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type, |
| T defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrDefault(java.lang.String,java.lang.Class,T)">getOrDefault</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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type, |
| T defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>default <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="#getOrDefault(java.lang.String,java.lang.String)">getOrDefault</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> defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Access a property.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrDefault(java.lang.String,org.apache.tamaya.TypeLiteral,T)">getOrDefault</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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type, |
| T defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the property keys as type T.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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="#getProperties()">getProperties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access all currently known configuration properties as a full <code>Map<String,String></code>.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="ConfigurationSnapshot.html" title="interface in org.apache.tamaya">ConfigurationSnapshot</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSnapshot(java.lang.Iterable)">getSnapshot</a></span>​(<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="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>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a snapshot, which contains the given keys.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>default <a href="ConfigurationSnapshot.html" title="interface in org.apache.tamaya">ConfigurationSnapshot</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSnapshot(java.lang.String...)">getSnapshot</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>... keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a snapshot, which contains all known keys.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>default <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#map(java.util.function.UnaryOperator)">map</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">UnaryOperator</a><<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a>> operator)</code></th> |
| <td class="colLast"> |
| <div class="block">Extension point for adjusting configuration.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>default <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(org.apache.tamaya.ConfigQuery)">query</a></span>​(<a href="ConfigQuery.html" title="interface in org.apache.tamaya">ConfigQuery</a><T> query)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#adapt(java.util.function.Function)"><code>adapt(Function)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseConfiguration(java.lang.ClassLoader)">releaseConfiguration</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classloader)</code></th> |
| <td class="colLast"> |
| <div class="block">Releases the configuration associated with the given classloader.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCurrent(org.apache.tamaya.Configuration)">setCurrent</a></span>​(<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config)</code></th> |
| <td class="colLast"> |
| <div class="block">This method allows replacement of the current default <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCurrent(org.apache.tamaya.Configuration,java.lang.ClassLoader)">setCurrent</a></span>​(<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classLoader)</code></th> |
| <td class="colLast"> |
| <div class="block">This method allows replacement of the current default <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>default <a href="spi/ConfigurationBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBuilder()">toBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new builder using this instance as its base.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>default <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#with(org.apache.tamaya.ConfigOperator)">with</a></span>​(<a href="ConfigOperator.html" title="interface in org.apache.tamaya">ConfigOperator</a> operator)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#map(java.util.function.UnaryOperator)"><code>map(UnaryOperator)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="EMPTY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EMPTY</h4> |
| <pre>static final <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> EMPTY</pre> |
| <div class="block">Immutable and reusable, thread-safe implementation of an empty propertySource.</div> |
| </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="get(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">default <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> get​(<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 a property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">default <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> get​(<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="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>> keys)</pre> |
| <div class="block">Access a property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in order of evaluation, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature">default <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> getOrDefault​(<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> defaultValue)</pre> |
| <div class="block">Access a property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's key, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - value to be returned, if no value is present, not <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.Iterable,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature">default <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> getOrDefault​(<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="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>> keys, |
| <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> defaultValue)</pre> |
| <div class="block">Access a property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in order of evaluation, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - value to be returned, if no value is present, not <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</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>> getOptional​(<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 a String property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's key, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</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>> getOptional​(<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="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>> keys)</pre> |
| <div class="block">Access a String property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T> getOptional​(<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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's key, not <code>null</code>.</dd> |
| <dd><code>type</code> - the target type, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.Iterable,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T> getOptional​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - the target type, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.String,org.apache.tamaya.TypeLiteral)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T> getOptional​(<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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</pre> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's key, not <code>null</code>.</dd> |
| <dd><code>type</code> - the target type, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOptional(java.lang.Iterable,org.apache.tamaya.TypeLiteral)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptional</h4> |
| <pre class="methodSignature">default <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><T> getOptional​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</pre> |
| <div class="block">Access a property, using an an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Optional</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - the target type, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property's keys.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.String,java.lang.Class,java.lang.Object)"> |
| <!-- --> |
| </a><a id="getOrDefault(java.lang.String,java.lang.Class,T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature">default <T> T getOrDefault​(<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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type, |
| T defaultValue)</pre> |
| <div class="block">Gets the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| fromMap for the given String keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's absolute, or relative path, e.g. <code> |
| a/b/c/d.myProperty</code>, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - value to be used, if no value is present, not <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.Iterable,java.lang.Class,java.lang.Object)"> |
| <!-- --> |
| </a><a id="getOrDefault(java.lang.Iterable,java.lang.Class,T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature">default <T> T getOrDefault​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type, |
| T defaultValue)</pre> |
| <div class="block">Gets the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| fromMap for the given String keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - value to be used, if no value is present, not <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">default <T> T get​(<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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Gets the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| fromMap for the given String keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's absolute, or relative path, e.g. @code |
| a/b/c/d.myProperty}.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.Iterable,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">default <T> T get​(<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="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>> keys, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Gets the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| fromMap for the given String keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the class modeled by the type parameter</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.String,org.apache.tamaya.TypeLiteral)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature"><T> T get​(<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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</pre> |
| <div class="block">Get the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| literals for the given key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the type literal</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's absolute, or relative path, e.g. @code |
| a/b/c/d.myProperty}, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.Iterable,org.apache.tamaya.TypeLiteral)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">default <T> T get​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type)</pre> |
| <div class="block">Get the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| literals for the given key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the type literal</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.String,org.apache.tamaya.TypeLiteral,java.lang.Object)"> |
| <!-- --> |
| </a><a id="getOrDefault(java.lang.String,org.apache.tamaya.TypeLiteral,T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature"><T> T getOrDefault​(<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="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type, |
| T defaultValue)</pre> |
| <div class="block">Get the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| literals for the given key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the type literal</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the property's absolute, or relative path, e.g. |
| <code>a/b/c/d.myProperty</code>, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - default value to be used, if no value is present.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrDefault(java.lang.Iterable,org.apache.tamaya.TypeLiteral,java.lang.Object)"> |
| <!-- --> |
| </a><a id="getOrDefault(java.lang.Iterable,org.apache.tamaya.TypeLiteral,T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrDefault</h4> |
| <pre class="methodSignature">default <T> T getOrDefault​(<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="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>> keys, |
| <a href="TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><T> type, |
| T defaultValue)</pre> |
| <div class="block">Get the property keys as type T. This will implicitly require a corresponding <a href="spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> to be available that is capable of providing type T |
| literals for the given key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the type literal</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the property's keys, in evaluation order, not <code>null</code>.</dd> |
| <dd><code>type</code> - The target type required, not <code>null</code>.</dd> |
| <dd><code>defaultValue</code> - default value to be used, if no value is present.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property value, never null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigException.html" title="class in org.apache.tamaya">ConfigException</a></code> - if the keys could not be converted to the required target type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre class="methodSignature"><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>> getProperties()</pre> |
| <div class="block">Access all currently known configuration properties as a full <code>Map<String,String></code>. |
| Be aware that entries from non scannable parts of the registered <a href="spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> |
| instances may not be contained in the result, but nevertheless be accessible by calling one of the |
| <code>current(...)</code> methods.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all currently known configuration properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="with(org.apache.tamaya.ConfigOperator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>with</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> |
| default <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> with​(<a href="ConfigOperator.html" title="interface in org.apache.tamaya">ConfigOperator</a> operator)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#map(java.util.function.UnaryOperator)"><code>map(UnaryOperator)</code></a></div> |
| </div> |
| <div class="block">Extension point for adjusting configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operator</code> - A configuration operator, e.g. a filter, or an adjuster |
| combining configurations, never <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new adjusted configuration returned by the <code>operator</code>, never <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="map(java.util.function.UnaryOperator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre class="methodSignature">default <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> map​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">UnaryOperator</a><<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a>> operator)</pre> |
| <div class="block">Extension point for adjusting configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operator</code> - A configuration operator, e.g. a filter, or an adjuster |
| combining configurations, never <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new adjusted configuration returned by the <code>operator</code>, never <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="query(org.apache.tamaya.ConfigQuery)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</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> |
| default <T> T query​(<a href="ConfigQuery.html" title="interface in org.apache.tamaya">ConfigQuery</a><T> query)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#adapt(java.util.function.Function)"><code>adapt(Function)</code></a></div> |
| </div> |
| <div class="block">Query a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the configuration.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - the query, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result returned by the <code>query</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="adapt(java.util.function.Function)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>adapt</h4> |
| <pre class="methodSignature">default <T> T adapt​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a><<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a>,​T> query)</pre> |
| <div class="block">Query a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the configuration.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - the query, not <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result returned by the <code>query</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre class="methodSignature"><a href="spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> getContext()</pre> |
| <div class="block">Access a configuration's context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration context, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSnapshot(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshot</h4> |
| <pre class="methodSignature"><a href="ConfigurationSnapshot.html" title="interface in org.apache.tamaya">ConfigurationSnapshot</a> getSnapshot​(<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="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>> keys)</pre> |
| <div class="block">Create a snapshot, which contains the given keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the keys, not null. If empty a full snapshot with all known keys is returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a corresponding snapshot instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSnapshot(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshot</h4> |
| <pre class="methodSignature">default <a href="ConfigurationSnapshot.html" title="interface in org.apache.tamaya">ConfigurationSnapshot</a> getSnapshot​(<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>... keys)</pre> |
| <div class="block">Create a snapshot, which contains all known keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - the target key. If empty a full snapshot with all known keys is returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a corresponding snapshot instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBuilder</h4> |
| <pre class="methodSignature">default <a href="spi/ConfigurationBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationBuilder</a> toBuilder()</pre> |
| <div class="block">Create a new builder using this instance as its base.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new builder, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCurrent(org.apache.tamaya.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrent</h4> |
| <pre class="methodSignature">static void setCurrent​(<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config)</pre> |
| <div class="block">This method allows replacement of the current default <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new |
| instance. It is the responsibility of the ConfigurationProvider to trigger |
| corresponding update events for the current <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>, so observing |
| listeners can do whatever is appropriate to react to any given configuration change.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the new Configuration to be applied, not <code>null</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the current provider is read-only and |
| does not support |
| applying a new Configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCurrent(org.apache.tamaya.Configuration,java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrent</h4> |
| <pre class="methodSignature">static void setCurrent​(<a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classLoader)</pre> |
| <div class="block">This method allows replacement of the current default <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new |
| instance. It is the responsibility of the ConfigurationProvider to trigger |
| corresponding update events for the current <a href="Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>, so observing |
| listeners can do whatever is appropriate to react to any given configuration change.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the new Configuration to be applied, not <code>null</code></dd> |
| <dd><code>classLoader</code> - the target classloader, not null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the current provider is read-only and |
| does not support |
| applying a new Configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="current()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature">static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> current()</pre> |
| <div class="block">Access the configuration instance for the current thread's context classloader.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration instance, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="current(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature">static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> current​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classloader)</pre> |
| <div class="block">Accesses the configuration for a given classloader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classloader</code> - the classloader, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration instance, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="releaseConfiguration(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>releaseConfiguration</h4> |
| <pre class="methodSignature">static <a href="Configuration.html" title="interface in org.apache.tamaya">Configuration</a> releaseConfiguration​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> classloader)</pre> |
| <div class="block">Releases the configuration associated with the given classloader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classloader</code> - the classloader, not null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the released configuration, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createConfigurationBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createConfigurationBuilder</h4> |
| <pre class="methodSignature">static <a href="spi/ConfigurationBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationBuilder</a> createConfigurationBuilder()</pre> |
| <div class="block">Access a new configuration builder initialized with the current thread's context classloader.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder, never 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/Configuration.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |