http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1be99c52/apidocs/development/org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html new file mode 100644 index 0000000..504e480 --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html @@ -0,0 +1,398 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BuildablePropertySourceProvider (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spisupport.propertysource.BuildablePropertySourceProvider class"> +<meta name="keywords" content="getPropertySources()"> +<meta name="keywords" content="equals()"> +<meta name="keywords" content="hashCode()"> +<meta name="keywords" content="toString()"> +<meta name="keywords" content="builder()"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BuildablePropertySourceProvider (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BuildablePropertySourceProvider.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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html" target="_top">Frames</a></li> +<li><a href="BuildablePropertySourceProvider.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tamaya.spisupport.propertysource</div> +<h2 title="Class BuildablePropertySourceProvider" class="title">Class BuildablePropertySourceProvider</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tamaya.spisupport.propertysource.BuildablePropertySourceProvider</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BuildablePropertySourceProvider</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a></pre> +<div class="block">A Buildable property source.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">BuildablePropertySourceProvider.Builder</a></span></code> +<div class="block">The type Builder.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.tamaya.spi.PropertySourceProvider"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.tamaya.spi.<a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a></h3> +<code><a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html#EMPTY">EMPTY</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#BuildablePropertySourceProvider--">BuildablePropertySourceProvider</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">BuildablePropertySourceProvider.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#builder--">builder</a></span>()</code> +<div class="block">Builder builder.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#getPropertySources--">getPropertySources</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BuildablePropertySourceProvider--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BuildablePropertySourceProvider</h4> +<pre>public BuildablePropertySourceProvider()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPropertySources--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertySources</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a>> getPropertySources()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html#getPropertySources--">getPropertySources</a></code> in interface <code><a href="../../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>For each e.g. property file, we return a single PropertySource + or an empty list if no PropertySource exists.</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="builder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>builder</h4> +<pre>public static <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">BuildablePropertySourceProvider.Builder</a> builder()</pre> +<div class="block">Builder builder.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the builder</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BuildablePropertySourceProvider.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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.html" target="_top">Frames</a></li> +<li><a href="BuildablePropertySourceProvider.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014–2017 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1be99c52/apidocs/development/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html new file mode 100644 index 0000000..f705edd --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html @@ -0,0 +1,409 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CLIPropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spisupport.propertysource.CLIPropertySource class"> +<meta name="keywords" content="initMainArgs()"> +<meta name="keywords" content="getProperties()"> +<meta name="keywords" content="toStringValues()"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CLIPropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CLIPropertySource.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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html" target="_top">Frames</a></li> +<li><a href="CLIPropertySource.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tamaya.spisupport.propertysource</div> +<h2 title="Class CLIPropertySource" class="title">Class CLIPropertySource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/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.CLIPropertySource</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CLIPropertySource</span> +extends <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></pre> +<div class="block">PropertySource that allows to add the programs main arguments as configuration entries. Unix syntax using '--' and + '-' params is supported.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.tamaya.spi.PropertySource"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.tamaya.spi.<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#EMPTY">EMPTY</a>, <a href="../../../../../org/apache/tamaya/spi/PropertySource.html#TAMAYA_ORDINAL">TAMAYA_ORDINAL</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#CLIPropertySource--">CLIPropertySource</a></span>()</code> +<div class="block">Creates a new instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#CLIPropertySource-int-java.lang.String...-">CLIPropertySource</a></span>(int ordinal, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> +<div class="block">Creates a new instance, allows optionally to pass the main arguments.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#CLIPropertySource-java.lang.String...-">CLIPropertySource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> +<div class="block">Creates a new instance, allows optionally to pass the main arguments.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Access the current properties as Set.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#initMainArgs-java.lang.String...-">initMainArgs</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> +<div class="block">Configure the main arguments, hereby parsing and mapping the main arguments into + configuration propertiesi as key-value pairs.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html#toStringValues--">toStringValues</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.spisupport.propertysource.BasePropertySource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tamaya.spisupport.propertysource.<a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#get-java.lang.String-">get</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getDefaultOrdinal--">getDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getName--">getName</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getOrdinal--">getOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#setDefaultOrdinal-java.lang.Integer-">setDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html# setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#setOrdinal-java.lang.Integer-">setOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.spi.PropertySource"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.tamaya.spi.<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">isScannable</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CLIPropertySource--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLIPropertySource</h4> +<pre>public CLIPropertySource()</pre> +<div class="block">Creates a new instance.</div> +</li> +</ul> +<a name="CLIPropertySource-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLIPropertySource</h4> +<pre>public CLIPropertySource(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> +<div class="block">Creates a new instance, allows optionally to pass the main arguments.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - the args, or null.</dd> +</dl> +</li> +</ul> +<a name="CLIPropertySource-int-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLIPropertySource</h4> +<pre>public CLIPropertySource(int ordinal, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> +<div class="block">Creates a new instance, allows optionally to pass the main arguments.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - the args, or null.</dd> +<dd><code>ordinal</code> - the ordinal to be applied.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initMainArgs-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initMainArgs</h4> +<pre>public static void initMainArgs(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> +<div class="block">Configure the main arguments, hereby parsing and mapping the main arguments into + configuration propertiesi as key-value pairs.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - the main arguments, not null.</dd> +</dl> +</li> +</ul> +<a name="getProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/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 map, never null.</dd> +</dl> +</li> +</ul> +<a name="toStringValues--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toStringValues</h4> +<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toStringValues()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#toStringValues--">toStringValues</a></code> in class <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CLIPropertySource.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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BuildablePropertySourceProvider.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html" target="_top">Frames</a></li> +<li><a href="CLIPropertySource.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014–2017 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1be99c52/apidocs/development/org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html new file mode 100644 index 0000000..86c39fe --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html @@ -0,0 +1,614 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>EnvironmentPropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<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()"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="EnvironmentPropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/JavaConfigurationPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html" target="_top">Frames</a></li> +<li><a href="EnvironmentPropertySource.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><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 name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tamaya.spisupport.propertysource</div> +<h2 title="Class EnvironmentPropertySource" class="title">Class EnvironmentPropertySource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/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><a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">EnvironmentPropertySource</span> +extends <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></pre> +<div class="block"><p><code>PropertySource</code> to access environment variables via Tamaya + which are set via <code>export VARIABLE=value</code> on UNIX systems or + <code>set VARIABLE=value</code> on Windows systems.</p> + + <p>Using the <a href="../../../../../org/apache/tamaya/spisupport/propertysource/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.get("OPS_MODE"); + PropertyValue color = ps.get("COLOR"); + </pre> + + <h1>Application specific environmet variables with prefix</h1> + + <p>Given the case where to 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="../../../../../org/apache/tamaya/spisupport/propertysource/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 tree 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 value can now be accessed from the code of the + application like this:</p> + + <pre> + PropertySource ps = new EnvironmentPropertySource(); + PropertyValue pv = ps.get("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 could be simply + disabled by the setting the systemproperty <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 =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#DEFAULT_ORDINAL">DEFAULT_ORDINAL</a></span></code> +<div class="block">Default ordinal for <a href="../../../../../org/apache/tamaya/spisupport/propertysource/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 name="fields.inherited.from.class.org.apache.tamaya.spi.PropertySource"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.tamaya.spi.<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#EMPTY">EMPTY</a>, <a href="../../../../../org/apache/tamaya/spi/PropertySource.html#TAMAYA_ORDINAL">TAMAYA_ORDINAL</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource--">EnvironmentPropertySource</a></span>()</code> +<div class="block">Creates a new instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource-int-">EnvironmentPropertySource</a></span>(int ordinal)</code> +<div class="block">Creates a new instance using a fixed ordinal value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource-java.lang.String-">EnvironmentPropertySource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code> +<div class="block">Creates a new instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource-java.lang.String-int-">EnvironmentPropertySource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, + int ordinal)</code> +<div class="block">Creates a new instance.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<div class="block">Access a property.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#getDefaultOrdinal--">getDefaultOrdinal</a></span>()</code> +<div class="block">Returns the default ordinal used, when no ordinal is set, or the ordinal was not parseable to an int value.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#getName--">getName</a></span>()</code> +<div class="block">Get the name of the property source.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#getPrefix--">getPrefix</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Access the current properties as Set.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#isDisabled--">isDisabled</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html#toStringValues--">toStringValues</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.spisupport.propertysource.BasePropertySource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tamaya.spisupport.propertysource.<a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getOrdinal--">getOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#setDefaultOrdinal-java.lang.Integer-">setDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#setOrdinal-java.lang.Integer-">setOrdinal</a>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.spi.PropertySource"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.tamaya.spi.<a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">isScannable</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="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="../../../../../org/apache/tamaya/spisupport/propertysource/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> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="EnvironmentPropertySource--"> +<!-- --> +</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 name="EnvironmentPropertySource-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 value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ordinal</code> - the ordinal number.</dd> +</dl> +</li> +</ul> +<a name="EnvironmentPropertySource-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EnvironmentPropertySource</h4> +<pre>public EnvironmentPropertySource(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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 name="EnvironmentPropertySource-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EnvironmentPropertySource</h4> +<pre>public EnvironmentPropertySource(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDefaultOrdinal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultOrdinal</h4> +<pre>public int getDefaultOrdinal()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getDefaultOrdinal--">BasePropertySource</a></code></span></div> +<div class="block">Returns the default ordinal used, when no ordinal is set, or the ordinal was not parseable to an int value.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getDefaultOrdinal--">getDefaultOrdinal</a></code> in class <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/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 name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/spi/PropertySource.html#getName--">getName</a></code> in interface <code><a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#getName--">getName</a></code> in class <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/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 name="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi">PropertyValue</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/spi/PropertySource.html#get-java.lang.String-">get</a></code> in interface <code><a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#get-java.lang.String-">get</a></code> in class <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/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 map, where <code>map.get(key) == value</code>, including also any metadata. In case a + value is null, simply return <code>null</code>.</dd> +</dl> +</li> +</ul> +<a name="getProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/tamaya/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="../../../../../org/apache/tamaya/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 map, never null.</dd> +</dl> +</li> +</ul> +<a name="toStringValues--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toStringValues</h4> +<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toStringValues()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#toStringValues--">toStringValues</a></code> in class <code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">BasePropertySource</a></code></dd> +</dl> +</li> +</ul> +<a name="getPrefix--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrefix</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrefix()</pre> +</li> +</ul> +<a name="isDisabled--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isDisabled</h4> +<pre>public boolean isDisabled()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="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"> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/spisupport/propertysource/JavaConfigurationPropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/EnvironmentPropertySource.html" target="_top">Frames</a></li> +<li><a href="EnvironmentPropertySource.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><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 name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014–2017 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
