http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1be99c52/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html new file mode 100644 index 0000000..9a39bea --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html @@ -0,0 +1,446 @@ +<!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>SimplePropertySource.Builder (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spisupport.propertysource.SimplePropertySource.Builder class"> +<meta name="keywords" content="withUuidName()"> +<meta name="keywords" content="withName()"> +<meta name="keywords" content="withOrdinal()"> +<meta name="keywords" content="withDefaultOrdinal()"> +<meta name="keywords" content="withProperties()"> +<meta name="keywords" content="withProperty()"> +<meta name="keywords" content="build()"> +<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="SimplePropertySource.Builder (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,"i7":10,"i8":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/SimplePropertySource.Builder.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/SimplePropertySource.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/SystemPropertySource.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/SimplePropertySource.Builder.html" target="_top">Frames</a></li> +<li><a href="SimplePropertySource.Builder.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a 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 SimplePropertySource.Builder" class="title">Class SimplePropertySource.Builder</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.SimplePropertySource.Builder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource</a></dd> +</dl> +<hr> +<br> +<pre>public static final class <span class="typeNameLabel">SimplePropertySource.Builder</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></pre> +<div class="block"><code>SimplePropertySource</code> builder static inner class.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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/spisupport/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#build--">build</a></span>()</code> +<div class="block">Returns a <code>SimplePropertySource</code> built from the parameters previously set.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withDefaultOrdinal-int-">withDefaultOrdinal</a></span>(int val)</code> +<div class="block">Sets the <code>defaultOrdinal</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withName-java.lang.String-">withName</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> val)</code> +<div class="block">Sets the <code>name</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withOrdinal-int-">withOrdinal</a></span>(int val)</code> +<div class="block">Sets the <code>ordinal</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withProperties-java.io.File-">withProperties</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> file)</code> +<div class="block">Reads the <code>properties</code> from the given resource and returns a reference + to this Builder so that the methods can be chained together.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withProperties-java.util.Map-">withProperties</a></span>(<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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> val)</code> +<div class="block">Sets the <code>properties</code> and returns a reference to this Builder so that the methods can be chained together.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withProperties-java.net.URL-">withProperties</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> resource)</code> +<div class="block">Reads the <code>properties</code> from the given resource and returns a reference + to this Builder so that the methods can be chained together.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withProperty-java.lang.String-java.lang.String-">withProperty</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, + <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> val)</code> +<div class="block">Sets the <code>properties</code> and returns a reference to this Builder so that the methods can be chained together.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html#withUuidName--">withUuidName</a></span>()</code> +<div class="block">Sets the <code>name</code> to a new UUID and returns a reference to this Builder so that the methods + can be chained together.</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/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#equals-java.lang.Object-"; title="class or interface in java.lang">equals</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#hashCode--"; title="class or interface in java.lang">hashCode</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#toString--"; title="class or interface in java.lang">toString</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-external=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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="withUuidName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withUuidName</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withUuidName()</pre> +<div class="block">Sets the <code>name</code> to a new UUID and returns a reference to this Builder so that the methods + can be chained together.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withName</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withName(<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> val)</pre> +<div class="block">Sets the <code>name</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>val</code> - the <code>name</code> to set, not null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withOrdinal-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withOrdinal</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withOrdinal(int val)</pre> +<div class="block">Sets the <code>ordinal</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>val</code> - the <code>ordinal</code> to set</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withDefaultOrdinal-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withDefaultOrdinal</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withDefaultOrdinal(int val)</pre> +<div class="block">Sets the <code>defaultOrdinal</code> and returns a reference to this Builder so that the methods + can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>val</code> - the <code>defaultOrdinal</code> to set</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withProperties-java.net.URL-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withProperties</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withProperties(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> resource)</pre> +<div class="block">Reads the <code>properties</code> from the given resource and returns a reference + to this Builder so that the methods can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resource</code> - the <code>resource</code> to read</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withProperties-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withProperties</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withProperties(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> file)</pre> +<div class="block">Reads the <code>properties</code> from the given resource and returns a reference + to this Builder so that the methods can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>file</code> - the <code>file</code> to read from (xml or properties format).</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withProperties-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withProperties</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withProperties(<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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> val)</pre> +<div class="block">Sets the <code>properties</code> and returns a reference to this Builder so that the methods can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>val</code> - the <code>properties</code> to set</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="withProperty-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withProperty</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> withProperty(<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, + <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> val)</pre> +<div class="block">Sets the <code>properties</code> and returns a reference to this Builder so that the methods can be chained together.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>val</code> - the <code>properties</code> to set</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this Builder</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource</a> build()</pre> +<div class="block">Returns a <code>SimplePropertySource</code> built from the parameters previously set.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>SimplePropertySource</code> built with parameters of this <code>SimplePropertySource.Builder</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/SimplePropertySource.Builder.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/SimplePropertySource.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/SystemPropertySource.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/SimplePropertySource.Builder.html" target="_top">Frames</a></li> +<li><a href="SimplePropertySource.Builder.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a 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/SimplePropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html new file mode 100644 index 0000000..28d93ba --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html @@ -0,0 +1,454 @@ +<!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>SimplePropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spisupport.propertysource.SimplePropertySource class"> +<meta name="keywords" content="newBuilder()"> +<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="SimplePropertySource (Apache Tamaya Base 0.4-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/SimplePropertySource.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/PropertiesResourcePropertySource.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/SimplePropertySource.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/SimplePropertySource.html" target="_top">Frames</a></li> +<li><a href="SimplePropertySource.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 SimplePropertySource" class="title">Class SimplePropertySource</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.SimplePropertySource</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">SimplePropertySource</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">Simple implementation of a <a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> for + simple property files and XML property files.</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/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></span></code> +<div class="block"><code>SimplePropertySource</code> builder static inner class.</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.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/SimplePropertySource.html#SimplePropertySource-java.io.File-">SimplePropertySource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> propertiesLocation)</code> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html#SimplePropertySource-java.lang.String-java.util.Map-">SimplePropertySource</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> name, + <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</code> +<div class="block">Creates a new Properties based PropertySource based on the given properties map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html#SimplePropertySource-java.lang.String-java.util.Map-int-">SimplePropertySource</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> name, + <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties, + int defaultOrdinal)</code> +<div class="block">Creates a new Properties based PropertySource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html#SimplePropertySource-java.lang.String-java.net.URL-">SimplePropertySource</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> name, + <a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> propertiesLocation)</code> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html#SimplePropertySource-java.net.URL-">SimplePropertySource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> propertiesLocation)</code> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</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/SimplePropertySource.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 <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.html#newBuilder--">newBuilder</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>, <a href="../../../../../org/apache/tamaya/spisupport/propertysource/BasePropertySource.html#toStringValues--">toStringValues</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="SimplePropertySource-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimplePropertySource</h4> +<pre>public SimplePropertySource(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> propertiesLocation)</pre> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>propertiesLocation</code> - the URL encoded location, not null.</dd> +</dl> +</li> +</ul> +<a name="SimplePropertySource-java.net.URL-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimplePropertySource</h4> +<pre>public SimplePropertySource(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> propertiesLocation)</pre> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>propertiesLocation</code> - the URL encoded location, not null.</dd> +</dl> +</li> +</ul> +<a name="SimplePropertySource-java.lang.String-java.util.Map-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimplePropertySource</h4> +<pre>public SimplePropertySource(<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> name, + <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties, + int defaultOrdinal)</pre> +<div class="block">Creates a new Properties based PropertySource.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the property source name, not null.</dd> +<dd><code>properties</code> - the properties, not null</dd> +<dd><code>defaultOrdinal</code> - the default ordinal</dd> +</dl> +</li> +</ul> +<a name="SimplePropertySource-java.lang.String-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimplePropertySource</h4> +<pre>public SimplePropertySource(<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> name, + <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</pre> +<div class="block">Creates a new Properties based PropertySource based on the given properties map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name, not null.</dd> +<dd><code>properties</code> - the properties, not null.</dd> +</dl> +</li> +</ul> +<a name="SimplePropertySource-java.lang.String-java.net.URL-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimplePropertySource</h4> +<pre>public SimplePropertySource(<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> name, + <a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> propertiesLocation)</pre> +<div class="block">Creates a new Properties based PropertySource based on the given URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The property source name</dd> +<dd><code>propertiesLocation</code> - the URL encoded location, not 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="newBuilder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newBuilder</h4> +<pre>public static <a href="../../../../../org/apache/tamaya/spisupport/propertysource/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource">SimplePropertySource.Builder</a> newBuilder()</pre> +</li> +</ul> +<a name="getProperties--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</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/SimplePropertySource.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/PropertiesResourcePropertySource.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/SimplePropertySource.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/SimplePropertySource.html" target="_top">Frames</a></li> +<li><a href="SimplePropertySource.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/SystemPropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/development/org/apache/tamaya/spisupport/propertysource/SystemPropertySource.html b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SystemPropertySource.html new file mode 100644 index 0000000..d25c442 --- /dev/null +++ b/apidocs/development/org/apache/tamaya/spisupport/propertysource/SystemPropertySource.html @@ -0,0 +1,524 @@ +<!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>SystemPropertySource (Apache Tamaya Base 0.4-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spisupport.propertysource.SystemPropertySource class"> +<meta name="keywords" content="DEFAULT_ORDINAL"> +<meta name="keywords" content="getName()"> +<meta name="keywords" content="get()"> +<meta name="keywords" content="getProperties()"> +<meta name="keywords" content="isScannable()"> +<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="SystemPropertySource (Apache Tamaya Base 0.4-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/SystemPropertySource.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/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/SystemPropertySource.html" target="_top">Frames</a></li> +<li><a href="SystemPropertySource.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 SystemPropertySource" class="title">Class SystemPropertySource</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.SystemPropertySource</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">SystemPropertySource</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">This <a href="../../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a> manages the system properties. 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/spisupport/propertysource/SystemPropertySource.html#DEFAULT_ORDINAL">DEFAULT_ORDINAL</a></span></code> +<div class="block">default ordinal used.</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/SystemPropertySource.html#SystemPropertySource--">SystemPropertySource</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/SystemPropertySource.html#SystemPropertySource-int-">SystemPropertySource</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/SystemPropertySource.html#SystemPropertySource-java.lang.String-">SystemPropertySource</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/SystemPropertySource.html#SystemPropertySource-java.lang.String-int-">SystemPropertySource</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/SystemPropertySource.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><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/SystemPropertySource.html#getName--">getName</a></span>()</code> +<div class="block">Get the name of the property source.</div> +</td> +</tr> +<tr id="i2" 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/SystemPropertySource.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Access the current properties as Set.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tamaya/spisupport/propertysource/SystemPropertySource.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="i4" 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/SystemPropertySource.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#getDefaultOrdinal--">getDefaultOrdinal</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/property source/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> +</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 used.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.tamaya.spisupport.propertysource.SystemPropertySource.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="SystemPropertySource--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SystemPropertySource</h4> +<pre>public SystemPropertySource()</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="SystemPropertySource-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SystemPropertySource</h4> +<pre>public SystemPropertySource(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="SystemPropertySource-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SystemPropertySource</h4> +<pre>public SystemPropertySource(<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="SystemPropertySource-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SystemPropertySource</h4> +<pre>public SystemPropertySource(<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="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="isScannable--"> +<!-- --> +</a> +<ul class="blockList"> +<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 might happen + if the underlying storage doesn't support listing. + </p></div> +<dl> +<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 cannot/should not be scanned.</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/SystemPropertySource.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/SimplePropertySource.Builder.html" title="class in org.apache.tamaya.spisupport.propertysource"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/tamaya/spisupport/propertysource/SystemPropertySource.html" target="_top">Frames</a></li> +<li><a href="SystemPropertySource.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>
