| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>EnvironmentPropertySource (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.spisupport.propertysource.EnvironmentPropertySource class"> |
| <meta name="keywords" content="DEFAULT_ORDINAL"> |
| <meta name="keywords" content="getDefaultOrdinal()"> |
| <meta name="keywords" content="getName()"> |
| <meta name="keywords" content="get()"> |
| <meta name="keywords" content="getProperties()"> |
| <meta name="keywords" content="toStringValues()"> |
| <meta name="keywords" content="getPrefix()"> |
| <meta name="keywords" content="isDisabled()"> |
| <meta name="keywords" content="getChangeSupport()"> |
| <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="EnvironmentPropertySource (Apache Tamaya Base 0.5-incubating-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All 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/EnvironmentPropertySource.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.tamaya.spisupport.propertysource</a></div> |
| <h2 title="Class EnvironmentPropertySource" class="title">Class EnvironmentPropertySource</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="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">org.apache.tamaya.spisupport.propertysource.BasePropertySource</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.tamaya.spisupport.propertysource.EnvironmentPropertySource</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="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">EnvironmentPropertySource</span> |
| extends <a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></pre> |
| <div class="block"><p><a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> to access environment variables via Tamaya |
| which are setCurrent via <code>export VARIABLE=createValue</code> on UNIX systems or |
| <code>setCurrent VARIABLE=createValue</code> on Windows systems.</p> |
| |
| <p>Using the <a href="EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">EnvironmentPropertySource</a> without any |
| additional configuration gives access to all existing environment |
| variables available to the Java process Tamaya is running in.</p> |
| |
| <h1>Simple usage example</h1> |
| |
| <pre> |
| $ export OPS_MODE=production |
| $ export COLOR=false |
| $ java -jar application.jar |
| </pre> |
| |
| <p>To access <code>OPS_MODE</code> and <code>COLOR</code> with the following code |
| fragment could be used:</p> |
| |
| <pre> |
| PropertySource ps = new EnvironmentPropertySource(); |
| PropertyValue opsMode = ps.current("OPS_MODE"); |
| PropertyValue color = ps.current("COLOR"); |
| </pre> |
| |
| <h1>Application specific environment variables with prefix</h1> |
| |
| <p>Given the case where two instances of the same application are running on |
| a single machine but need different values for the environment variable |
| <code>CUSTOMER</code>. The <a href="EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">EnvironmentPropertySource</a> allows you |
| to prefix the environment variable with an application specific prefix |
| and to access it by the non-prefixed variable name.</p> |
| |
| <pre> |
| $ export CUSTOMER=none |
| $ export a81.CUSTOMER=moon |
| $ export b78.CUSTOMER=luna |
| </pre> |
| |
| <p>Given an environment with these three variables the application running |
| for the customer called Moon could be started with the following command:</p> |
| |
| <pre> |
| $ java -Dtamaya.envprops.prefix=a81 -jar application.jar |
| </pre> |
| |
| <p>The application specific createValue can now be accessed from the code of the |
| application like this:</p> |
| |
| <pre> |
| PropertySource ps = new EnvironmentPropertySource(); |
| PropertyValue pv = ps.current("CUSTOMER"); |
| System.out.println(pv.getValue()); |
| </pre> |
| |
| <p>The output of application would be <code>moon</code>.</p> |
| |
| <h1>Disabling the access to environment variables</h1> |
| |
| <p>The access to environment variables can simply be |
| disabled by setting the system property <code>tamaya.envprops.disable</code> |
| or <code>tamaya.defaults.disable</code> to <code>true</code>.</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 int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_ORDINAL">DEFAULT_ORDINAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Default ordinal for <a href="EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><code>EnvironmentPropertySource</code></a></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.tamaya.spi.PropertySource"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.tamaya.spi.<a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> |
| <code><a href="../../spi/PropertySource.html#EMPTY">EMPTY</a>, <a href="../../spi/PropertySource.html#TAMAYA_ORDINAL">TAMAYA_ORDINAL</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">EnvironmentPropertySource</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">EnvironmentPropertySource</a></span>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance using a fixed ordinal createValue.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">EnvironmentPropertySource</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> prefix)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,int)">EnvironmentPropertySource</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> prefix, |
| int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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="../../spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</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="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spi/ChangeSupport.html" title="enum in org.apache.tamaya.spi">ChangeSupport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChangeSupport()">getChangeSupport</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the support for reporting changes to property sources provided by this instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultOrdinal()">getDefaultOrdinal</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default ordinal used, when no ordinal is setCurrent, or the ordinal was not parseable to an int createValue.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the name of the property source.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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="#getPrefix()">getPrefix</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" 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="../../spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</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 the current properties as Set.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDisabled()">isDisabled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <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="#toStringValues()">toStringValues</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.tamaya.spisupport.propertysource.BasePropertySource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.tamaya.spisupport.propertysource.<a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></h3> |
| <code><a href="BasePropertySource.html#equals(java.lang.Object)">equals</a>, <a href="BasePropertySource.html#getOrdinal()">getOrdinal</a>, <a href="BasePropertySource.html#hashCode()">hashCode</a>, <a href="BasePropertySource.html#setChangeSupport(org.apache.tamaya.spi.ChangeSupport)">setChangeSupport</a>, <a href="BasePropertySource.html#setDefaultOrdinal(java.lang.Integer)">setDefaultOrdinal</a>, <a href="BasePropertySource.html#setDisabled(boolean)">setDisabled</a>, <a href="BasePropertySource.html#setName(java.lang.String)">setName</a>, <a href="BasePropertySource.html#setOrdinal(java.lang.Integer)">setOrdinal</a>, <a href="BasePropertySource.html#toString()">toString</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.org.apache.tamaya.spi.PropertySource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.tamaya.spi.<a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> |
| <code><a href="../../spi/PropertySource.html#addChangeListener(java.util.function.BiConsumer)">addChangeListener</a>, <a href="../../spi/PropertySource.html#getVersion()">getVersion</a>, <a href="../../spi/PropertySource.html#isScannable()">isScannable</a>, <a href="../../spi/PropertySource.html#removeAllChangeListeners()">removeAllChangeListeners</a>, <a href="../../spi/PropertySource.html#removeChangeListener(java.util.function.BiConsumer)">removeChangeListener</a></code></li> |
| </ul> |
| </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="DEFAULT_ORDINAL"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_ORDINAL</h4> |
| <pre>public static final int DEFAULT_ORDINAL</pre> |
| <div class="block">Default ordinal for <a href="EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><code>EnvironmentPropertySource</code></a></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.tamaya.spisupport.propertysource.EnvironmentPropertySource.DEFAULT_ORDINAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EnvironmentPropertySource</h4> |
| <pre>public EnvironmentPropertySource()</pre> |
| <div class="block">Creates a new instance. Also initializes the <code>prefix</code> and <code>disabled</code> properties |
| from the system-/ environment properties: |
| <pre> |
| tamaya.envprops.prefix |
| tamaya.envprops.disable |
| </pre></div> |
| </li> |
| </ul> |
| <a id="<init>(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EnvironmentPropertySource</h4> |
| <pre>public EnvironmentPropertySource​(int ordinal)</pre> |
| <div class="block">Creates a new instance using a fixed ordinal createValue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ordinal</code> - the ordinal number.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EnvironmentPropertySource</h4> |
| <pre>public EnvironmentPropertySource​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefix, |
| int ordinal)</pre> |
| <div class="block">Creates a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the prefix to be used, or null.</dd> |
| <dd><code>ordinal</code> - the ordinal to be used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EnvironmentPropertySource</h4> |
| <pre>public EnvironmentPropertySource​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefix)</pre> |
| <div class="block">Creates a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the prefix to be used, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getDefaultOrdinal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultOrdinal</h4> |
| <pre class="methodSignature">public int getDefaultOrdinal()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="BasePropertySource.html#getDefaultOrdinal()">BasePropertySource</a></code></span></div> |
| <div class="block">Returns the default ordinal used, when no ordinal is setCurrent, or the ordinal was not parseable to an int createValue.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#getDefaultOrdinal()">getDefaultOrdinal</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default ordinal used, by default 0.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</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> getName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../spi/PropertySource.html#getName()">PropertySource</a></code></span></div> |
| <div class="block">Get the name of the property source. The name should be unique for the type of source, whereas the id is used |
| to ensure unique identity, either locally or remotely.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../spi/PropertySource.html#getName()">getName</a></code> in interface <code><a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#getName()">getName</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration's name, never <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public <a href="../../spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../spi/PropertySource.html#get(java.lang.String)">PropertySource</a></code></span></div> |
| <div class="block">Access a property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../spi/PropertySource.html#get(java.lang.String)">get</a></code> in interface <code><a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#get(java.lang.String)">get</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| <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 value mapProperties, where <code>mapProperties.current(key) == value</code>, including also any metadata. In case a |
| value is null, simply return <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</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="../../spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>> getProperties()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../spi/PropertySource.html#getProperties()">PropertySource</a></code></span></div> |
| <div class="block">Access the current properties as Set. The resulting Map may not return all items accessible, e.g. |
| when the underlying storage does not support iteration of its entries. |
| <code>null</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding mapProperties, never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toStringValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toStringValues</h4> |
| <pre class="methodSignature">protected <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> toStringValues()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#toStringValues()">toStringValues</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPrefix()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefix</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> getPrefix()</pre> |
| </li> |
| </ul> |
| <a id="isDisabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisabled</h4> |
| <pre class="methodSignature">public boolean isDisabled()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#isDisabled()">isDisabled</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChangeSupport()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getChangeSupport</h4> |
| <pre class="methodSignature">public <a href="../../spi/ChangeSupport.html" title="enum in org.apache.tamaya.spi">ChangeSupport</a> getChangeSupport()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../spi/PropertySource.html#getChangeSupport()">PropertySource</a></code></span></div> |
| <div class="block">Get the support for reporting changes to property sources provided by this instance. This support |
| type should never change during a property source's lifetime.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../spi/PropertySource.html#getChangeSupport()">getChangeSupport</a></code> in interface <code><a href="../../spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="BasePropertySource.html#getChangeSupport()">getChangeSupport</a></code> in class <code><a href="BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the change support of this property source, not 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/EnvironmentPropertySource.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2014–2019 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
