Google Git
Sign in
apache / tomee-site / dae66f09309a7a0ea5640d3f529ae394daffa560 / . / content / microprofile-2.0 / javadoc / org / eclipse / microprofile / config / spi / ConfigProviderResolver.html
blob: 0bd00c9585d20e54aec0fa459dbd01dc4c484fd3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ConfigProviderResolver</title>
<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="ConfigProviderResolver";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":9,"i4":6,"i5":6,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigSource.html" title="interface in org.eclipse.microprofile.config.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" target="_top">Frames</a></li>
<li><a href="ConfigProviderResolver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.eclipse.microprofile.config.spi</div>
<h2 title="Class ConfigProviderResolver" class="title">Class ConfigProviderResolver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.microprofile.config.spi.ConfigProviderResolver</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ConfigProviderResolver</span>
extends java.lang.Object</pre>
<div class="block">This class is not intended to be used by end-users but for
portable container integration purpose only.
Service provider for ConfigProviderResolver. The implementation registers
itself via the <code>ServiceLoader</code> mechanism.</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">&nbsp;</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/eclipse/microprofile/config/spi/ConfigProviderResolver.html#ConfigProviderResolver--">ConfigProviderResolver</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>abstract <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi">ConfigBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#getBuilder--">getBuilder</a></span>()</code>
<div class="block">Create a fresh <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi"><code>ConfigBuilder</code></a> instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#getConfig--">getConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#getConfig-java.lang.ClassLoader-">getConfig</a></span>(java.lang.ClassLoader&nbsp;loader)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" title="class in org.eclipse.microprofile.config.spi">ConfigProviderResolver</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#instance--">instance</a></span>()</code>
<div class="block">Creates a ConfigProviderResolver object
Only used internally from within <a href="../../../../../org/eclipse/microprofile/config/ConfigProvider.html" title="class in org.eclipse.microprofile.config"><code>ConfigProvider</code></a></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#registerConfig-org.eclipse.microprofile.config.Config-java.lang.ClassLoader-">registerConfig</a></span>(<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;config,
java.lang.ClassLoader&nbsp;classLoader)</code>
<div class="block">Register a given <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config"><code>Config</code></a> within the Application (or Module) identified by the given ClassLoader.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#releaseConfig-org.eclipse.microprofile.config.Config-">releaseConfig</a></span>(<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;config)</code>
<div class="block">A <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config"><code>Config</code></a> normally gets released if the Application it is associated with gets destroyed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#setInstance-org.eclipse.microprofile.config.spi.ConfigProviderResolver-">setInstance</a></span>(<a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" title="class in org.eclipse.microprofile.config.spi">ConfigProviderResolver</a>&nbsp;resolver)</code>
<div class="block">Set the instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="ConfigProviderResolver--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigProviderResolver</h4>
<pre>protected&nbsp;ConfigProviderResolver()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;getConfig()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>config the config object for the Thread Context Classloader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/microprofile/config/ConfigProvider.html#getConfig--"><code>ConfigProvider.getConfig()</code></a></dd>
</dl>
</li>
</ul>
<a name="getConfig-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;getConfig(java.lang.ClassLoader&nbsp;loader)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - the classloader</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>config the config object for the specified classloader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/microprofile/config/ConfigProvider.html#getConfig-java.lang.ClassLoader-"><code>ConfigProvider.getConfig(ClassLoader)</code></a></dd>
</dl>
</li>
</ul>
<a name="getBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuilder</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi">ConfigBuilder</a>&nbsp;getBuilder()</pre>
<div class="block">Create a fresh <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi"><code>ConfigBuilder</code></a> instance.
This ConfigBuilder will initially contain no <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigSource.html" title="interface in org.eclipse.microprofile.config.spi"><code>ConfigSource</code></a>. The other <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigSource.html" title="interface in org.eclipse.microprofile.config.spi"><code>ConfigSource</code></a> will have
to be added manually or discovered by calling <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigBuilder.html#addDiscoveredSources--"><code>ConfigBuilder.addDiscoveredSources()</code></a>.
This ConfigBuilder will initially contain default <a href="../../../../../org/eclipse/microprofile/config/spi/Converter.html" title="interface in org.eclipse.microprofile.config.spi"><code>Converters</code></a>. Any other converters will need to
be added manually.
The ConfigProvider will not manage the Config instance internally</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a fresh ConfigBuilder</dd>
</dl>
</li>
</ul>
<a name="registerConfig-org.eclipse.microprofile.config.Config-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerConfig</h4>
<pre>public abstract&nbsp;void&nbsp;registerConfig(<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;config,
java.lang.ClassLoader&nbsp;classLoader)</pre>
<div class="block">Register a given <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config"><code>Config</code></a> within the Application (or Module) identified by the given ClassLoader.
If the ClassLoader is <code>null</code> then the current Application will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - which should get registered</dd>
<dd><code>classLoader</code> - which identifies the Application or Module the given Config should get associated with.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there is already a Config registered within the Application.
A user could explicitly use <a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html#releaseConfig-org.eclipse.microprofile.config.Config-"><code>releaseConfig(Config)</code></a> for this case.</dd>
</dl>
</li>
</ul>
<a name="releaseConfig-org.eclipse.microprofile.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseConfig</h4>
<pre>public abstract&nbsp;void&nbsp;releaseConfig(<a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config">Config</a>&nbsp;config)</pre>
<div class="block">A <a href="../../../../../org/eclipse/microprofile/config/Config.html" title="interface in org.eclipse.microprofile.config"><code>Config</code></a> normally gets released if the Application it is associated with gets destroyed.
Invoke this method if you like to destroy the Config prematurely.
If the given Config is associated within an Application then it will be unregistered.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the config to be released</dd>
</dl>
</li>
</ul>
<a name="instance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instance</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" title="class in org.eclipse.microprofile.config.spi">ConfigProviderResolver</a>&nbsp;instance()</pre>
<div class="block">Creates a ConfigProviderResolver object
Only used internally from within <a href="../../../../../org/eclipse/microprofile/config/ConfigProvider.html" title="class in org.eclipse.microprofile.config"><code>ConfigProvider</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ConfigProviderResolver an instance of ConfigProviderResolver</dd>
</dl>
</li>
</ul>
<a name="setInstance-org.eclipse.microprofile.config.spi.ConfigProviderResolver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setInstance</h4>
<pre>public static&nbsp;void&nbsp;setInstance(<a href="../../../../../org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" title="class in org.eclipse.microprofile.config.spi">ConfigProviderResolver</a>&nbsp;resolver)</pre>
<div class="block">Set the instance. It is used by OSGi environment while service loader
pattern is not supported.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resolver</code> - set the instance.</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="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/eclipse/microprofile/config/spi/ConfigBuilder.html" title="interface in org.eclipse.microprofile.config.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/microprofile/config/spi/ConfigSource.html" title="interface in org.eclipse.microprofile.config.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/microprofile/config/spi/ConfigProviderResolver.html" target="_top">Frames</a></li>
<li><a href="ConfigProviderResolver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>