http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cb3c154a/apidocs/org/apache/tamaya/core/propertysource/BasePropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/core/propertysource/BasePropertySource.html b/apidocs/org/apache/tamaya/core/propertysource/BasePropertySource.html new file mode 100644 index 0000000..c3e31aa --- /dev/null +++ b/apidocs/org/apache/tamaya/core/propertysource/BasePropertySource.html @@ -0,0 +1,597 @@ +<!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>BasePropertySource (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.core.propertysource.BasePropertySource class"> +<meta name="keywords" content="getName()"> +<meta name="keywords" content="setName()"> +<meta name="keywords" content="setOrdinal()"> +<meta name="keywords" content="setDefaultOrdinal()"> +<meta name="keywords" content="getOrdinal()"> +<meta name="keywords" content="getDefaultOrdinal()"> +<meta name="keywords" content="get()"> +<meta name="keywords" content="isScannable()"> +<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="BasePropertySource (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"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"; +</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/BasePropertySource.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>Prev Class</li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/propertysource/BasePropertySource.html" target="_top">Frames</a></li> +<li><a href="BasePropertySource.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.core.propertysource</div> +<h2 title="Class BasePropertySource" class="title">Class BasePropertySource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.core.propertysource.BasePropertySource</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/tamaya/core/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.core.propertysource">CLIPropertySource</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.core.propertysource">EnvironmentPropertySource</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.core.propertysource">SimplePropertySource</a>, <a href="../../../../../org/apache/tamaya/examples/custompropertysource/SimplePropertySource.html" title="class in org.apache.tamaya.examples.custompropertysource">SimplePropertySource</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/SystemPropertySource.html" title="class in org.apache.tamaya.core.propertysource">SystemPropertySource</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">BasePropertySource</span> +extends <a href="http://docs.oracle.com/javase/7/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/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></pre> +<div class="block">Abstract <a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> that allows to set a default ordinal that will be used, if no + ordinal is provided with the config.</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#BasePropertySource--">BasePropertySource</a></span>()</code> +<div class="block">Constructor, using a default ordinal of 0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#BasePropertySource-int-">BasePropertySource</a></span>(int defaultOrdinal)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#BasePropertySource-java.lang.String-">BasePropertySource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#BasePropertySource-java.lang.String-int-">BasePropertySource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + int defaultOrdinal)</code> +<div class="block">Constructor.</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/core/propertysource/BasePropertySource.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/7/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/core/propertysource/BasePropertySource.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/7/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/core/propertysource/BasePropertySource.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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#getOrdinal--">getOrdinal</a></span>()</code> +<div class="block">Lookup order: + TODO rethink whole default PropertySources and ordering: + TODO introduce default values or constants for ordinals + + System properties (ordinal 400) + Environment properties (ordinal 300) + JNDI values (ordinal 200) + Properties file values (/META-INF/applicationConfiguration.properties) (ordinal 100) + + + <b>Important Hints for custom implementations</b>: + + If a custom implementation should be invoked <b>before</b> the default implementations, use a value > 400 + + + If a custom implementation should be invoked <b>after</b> the default implementations, use a value < 100 + + + Reordering of the default order of the config-sources: + Example: If the properties file/s should be used <b>before</b> the other implementations, + you have to configure an ordinal > 400.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#isScannable--">isScannable</a></span>()</code> +<div class="block">Determines if this config source can be scanned for its list of properties.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setDefaultOrdinal-java.lang.Integer-">setDefaultOrdinal</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> defaultOrdinal)</code> +<div class="block">Allows to set the ordinal of this property source explcitly.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Sets the property source's (unique) name.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setOrdinal-java.lang.Integer-">setOrdinal</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> ordinal)</code> +<div class="block">Allows to set the ordinal of this property source explcitly.</div> +</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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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#getProperties--">getProperties</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="BasePropertySource-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BasePropertySource</h4> +<pre>protected BasePropertySource(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the (unique) property source name, not null.</dd> +</dl> +</li> +</ul> +<a name="BasePropertySource-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BasePropertySource</h4> +<pre>protected BasePropertySource(int defaultOrdinal)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>defaultOrdinal</code> - default ordinal that will be used, if no ordinal is provided with the config.</dd> +</dl> +</li> +</ul> +<a name="BasePropertySource-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BasePropertySource</h4> +<pre>protected BasePropertySource(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + int defaultOrdinal)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the (unique) property source name, not null.</dd> +<dd><code>defaultOrdinal</code> - default ordinal that will be used, if no ordinal is provided with the config.</dd> +</dl> +</li> +</ul> +<a name="BasePropertySource--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BasePropertySource</h4> +<pre>protected BasePropertySource()</pre> +<div class="block">Constructor, using a default ordinal of 0.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/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="returnLabel">Returns:</span></dt> +<dd>the configuration's name, never null.</dd> +</dl> +</li> +</ul> +<a name="setName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Sets the property source's (unique) name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name, not null.</dd> +</dl> +</li> +</ul> +<a name="setOrdinal-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOrdinal</h4> +<pre>public void setOrdinal(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> ordinal)</pre> +<div class="block">Allows to set the ordinal of this property source explcitly. This will override any evaluated + ordinal, or default ordinal. To reset an explcit ordinal call <code>setOrdinal(null);</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ordinal</code> - the explicit ordinal, or null.</dd> +</dl> +</li> +</ul> +<a name="setDefaultOrdinal-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultOrdinal</h4> +<pre>public void setDefaultOrdinal(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> defaultOrdinal)</pre> +<div class="block">Allows to set the ordinal of this property source explcitly. This will override any evaluated + ordinal, or default ordinal. To reset an explcit ordinal call <code>setOrdinal(null);</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>defaultOrdinal</code> - the default ordinal, or null.</dd> +</dl> +</li> +</ul> +<a name="getOrdinal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinal</h4> +<pre>public int getOrdinal()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#getOrdinal--">PropertySource</a></code></span></div> +<div class="block">Lookup order: + TODO rethink whole default PropertySources and ordering: + TODO introduce default values or constants for ordinals + <ol> + <li>System properties (ordinal 400)</li> + <li>Environment properties (ordinal 300)</li> + <li>JNDI values (ordinal 200)</li> + <li>Properties file values (/META-INF/applicationConfiguration.properties) (ordinal 100)</li> + </ol> + + <p><b>Important Hints for custom implementations</b>:</p> + <p> + If a custom implementation should be invoked <b>before</b> the default implementations, use a value > 400 + </p> + <p> + If a custom implementation should be invoked <b>after</b> the default implementations, use a value < 100 + </p> + + <p>Reordering of the default order of the config-sources:</p> + <p>Example: If the properties file/s should be used <b>before</b> the other implementations, + you have to configure an ordinal > 400. That means, you have to add e.g. deltaspike_ordinal=401 to + /META-INF/apache-deltaspike.properties . Hint: In case of property files every file is handled as independent + config-source, but all of them have ordinal 400 by default (and can be reordered in a fine-grained manner.</p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#getOrdinal--">getOrdinal</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="returnLabel">Returns:</span></dt> +<dd>the 'importance' aka ordinal of the configured values. The higher, the more important. + //X TODO think about making this a default method which returns default priority</dd> +</dl> +</li> +</ul> +<a name="getDefaultOrdinal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultOrdinal</h4> +<pre>public int getDefaultOrdinal()</pre> +<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="returnLabel">Returns:</span></dt> +<dd>the default ordinal used, by default 0.</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/7/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="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the property's key, not null.</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="isScannable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isScannable</h4> +<pre>public boolean isScannable()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">PropertySource</a></code></span></div> +<div class="block">Determines if this config source can be scanned for its list of properties. + + <p> + PropertySources which are not scannable might not be able to find all the + configured values to provide via <a href="../../../../../org/apache/tamaya/spi/PropertySource.html#getProperties--"><code>PropertySource.getProperties()</code></a>. This can e.g. happen + if the underlying storage doesn't support listing. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">isScannable</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="returnLabel">Returns:</span></dt> +<dd><code>true</code> if this PropertySource can be scanned for its list of properties, + <code>false</code> if it should not be scanned.</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/BasePropertySource.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>Prev Class</li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/propertysource/BasePropertySource.html" target="_top">Frames</a></li> +<li><a href="BasePropertySource.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–2016 <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/cb3c154a/apidocs/org/apache/tamaya/core/propertysource/CLIPropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/core/propertysource/CLIPropertySource.html b/apidocs/org/apache/tamaya/core/propertysource/CLIPropertySource.html new file mode 100644 index 0000000..b9eb218 --- /dev/null +++ b/apidocs/org/apache/tamaya/core/propertysource/CLIPropertySource.html @@ -0,0 +1,383 @@ +<!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.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.core.propertysource.CLIPropertySource class"> +<meta name="keywords" content="initMainArgs()"> +<meta name="keywords" content="getProperties()"> +<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.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9}; +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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/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.core.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/7/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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">org.apache.tamaya.core.propertysource.BasePropertySource</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tamaya.core.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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.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/core/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/core/propertysource/CLIPropertySource.html#CLIPropertySource-int-java.lang.String...-">CLIPropertySource</a></span>(int ordinal, + <a href="http://docs.oracle.com/javase/7/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/core/propertysource/CLIPropertySource.html#CLIPropertySource-java.lang.String...-">CLIPropertySource</a></span>(<a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/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/core/propertysource/CLIPropertySource.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Access the current properties as Map.</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/core/propertysource/CLIPropertySource.html#initMainArgs-java.lang.String...-">initMainArgs</a></span>(<a href="http://docs.oracle.com/javase/7/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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.core.propertysource.BasePropertySource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tamaya.core.propertysource.<a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#get-java.lang.String-">get</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#getDefaultOrdinal--">getDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#getName--">getName</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#getOrdinal--">getOrdinal</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#isScannable--">isScannable</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setDefaultOrdinal-java.lang.Integer-">setDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setOrdinal-java.lang.Integer-">setOrdina l</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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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="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/7/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/7/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/7/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="blockListLast"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</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 Map. The resulting Map may not return all items accessible, e.g. + when the underlying storage does not support iteration of its entries.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the a corresponding map, never null.</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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/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–2016 <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/cb3c154a/apidocs/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html b/apidocs/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html new file mode 100644 index 0000000..2ccb237 --- /dev/null +++ b/apidocs/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html @@ -0,0 +1,536 @@ +<!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.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.core.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="isScannable()"> +<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.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/core/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/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.core.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/7/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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">org.apache.tamaya.core.propertysource.BasePropertySource</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tamaya.core.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/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></pre> +<div class="block">This <a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> provides all Properties which are set + via + <code>export myprop=myval</code> on UNIX Systems or + <code>set myprop=myval</code> on Windows. You can disable this feature by setting <code>tamaya.envprops.disable</code> + or <code>tamaya.defaults.disable</code>.</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/core/propertysource/EnvironmentPropertySource.html#DEFAULT_ORDINAL">DEFAULT_ORDINAL</a></span></code> +<div class="block">Default ordinal for <a href="../../../../../org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.core.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/core/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/core/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/core/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource-java.lang.String-">EnvironmentPropertySource</a></span>(<a href="http://docs.oracle.com/javase/7/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/core/propertysource/EnvironmentPropertySource.html#EnvironmentPropertySource-java.lang.String-int-">EnvironmentPropertySource</a></span>(<a href="http://docs.oracle.com/javase/7/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/core/propertysource/EnvironmentPropertySource.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/7/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/core/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/7/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/core/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/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/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/core/propertysource/EnvironmentPropertySource.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Access the current properties as Map.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/core/propertysource/EnvironmentPropertySource.html#isScannable--">isScannable</a></span>()</code> +<div class="block">Determines if this config source can be scanned for its list of properties.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.tamaya.core.propertysource.BasePropertySource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tamaya.core.propertysource.<a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></h3> +<code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#getOrdinal--">getOrdinal</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setDefaultOrdinal-java.lang.Integer-">setDefaultOrdinal</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html#setOrdinal-java.lang.Integer-">setOrdinal</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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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"> +<!-- ============ 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/core/propertysource/EnvironmentPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><code>EnvironmentPropertySource</code></a></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.tamaya.core.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/7/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/7/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/core/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/core/propertysource/BasePropertySource.html#getDefaultOrdinal--">getDefaultOrdinal</a></code> in class <code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.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/7/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/core/propertysource/BasePropertySource.html#getName--">getName</a></code> in class <code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the configuration's name, never null.</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/7/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/core/propertysource/BasePropertySource.html#get-java.lang.String-">get</a></code> in class <code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the property's key, not null.</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/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</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 Map. The resulting Map may not return all items accessible, e.g. + when the underlying storage does not support iteration of its entries.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the a corresponding map, never null.</dd> +</dl> +</li> +</ul> +<a name="isScannable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isScannable</h4> +<pre>public boolean isScannable()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">PropertySource</a></code></span></div> +<div class="block">Determines if this config source can be scanned for its list of properties. + + <p> + PropertySources which are not scannable might not be able to find all the + configured values to provide via <a href="../../../../../org/apache/tamaya/spi/PropertySource.html#getProperties--"><code>PropertySource.getProperties()</code></a>. This can e.g. happen + if the underlying storage doesn't support listing. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/tamaya/spi/PropertySource.html#isScannable--">isScannable</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/core/propertysource/BasePropertySource.html#isScannable--">isScannable</a></code> in class <code><a href="../../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if this PropertySource can be scanned for its list of properties, + <code>false</code> if it should not be scanned.</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/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/core/propertysource/CLIPropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/tamaya/core/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.core.propertysource"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/core/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–2016 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>