http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cb3c154a/apidocs/org/apache/tamaya/spi/FilterContext.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/FilterContext.html b/apidocs/org/apache/tamaya/spi/FilterContext.html new file mode 100644 index 0000000..ab58bfa --- /dev/null +++ b/apidocs/org/apache/tamaya/spi/FilterContext.html @@ -0,0 +1,380 @@ +<!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>FilterContext (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spi.FilterContext class"> +<meta name="keywords" content="getKey()"> +<meta name="keywords" content="isSinglePropertyScoped()"> +<meta name="keywords" content="getConfigEntries()"> +<meta name="keywords" content="toString()"> +<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="FilterContext (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/FilterContext.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/spi/Experimental.html" title="annotation in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/FilterContext.html" target="_top">Frames</a></li> +<li><a href="FilterContext.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.spi</div> +<h2 title="Class FilterContext" class="title">Class FilterContext</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.spi.FilterContext</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FilterContext</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></pre> +<div class="block">A filter context containing all the required values for implementing filtering.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/tamaya/spi/PropertyFilter.html" title="interface in org.apache.tamaya.spi"><code>PropertyFilter</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/spi/FilterContext.html#FilterContext-java.lang.String-java.util.Map-boolean-">FilterContext</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, + <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>> configEntries, + boolean singlePropertyScope)</code> +<div class="block">Creates a new FilterContext.</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="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/spi/FilterContext.html#getConfigEntries--">getConfigEntries</a></span>()</code> +<div class="block">This map contains the following keys: + + the original value <b>before</b> any filters were applied on it.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<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/spi/FilterContext.html#getKey--">getKey</a></span>()</code> +<div class="block">Get the key accessed.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/FilterContext.html#isSinglePropertyScoped--">isSinglePropertyScoped</a></span>()</code> +<div class="block">Method that determines if filtering is done for a single property accessed, or as part of call to + <code>getProperties()</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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/spi/FilterContext.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/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#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="FilterContext-java.lang.String-java.util.Map-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilterContext</h4> +<pre>public FilterContext(<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, + <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>> configEntries, + boolean singlePropertyScope)</pre> +<div class="block">Creates a new FilterContext.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the key under evaluation, not null.</dd> +<dd><code>singlePropertyScope</code> - true, if the filtering is done only for one single property accessed explcitily.</dd> +<dd><code>configEntries</code> - the raw configuration data available in the current evaluation context, 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="getKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</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> getKey()</pre> +<div class="block">Get the key accessed. This information is very useful to evaluate additional metadata needed to determine/ + control further aspects of the conversion.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the key. This may be null in case where a default value has to be converted and no unique underlying + key/value configuration is present.</dd> +</dl> +</li> +</ul> +<a name="isSinglePropertyScoped--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSinglePropertyScoped</h4> +<pre>public boolean isSinglePropertyScoped()</pre> +<div class="block">Method that determines if filtering is done for a single property accessed, or as part of call to + <code>getProperties()</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true, if its scoped to a single property accessed.</dd> +</dl> +</li> +</ul> +<a name="getConfigEntries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigEntries</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>> getConfigEntries()</pre> +<div class="block">This map contains the following keys: + <ul> + <li>the original value <b>before</b> any filters were applied on it.</li> + <li>all values starting with an <code>_<key>.</code>, for example <code>a.value</code> + may have a map set with <code>a.value</code> (oringinal value), <code>_a.value.origin, + _a.value.type, etc</code>. The exact contents is determine by the <a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a>s + active.</li> + </ul> + Also important to know is that this map given contains all the evaluated raw entries, regardless + of the filters that are later applied. This ensures that met-information required by one filter is + not hidden by another filter, because of an invalid filter ordering. In other words filters may remove + key/value pairs, e.g. fir security reasons, by returning <code>null</code>, but the values in the raw map + passed as input to the filter process will not be affected by any such removal (but the final properties + returned are affected, of course). + + Finally, when a single property is accessed, e.g. by calling <code>Configuration.get(String)</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the configuration instance, or null.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</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> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></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/FilterContext.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/spi/Experimental.html" title="annotation in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/FilterContext.html" target="_top">Frames</a></li> +<li><a href="FilterContext.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/spi/PropertyConverter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/PropertyConverter.html b/apidocs/org/apache/tamaya/spi/PropertyConverter.html new file mode 100644 index 0000000..24a2154 --- /dev/null +++ b/apidocs/org/apache/tamaya/spi/PropertyConverter.html @@ -0,0 +1,252 @@ +<!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>PropertyConverter (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spi.PropertyConverter interface"> +<meta name="keywords" content="convert()"> +<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="PropertyConverter (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PropertyConverter.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/spi/FilterContext.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyFilter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertyConverter.html" target="_top">Frames</a></li> +<li><a href="PropertyConverter.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.spi</div> +<h2 title="Interface PropertyConverter" class="title">Interface PropertyConverter<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the type of the type literal</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/tamaya/core/internal/converters/BigDecimalConverter.html" title="class in org.apache.tamaya.core.internal.converters">BigDecimalConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/BigIntegerConverter.html" title="class in org.apache.tamaya.core.internal.converters">BigIntegerConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/BooleanConverter.html" title="class in org.apache.tamaya.core.internal.converters">BooleanConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/ByteConverter.html" title="class in org.apache.tamaya.core.internal.converters">ByteConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/CharConverter.html" title="class in org.apache.tamaya.core.internal.converters">CharConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/ClassConverter.html" title="class in org.apache.tamaya.core.internal.converters">Cla ssConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/CurrencyConverter.html" title="class in org.apache.tamaya.core.internal.converters">CurrencyConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/DoubleConverter.html" title="class in org.apache.tamaya.core.internal.converters">DoubleConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/EnumConverter.html" title="class in org.apache.tamaya.core.internal.converters">EnumConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/FileConverter.html" title="class in org.apache.tamaya.core.internal.converters">FileConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/FloatConverter.html" title="class in org.apache.tamaya.core.internal.converters">FloatConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/IntegerConverter.html" title="class in org.apache.tamaya.core.internal.converters">Inte gerConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/LongConverter.html" title="class in org.apache.tamaya.core.internal.converters">LongConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/NumberConverter.html" title="class in org.apache.tamaya.core.internal.converters">NumberConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/PathConverter.html" title="class in org.apache.tamaya.core.internal.converters">PathConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/ShortConverter.html" title="class in org.apache.tamaya.core.internal.converters">ShortConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/URIConverter.html" title="class in org.apache.tamaya.core.internal.converters">URIConverter</a>, <a href="../../../../org/apache/tamaya/core/internal/converters/URLConverter.html" title="class in org.apache.tamaya.core.internal.converters">URLConverter</a>< /dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">PropertyConverter<T></span></pre> +<div class="block">Interface for an property that converts a configured String into something else. + This is used for implementing type conversion from a property (String) to a certain target + type. Hereby the target type can be multivalued (e.g. collections) or complex if needed.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/PropertyConverter.html" title="type parameter in PropertyConverter">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/PropertyConverter.html#convert-java.lang.String-org.apache.tamaya.spi.ConversionContext-">convert</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> value, + <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi">ConversionContext</a> context)</code> +<div class="block">Convert the given configuration keys from its String representation into the required target type.</div> +</td> +</tr> +</table> +</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="convert-java.lang.String-org.apache.tamaya.spi.ConversionContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>convert</h4> +<pre><a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="type parameter in PropertyConverter">T</a> convert(<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> value, + <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi">ConversionContext</a> context)</pre> +<div class="block">Convert the given configuration keys from its String representation into the required target type. + The context instance passed also allows to add a list of supported formats, which is very handy in case a + value could not be converted. This list of supported formats can then shown to the user to give some hints + how a value could be configured.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - configuration key that needs to be converted</dd> +<dd><code>context</code> - the <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi"><code>ConversionContext</code></a>, containing the String value and the requested configuration key.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>converted keys</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#addSupportedFormats-java.lang.Class-java.lang.String...-"><code>ConversionContext.addSupportedFormats(Class, String...)</code></a></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/PropertyConverter.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/spi/FilterContext.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyFilter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertyConverter.html" target="_top">Frames</a></li> +<li><a href="PropertyConverter.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–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/spi/PropertyFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/PropertyFilter.html b/apidocs/org/apache/tamaya/spi/PropertyFilter.html new file mode 100644 index 0000000..707398d --- /dev/null +++ b/apidocs/org/apache/tamaya/spi/PropertyFilter.html @@ -0,0 +1,250 @@ +<!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>PropertyFilter (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spi.PropertyFilter interface"> +<meta name="keywords" content="filterProperty()"> +<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="PropertyFilter (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PropertyFilter.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/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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.spi</div> +<h2 title="Interface PropertyFilter" class="title">Interface PropertyFilter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">PropertyFilter</span></pre> +<div class="block"><p>Interface for filtering the current map of properties during the evaluation of the chain of PropertySources. + Filters can be registered using the <a href="../../../../org/apache/tamaya/spi/ServiceContext.html" title="interface in org.apache.tamaya.spi"><code>ServiceContext</code></a>. The ordinal + hereby is defined by the corresponding <code>@Priority</code> annotation.</p> + <p>Filters </p></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/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/spi/PropertyFilter.html#filterProperty-java.lang.String-org.apache.tamaya.spi.FilterContext-">filterProperty</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> value, + <a href="../../../../org/apache/tamaya/spi/FilterContext.html" title="class in org.apache.tamaya.spi">FilterContext</a> context)</code> +<div class="block">Maps the current <code>valueToBeFiltered</code> value to a new value.</div> +</td> +</tr> +</table> +</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="filterProperty-java.lang.String-org.apache.tamaya.spi.FilterContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filterProperty</h4> +<pre><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> filterProperty(<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> value, + <a href="../../../../org/apache/tamaya/spi/FilterContext.html" title="class in org.apache.tamaya.spi">FilterContext</a> context)</pre> +<div class="block"><p>Maps the current <code>valueToBeFiltered</code> value to a new value. The resulting value will be used as the result + passed to the user.</p> + <p>If a filter is currently not available, it should just pass the input map to the method's + output.</p> + <p>Returning <code>null</code> will remove the entry.</p> + <h3>Implementation specification</h3> + Implementations of this class must be + <ul> + <li>reentrant</li> + <li>thread-safe</li> + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the value to be filtered, which also can be <code>null</code> if removed by another filter.</dd> +<dd><code>context</code> - the filter context, not null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the filtered value, or <code>null</code> if the value should be removed alltogether.</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/PropertyFilter.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/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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–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/spi/PropertySource.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/PropertySource.html b/apidocs/org/apache/tamaya/spi/PropertySource.html new file mode 100644 index 0000000..58cd93c --- /dev/null +++ b/apidocs/org/apache/tamaya/spi/PropertySource.html @@ -0,0 +1,453 @@ +<!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>PropertySource (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spi.PropertySource interface"> +<meta name="keywords" content="TAMAYA_ORDINAL"> +<meta name="keywords" content="EMPTY"> +<meta name="keywords" content="getOrdinal()"> +<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="PropertySource (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PropertySource.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/spi/PropertyFilter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertySource.html" target="_top">Frames</a></li> +<li><a href="PropertySource.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tamaya.spi</div> +<h2 title="Interface PropertySource" class="title">Interface PropertySource</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/tamaya/core/propertysource/BasePropertySource.html" title="class in org.apache.tamaya.core.propertysource">BasePropertySource</a>, <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.propertysourc e">SystemPropertySource</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">PropertySource</span></pre> +<div class="block"><p>This interface models a provider that serves configuration properties. The contained + properties may be read fromMap single or several sources (composite). + PropertySources are the building blocks of the final configuration. </p> + <h3>Implementation Requirements</h3> + <p>Implementations of this interface must be</p> + <ul> + <li>Thread safe.</li> + </ul> + + <p>A PropertySourceProvider will get picked up via the + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a> mechanism and can be registered via + META-INF/services/org.apache.tamaya.spi.PropertySource + </p> + <p> + If you like to register multiple PropertySources at the same time + you can use the <a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi"><code>PropertySourceProvider</code></a> + interface. + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/PropertySource.html#EMPTY">EMPTY</a></span></code> +<div class="block">A resusable instance of an empty PropertySource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/spi/PropertySource.html#TAMAYA_ORDINAL">TAMAYA_ORDINAL</a></span></code> +<div class="block">property name to override default tamaya ordinals</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/spi/PropertySource.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><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/spi/PropertySource.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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/PropertySource.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="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/spi/PropertySource.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/spi/PropertySource.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> +</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="TAMAYA_ORDINAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAMAYA_ORDINAL</h4> +<pre>static final <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> TAMAYA_ORDINAL</pre> +<div class="block">property name to override default tamaya ordinals</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.tamaya.spi.PropertySource.TAMAYA_ORDINAL">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="EMPTY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY</h4> +<pre>static final <a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a> EMPTY</pre> +<div class="block">A resusable instance of an empty PropertySource.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getOrdinal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinal</h4> +<pre>int getOrdinal()</pre> +<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="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="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><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">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="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><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">Access a property.</div> +<dl> +<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><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">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>boolean isScannable()</pre> +<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>getProperties()</code></a>. This can e.g. 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 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/PropertySource.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/spi/PropertyFilter.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertySource.html" target="_top">Frames</a></li> +<li><a href="PropertySource.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a 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/spi/PropertySourceProvider.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/PropertySourceProvider.html b/apidocs/org/apache/tamaya/spi/PropertySourceProvider.html new file mode 100644 index 0000000..127415a --- /dev/null +++ b/apidocs/org/apache/tamaya/spi/PropertySourceProvider.html @@ -0,0 +1,284 @@ +<!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>PropertySourceProvider (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> +<meta name="keywords" content="org.apache.tamaya.spi.PropertySourceProvider interface"> +<meta name="keywords" content="EMPTY"> +<meta name="keywords" content="getPropertySources()"> +<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="PropertySourceProvider (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PropertySourceProvider.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/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertySourceProvider.html" target="_top">Frames</a></li> +<li><a href="PropertySourceProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tamaya.spi</div> +<h2 title="Interface PropertySourceProvider" class="title">Interface PropertySourceProvider</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/tamaya/core/provider/JavaConfigurationProvider.html" title="class in org.apache.tamaya.core.provider">JavaConfigurationProvider</a>, <a href="../../../../org/apache/tamaya/examples/custompropertysource/SimplePropertySourceProvider.html" title="class in org.apache.tamaya.examples.custompropertysource">SimplePropertySourceProvider</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">PropertySourceProvider</span></pre> +<div class="block"><p>Implement this interfaces to provide a PropertySource provider which + is able to register multiple PropertySources. This is e.g. needed if + there are multiple property files of a given config file name.</p> + + <p>If a PropertySource like JNDI only exists once, then there is no need + to implement it via the PropertySourceProvider but should directly + expose a <a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><code>PropertySource</code></a>.</p> + + <p>A PropertySourceProvider will get picked up via the + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a> mechanism and must get registered via + META-INF/services/org.apache.tamaya.spi.PropertySourceProvider</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html#EMPTY">EMPTY</a></span></code> +<div class="block">A resusable instance of an empty PropertySource.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html#getPropertySources--">getPropertySources</a></span>()</code> </td> +</tr> +</table> +</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="EMPTY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY</h4> +<pre>static final <a href="../../../../org/apache/tamaya/spi/PropertySourceProvider.html" title="interface in org.apache.tamaya.spi">PropertySourceProvider</a> EMPTY</pre> +<div class="block">A resusable instance of an empty PropertySource.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPropertySources--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPropertySources</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/tamaya/spi/PropertySource.html" title="interface in org.apache.tamaya.spi">PropertySource</a>> getPropertySources()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>For each e.g. property file, we return a single PropertySource + or an empty list if no PropertySource exists.</dd> +</dl> +</li> +</ul> +</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/PropertySourceProvider.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/spi/PropertySource.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tamaya/spi/PropertyValue.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tamaya/spi/PropertySourceProvider.html" target="_top">Frames</a></li> +<li><a href="PropertySourceProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a 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>