http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/f1085b9b/apidocs/org/apache/tamaya/spi/ConfigurationProviderSpi.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/ConfigurationProviderSpi.html b/apidocs/org/apache/tamaya/spi/ConfigurationProviderSpi.html deleted file mode 100644 index 1581286..0000000 --- a/apidocs/org/apache/tamaya/spi/ConfigurationProviderSpi.html +++ /dev/null @@ -1,423 +0,0 @@ -<!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>ConfigurationProviderSpi (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> -<meta name="keywords" content="org.apache.tamaya.spi.ConfigurationProviderSpi interface"> -<meta name="keywords" content="getConfiguration()"> -<meta name="keywords" content="createConfiguration()"> -<meta name="keywords" content="getConfigurationContextBuilder()"> -<meta name="keywords" content="setConfiguration()"> -<meta name="keywords" content="isConfigurationSettable()"> -<meta name="keywords" content="getConfigurationContext()"> -<meta name="keywords" content="setConfigurationContext()"> -<meta name="keywords" content="isConfigurationContextSettable()"> -<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="ConfigurationProviderSpi (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":38,"i3":6,"i4":38,"i5":6,"i6":6,"i7":38}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/ConfigurationProviderSpi.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/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/ConversionContext.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/ConfigurationProviderSpi.html" target="_top">Frames</a></li> -<li><a href="ConfigurationProviderSpi.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 ConfigurationProviderSpi" class="title">Interface ConfigurationProviderSpi</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/internal/DefaultConfigurationProvider.html" title="class in org.apache.tamaya.core.internal">DefaultConfigurationProvider</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="typeNameLabel">ConfigurationProviderSpi</span></pre> -<div class="block">SPI that must be implemented to provide the component that manages all <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> - instances in a system. In SE this may be a true singleton containing exact one <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> - instance, whereas in Java EE and other more complex environments instances may be returned depending the current - runtime context.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#createConfiguration-org.apache.tamaya.spi.ConfigurationContext-">createConfiguration</a></span>(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> context)</code> -<div class="block">Create a <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> instance using the given context.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#getConfiguration--">getConfiguration</a></span>()</code> -<div class="block">Access the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#getConfigurationContext--">getConfigurationContext</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">Will be removed in favour of <a href="../../../../org/apache/tamaya/Configuration.html#getContext--"><code>Configuration.getContext()</code></a>.</span></div> -</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationContextBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#getConfigurationContextBuilder--">getConfigurationContextBuilder</a></span>()</code> -<div class="block">Creates a new <a href="../../../../org/apache/tamaya/spi/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContextBuilder</code></a> instance.</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/ConfigurationProviderSpi.html#isConfigurationContextSettable--">isConfigurationContextSettable</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#isConfigurationSettable--"><code>isConfigurationSettable()</code></a></span></div> -</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#isConfigurationSettable--">isConfigurationSettable</a></span>()</code> -<div class="block">Method that allows to determine if a new <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> can be applied - programmatically.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfiguration-org.apache.tamaya.Configuration-">setConfiguration</a></span>(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config)</code> -<div class="block">This method allows to replace the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new - instance.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-">setConfigurationContext</a></span>(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> context)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfiguration-org.apache.tamaya.Configuration-"><code>setConfiguration(Configuration)</code></a></span></div> -</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="getConfiguration--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getConfiguration</h4> -<pre><a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> getConfiguration()</pre> -<div class="block">Access the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> instance, never null.</dd> -</dl> -</li> -</ul> -<a name="createConfiguration-org.apache.tamaya.spi.ConfigurationContext-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>createConfiguration</h4> -<pre><a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> createConfiguration(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> context)</pre> -<div class="block">Create a <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> instance using the given context. The configuration - created hereby must respect the artifacts provided by its context (property sources, - filters, converters, policies etc), including their ordering and significance.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>context</code> - the context to be used, not null.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the corresponding configuration instance.</dd> -</dl> -</li> -</ul> -<a name="getConfigurationContextBuilder--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getConfigurationContextBuilder</h4> -<pre><a href="../../../../org/apache/tamaya/spi/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi">ConfigurationContextBuilder</a> getConfigurationContextBuilder()</pre> -<div class="block">Creates a new <a href="../../../../org/apache/tamaya/spi/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContextBuilder</code></a> instance.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new <a href="../../../../org/apache/tamaya/spi/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContextBuilder</code></a>, never null.</dd> -</dl> -</li> -</ul> -<a name="setConfiguration-org.apache.tamaya.Configuration-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setConfiguration</h4> -<pre>void setConfiguration(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> config)</pre> -<div class="block">This method allows to replace the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> with a new - instance. This can be used to update the configuration with a new one, e.g. because some of the - data has changed and must be updated. It is the responsibility of the ConfigurationProvider to trigger - corresponding update events for the current <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>config</code> - the new Configuration to be applied.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the current provider is read-only.</dd> -</dl> -</li> -</ul> -<a name="isConfigurationSettable--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isConfigurationSettable</h4> -<pre>boolean isConfigurationSettable()</pre> -<div class="block">Method that allows to determine if a new <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a> can be applied - programmatically.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true, if <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfiguration-org.apache.tamaya.Configuration-"><code>setConfiguration(org.apache.tamaya.Configuration)</code></a> is supported - by the current implementation.</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfiguration-org.apache.tamaya.Configuration-"><code>setConfiguration(org.apache.tamaya.Configuration)</code></a></dd> -</dl> -</li> -</ul> -<a name="getConfigurationContext--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getConfigurationContext</h4> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> getConfigurationContext()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Will be removed in favour of <a href="../../../../org/apache/tamaya/Configuration.html#getContext--"><code>Configuration.getContext()</code></a>.</span></div> -<div class="block">Get access to the current <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContext</code></a>.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the current <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContext</code></a>, never null.</dd> -</dl> -</li> -</ul> -<a name="setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setConfigurationContext</h4> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -void setConfigurationContext(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> context)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfiguration-org.apache.tamaya.Configuration-"><code>setConfiguration(Configuration)</code></a></span></div> -<div class="block">This method allows to replace the current <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContext</code></a> with a new - instance. This can be used to update the context with a new one, e.g. because some of the configuration - data has changed and must be updated. It is the responsibility of the ConfigurationProvider to trigger - corresponding update event for the current <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContext</code></a> or - <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya"><code>Configuration</code></a>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>context</code> - the new ConfigurationContext to be applied.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the current provider is read-only.</dd> -</dl> -</li> -</ul> -<a name="isConfigurationContextSettable--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>isConfigurationContextSettable</h4> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -boolean isConfigurationContextSettable()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#isConfigurationSettable--"><code>isConfigurationSettable()</code></a></span></div> -<div class="block">Method that allows to determine if a new <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi"><code>ConfigurationContext</code></a> can be applied - programmatically.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true, if <a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-"><code>setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)</code></a> is supported - by the current implementation.</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../org/apache/tamaya/spi/ConfigurationProviderSpi.html#setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-"><code>setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)</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/ConfigurationProviderSpi.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/ConfigurationContextBuilder.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/ConversionContext.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/ConfigurationProviderSpi.html" target="_top">Frames</a></li> -<li><a href="ConfigurationProviderSpi.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/f1085b9b/apidocs/org/apache/tamaya/spi/ConversionContext.Builder.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/ConversionContext.Builder.html b/apidocs/org/apache/tamaya/spi/ConversionContext.Builder.html deleted file mode 100644 index e920c29..0000000 --- a/apidocs/org/apache/tamaya/spi/ConversionContext.Builder.html +++ /dev/null @@ -1,480 +0,0 @@ -<!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>ConversionContext.Builder (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> -<meta name="keywords" content="org.apache.tamaya.spi.ConversionContext.Builder class"> -<meta name="keywords" content="setKey()"> -<meta name="keywords" content="setConfiguration()"> -<meta name="keywords" content="setConfigurationContext()"> -<meta name="keywords" content="setAnnotatedElement()"> -<meta name="keywords" content="addSupportedFormats()"> -<meta name="keywords" content="build()"> -<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="ConversionContext.Builder (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; -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/ConversionContext.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/spi/ConversionContext.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/Experimental.html" title="annotation 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/ConversionContext.Builder.html" target="_top">Frames</a></li> -<li><a href="ConversionContext.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><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 ConversionContext.Builder" class="title">Class ConversionContext.Builder</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.ConversionContext.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/spi/ConversionContext.html" title="class in org.apache.tamaya.spi">ConversionContext</a></dd> -</dl> -<hr> -<br> -<pre>public static final class <span class="typeNameLabel">ConversionContext.Builder</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">Builder to create new instances of <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi"><code>ConversionContext</code></a>.</div> -</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/ConversionContext.Builder.html#Builder-org.apache.tamaya.Configuration-org.apache.tamaya.spi.ConfigurationContext-java.lang.String-org.apache.tamaya.TypeLiteral-">Builder</a></span>(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> configuration, - <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> configurationContext, - <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="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</code> -<div class="block">Creates a new Builder instance.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#Builder-java.lang.String-org.apache.tamaya.TypeLiteral-">Builder</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="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</code> -<div class="block">Creates a new Builder instance.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#Builder-org.apache.tamaya.TypeLiteral-">Builder</a></span>(<a href="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</code> -<div class="block">Creates a new Builder 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/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#addSupportedFormats-java.lang.Class-java.lang.String...-">addSupportedFormats</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi">PropertyConverter</a>> converterType, - <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>... formatDescriptors)</code> -<div class="block">Add the formats provided by a <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a>.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi">ConversionContext</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#build--">build</a></span>()</code> -<div class="block">Builds a new context instance.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#setAnnotatedElement-java.lang.reflect.AnnotatedElement-">setAnnotatedElement</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a> annotatedElement)</code> -<div class="block">Sets the annotated element, when configuration is injected.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#setConfiguration-org.apache.tamaya.Configuration-">setConfiguration</a></span>(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> configuration)</code> -<div class="block">Sets the configuration.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-">setConfigurationContext</a></span>(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> configurationContext)</code> -<div class="block">Sets the configuration.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html#setKey-java.lang.String-">setKey</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">Sets the key.</div> -</td> -</tr> -<tr id="i6" 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/ConversionContext.Builder.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="Builder-org.apache.tamaya.TypeLiteral-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Builder</h4> -<pre>public Builder(<a href="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</pre> -<div class="block">Creates a new Builder instance.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>targetType</code> - the target type</dd> -</dl> -</li> -</ul> -<a name="Builder-java.lang.String-org.apache.tamaya.TypeLiteral-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Builder</h4> -<pre>public Builder(<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="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</pre> -<div class="block">Creates a new Builder instance.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>key</code> - the requested key, may be null.</dd> -<dd><code>targetType</code> - the target type</dd> -</dl> -</li> -</ul> -<a name="Builder-org.apache.tamaya.Configuration-org.apache.tamaya.spi.ConfigurationContext-java.lang.String-org.apache.tamaya.TypeLiteral-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Builder</h4> -<pre>public Builder(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> configuration, - <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> configurationContext, - <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="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> targetType)</pre> -<div class="block">Creates a new Builder instance.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>configuration</code> - the configuration, not null.</dd> -<dd><code>configurationContext</code> - configuration context, not null.</dd> -<dd><code>key</code> - the requested key, may be null.</dd> -<dd><code>targetType</code> - the target type</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="setKey-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setKey</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> setKey(<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">Sets the key.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>key</code> - the key, not null.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the builder instance, for chaining</dd> -</dl> -</li> -</ul> -<a name="setConfiguration-org.apache.tamaya.Configuration-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setConfiguration</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> setConfiguration(<a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> configuration)</pre> -<div class="block">Sets the configuration.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>configuration</code> - the configuration, not null</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the builder instance, for chaining</dd> -</dl> -</li> -</ul> -<a name="setConfigurationContext-org.apache.tamaya.spi.ConfigurationContext-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setConfigurationContext</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> setConfigurationContext(<a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> configurationContext)</pre> -<div class="block">Sets the configuration.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>configurationContext</code> - the configuration, not null</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the builder instance, for chaining</dd> -</dl> -</li> -</ul> -<a name="setAnnotatedElement-java.lang.reflect.AnnotatedElement-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setAnnotatedElement</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> setAnnotatedElement(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a> annotatedElement)</pre> -<div class="block">Sets the annotated element, when configuration is injected.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>annotatedElement</code> - the annotated element, not null</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the builder instance, for chaining</dd> -</dl> -</li> -</ul> -<a name="addSupportedFormats-java.lang.Class-java.lang.String...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>addSupportedFormats</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> addSupportedFormats(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi">PropertyConverter</a>> converterType, - <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>... formatDescriptors)</pre> -<div class="block">Add the formats provided by a <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a>. This method should be called by each converter - performing/trying conversion, so the user can be given feedback on the supported formats on failure.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>converterType</code> - the converter type, not null.</dd> -<dd><code>formatDescriptors</code> - the formats supported in a human readable form, e.g. as regular expressions.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the builder instance, for chaining</dd> -</dl> -</li> -</ul> -<a name="build--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>build</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi">ConversionContext</a> build()</pre> -<div class="block">Builds a new context instance.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new context, never 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/ConversionContext.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/spi/ConversionContext.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/Experimental.html" title="annotation 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/ConversionContext.Builder.html" target="_top">Frames</a></li> -<li><a href="ConversionContext.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><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/f1085b9b/apidocs/org/apache/tamaya/spi/ConversionContext.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/ConversionContext.html b/apidocs/org/apache/tamaya/spi/ConversionContext.html deleted file mode 100644 index 2168bc9..0000000 --- a/apidocs/org/apache/tamaya/spi/ConversionContext.html +++ /dev/null @@ -1,463 +0,0 @@ -<!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>ConversionContext (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> -<meta name="keywords" content="org.apache.tamaya.spi.ConversionContext class"> -<meta name="keywords" content="getKey()"> -<meta name="keywords" content="getTargetType()"> -<meta name="keywords" content="getAnnotatedElement()"> -<meta name="keywords" content="getConfiguration()"> -<meta name="keywords" content="addSupportedFormats()"> -<meta name="keywords" content="getSupportedFormats()"> -<meta name="keywords" content="toString()"> -<meta name="keywords" content="getConfigurationContext()"> -<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="ConversionContext (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ConversionContext.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/ConfigurationProviderSpi.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.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/ConversionContext.html" target="_top">Frames</a></li> -<li><a href="ConversionContext.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.spi</div> -<h2 title="Class ConversionContext" class="title">Class ConversionContext</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.ConversionContext</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="typeNameLabel">ConversionContext</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 conversion context containing all the required values for implementing conversion. Use the included #Builder - for creating new instances of. This class is thread-safe to use. Adding supported formats is synchronized.</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a></dd> -</dl> -</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/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a></span></code> -<div class="block">Builder to create new instances of <a href="../../../../org/apache/tamaya/spi/ConversionContext.html" title="class in org.apache.tamaya.spi"><code>ConversionContext</code></a>.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier</th> -<th class="colLast" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#ConversionContext-org.apache.tamaya.spi.ConversionContext.Builder-">ConversionContext</a></span>(<a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> builder)</code> -<div class="block">Private constructor used from builder.</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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#addSupportedFormats-java.lang.Class-java.lang.String...-">addSupportedFormats</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi">PropertyConverter</a>> converterType, - <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>... formatDescriptors)</code> -<div class="block">Allows to add information on the supported/tried formats, which can be shown to the user, especially when - conversion failed.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#getAnnotatedElement--">getAnnotatedElement</a></span>()</code> -<div class="block">Get the annotated element, if conversion is performed using injection mechanisms.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#getConfiguration--">getConfiguration</a></span>()</code> -<div class="block">Get the configuration, which is targeted.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#getConfigurationContext--">getConfigurationContext</a></span>()</code> </td> -</tr> -<tr id="i4" 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/ConversionContext.html#getKey--">getKey</a></span>()</code> -<div class="block">Get the key accessed.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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/ConversionContext.html#getSupportedFormats--">getSupportedFormats</a></span>()</code> -<div class="block">Get the supported/tried formats in precedence order.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tamaya/spi/ConversionContext.html#getTargetType--">getTargetType</a></span>()</code> -<div class="block">Get the target type required.</div> -</td> -</tr> -<tr id="i7" 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/ConversionContext.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="ConversionContext-org.apache.tamaya.spi.ConversionContext.Builder-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>ConversionContext</h4> -<pre>protected ConversionContext(<a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi">ConversionContext.Builder</a> builder)</pre> -<div class="block">Private constructor used from builder.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>builder</code> - the builder, 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="getTargetType--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTargetType</h4> -<pre>public <a href="../../../../org/apache/tamaya/TypeLiteral.html" title="class in org.apache.tamaya">TypeLiteral</a><?> getTargetType()</pre> -<div class="block">Get the target type required.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the target type required.</dd> -</dl> -</li> -</ul> -<a name="getAnnotatedElement--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAnnotatedElement</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a> getAnnotatedElement()</pre> -<div class="block">Get the annotated element, if conversion is performed using injection mechanisms.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the annotated element, or null.</dd> -</dl> -</li> -</ul> -<a name="getConfiguration--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getConfiguration</h4> -<pre>public <a href="../../../../org/apache/tamaya/Configuration.html" title="interface in org.apache.tamaya">Configuration</a> getConfiguration()</pre> -<div class="block">Get the configuration, which is targeted.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the configuration instance, or null.</dd> -</dl> -</li> -</ul> -<a name="addSupportedFormats-java.lang.Class-java.lang.String...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>addSupportedFormats</h4> -<pre>public void addSupportedFormats(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi">PropertyConverter</a>> converterType, - <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>... formatDescriptors)</pre> -<div class="block">Allows to add information on the supported/tried formats, which can be shown to the user, especially when - conversion failed. Adding of formats is synchronized, all formats are added in order to the overall list. - This means formats should be passed in order of precedence.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>converterType</code> - the converter, which implements the formats provided.</dd> -<dd><code>formatDescriptors</code> - the format descriptions in a human readable form, e.g. as regular expressions.</dd> -</dl> -</li> -</ul> -<a name="getSupportedFormats--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSupportedFormats</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> getSupportedFormats()</pre> -<div class="block">Get the supported/tried formats in precedence order. The contents of this method depends on the - <a href="../../../../org/apache/tamaya/spi/PropertyConverter.html" title="interface in org.apache.tamaya.spi"><code>PropertyConverter</code></a> instances involved in a conversion.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the supported/tried formats, never null.</dd> -</dl> -</li> -</ul> -<a name="toString--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/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> -<a name="getConfigurationContext--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getConfigurationContext</h4> -<pre>public <a href="../../../../org/apache/tamaya/spi/ConfigurationContext.html" title="interface in org.apache.tamaya.spi">ConfigurationContext</a> getConfigurationContext()</pre> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ConversionContext.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/ConfigurationProviderSpi.html" title="interface in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/ConversionContext.Builder.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/ConversionContext.html" target="_top">Frames</a></li> -<li><a href="ConversionContext.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/f1085b9b/apidocs/org/apache/tamaya/spi/Experimental.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/tamaya/spi/Experimental.html b/apidocs/org/apache/tamaya/spi/Experimental.html deleted file mode 100644 index c378304..0000000 --- a/apidocs/org/apache/tamaya/spi/Experimental.html +++ /dev/null @@ -1,170 +0,0 @@ -<!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>Experimental (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)</title> -<meta name="keywords" content="org.apache.tamaya.spi.Experimental class"> -<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="Experimental (Apache Tamaya Base 0.3-incubating-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -</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/Experimental.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/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/FilterContext.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/Experimental.html" target="_top">Frames</a></li> -<li><a href="Experimental.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>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</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="Annotation Type Experimental" class="title">Annotation Type Experimental</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIE LD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>}) -public @interface <span class="memberNameLabel">Experimental</span></pre> -<div class="block">This is a simple annotation for flaging out functionality or features the Tamaya team is not sure if it is already - stabilized, so use it with some caution.</div> -</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/Experimental.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/ConversionContext.Builder.html" title="class in org.apache.tamaya.spi"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/tamaya/spi/FilterContext.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/Experimental.html" target="_top">Frames</a></li> -<li><a href="Experimental.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>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</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>