blob: 7f382b1a94828ac3b900067371517afa1d7a9a44 [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ConfigClasspathStore (juneau 8.1.3)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.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="ConfigClasspathStore (juneau 8.1.3)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/config/store/ConfigClasspathStore.html" target="_top">Frames</a></li>
<li><a href="ConfigClasspathStore.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.apache.juneau.config.store</div>
<h2 title="Class ConfigClasspathStore" class="title">Class ConfigClasspathStore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">org.apache.juneau.Context</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">org.apache.juneau.config.store.ConfigStore</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.config.store.ConfigClasspathStore</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/juneau/annotation/ConfigurableContext.html" title="annotation in org.apache.juneau.annotation">@ConfigurableContext</a>
public class <a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.34">ConfigClasspathStore</a>
extends <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></pre>
<div class="block">Classpath-based storage location for configuration files.
<p>
Looks inside the JVM classpath for configuration files.
<p>
Configuration files retrieved from the classpath can be modified but not persisted.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html" title="class in org.apache.juneau.config.store">ConfigClasspathStore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">Default memory store, all default values.</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">&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/apache/juneau/config/store/ConfigClasspathStore.html#ConfigClasspathStore-org.apache.juneau.PropertyStore-">ConfigClasspathStore</a></span>(<a href="../../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a>&nbsp;ps)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="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><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store">ConfigClasspathStoreBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#builder--">builder</a></span>()</code>
<div class="block">Creates a builder from this context object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#close--">close</a></span>()</code>
<div class="block">No-op.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store">ConfigClasspathStoreBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#create--">create</a></span>()</code>
<div class="block">Create a new builder for this object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#exists-java.lang.String-">exists</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Checks whether the configuration with the specified name exists in this store.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#read-java.lang.String-">read</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the contents of the configuration file.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#toMap--">toMap</a></span>()</code>
<div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html" title="class in org.apache.juneau.config.store">ConfigClasspathStore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#update-java.lang.String-java.lang.String-">update</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newContents)</code>
<div class="block">Called when the physical contents of a config file have changed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html#write-java.lang.String-java.lang.String-java.lang.String-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;expectedContents,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newContents)</code>
<div class="block">Saves the contents of the configuration file if the underlying storage hasn't been modified.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.config.store.ConfigStore">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.config.store.<a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></h3>
<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#createDefaultSessionArgs--">createDefaultSessionArgs</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#createSession-org.apache.juneau.SessionArgs-">createSession</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#getMap-java.lang.String-">getMap</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#register-java.lang.String-org.apache.juneau.config.store.ConfigStoreListener-">register</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#resolveName-java.lang.String-">resolveName</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#unregister-java.lang.String-org.apache.juneau.config.store.ConfigStoreListener-">unregister</a>, <a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#update-java.lang.String-java.lang.String...-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.Context">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a></h3>
<code><a href="../../../../../org/apache/juneau/Context.html#createSession--">createSession</a>, <a href="../../../../../org/apache/juneau/Context.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/juneau/Context.html#getArrayProperty-java.lang.String-java.lang.Class-">getArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getArrayProperty-java.lang.String-java.lang.Class-T:A-">getArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getBooleanProperty-java.lang.String-java.lang.Boolean-">getBooleanProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getCdlProperty-java.lang.String-java.lang.String-">getCdlProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassArrayProperty-java.lang.String-">getClassArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassArrayProperty-java.lang.String-java.lang.Class:A-">getClassArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassArrayProperty-java.lang.String-java.lang.Class-">getClassArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassListProperty-java.lang.String-">getClassListProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassListProperty-java.lang.String-java.lang.Class-">getClassListProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassMapProperty-java.lang.String-">getClassMapProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassMapProperty-java.lang.String-java.lang.Class-">getClassMapProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassProperty-java.lang.String-java.lang.Class-java.lang.Class-">getClassProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassSetProperty-java.lang.String-">getClassSetProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getClassSetProperty-java.lang.String-java.lang.Class-">getClassSetProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceArrayProperty-java.lang.String-java.lang.Class-T:A-">getInstanceArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceArrayProperty-java.lang.String-java.lang.Class-T:A-org.apache.juneau.ResourceResolver-java.lang.Object...-">getInstanceArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceArrayProperty-java.lang.String-java.lang.Object-java.lang.Class-T:A-org.apache.juneau.ResourceResolver-java.lang.Object...-">getInstanceArrayProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceProperty-java.lang.String-java.lang.Class-java.lang.Object-">getInstanceProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceProperty-java.lang.String-java.lang.Class-java.lang.Object-org.apache.juneau.ResourceResolver-java.lang.Object...-">getInstanceProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getInstanceProperty-java.lang.String-java.lang.Object-java.lang.Class-java.lang.Object-org.apache.juneau.ResourceResolver-java.lang.Object...-">getInstanceProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getIntegerProperty-java.lang.String-java.lang.Integer-">getIntegerProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getListProperty-java.lang.String-java.lang.Class-">getListProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getListProperty-java.lang.String-java.lang.Class-java.util.List-">getListProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getLongProperty-java.lang.String-java.lang.Long-">getLongProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getMapProperty-java.lang.String-java.lang.Class-">getMapProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getProperty-java.lang.String-">getProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getProperty-java.lang.String-java.lang.Class-T-">getProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getPropertyKeys-java.lang.String-">getPropertyKeys</a>, <a href="../../../../../org/apache/juneau/Context.html#getPropertyStore--">getPropertyStore</a>, <a href="../../../../../org/apache/juneau/Context.html#getSetProperty-java.lang.String-java.lang.Class-">getSetProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getSetProperty-java.lang.String-java.lang.Class-java.util.Set-">getSetProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getStringProperty-java.lang.String-java.lang.String-">getStringProperty</a>, <a href="../../../../../org/apache/juneau/Context.html#getStringPropertyWithNone-java.lang.String-java.lang.String-">getStringPropertyWithNone</a>, <a href="../../../../../org/apache/juneau/Context.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/juneau/Context.html#identityCode--">identityCode</a>, <a href="../../../../../org/apache/juneau/Context.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html" title="class in org.apache.juneau.config.store">ConfigClasspathStore</a> <a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.47">DEFAULT</a></pre>
<div class="block">Default memory store, all default values.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConfigClasspathStore-org.apache.juneau.PropertyStore-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigClasspathStore</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.75">ConfigClasspathStore</a>(<a href="../../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a>&nbsp;ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ps</code> - The settings for this content store.</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="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store">ConfigClasspathStoreBuilder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.59">create</a>()</pre>
<div class="block">Create a new builder for this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder for this object.</dd>
</dl>
</li>
</ul>
<a name="builder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store">ConfigClasspathStoreBuilder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.64">builder</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.html#builder--">Context</a></code></span></div>
<div class="block">Creates a builder from this context object.
<p>
Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/Context.html#builder--">builder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new ContextBuilder object.</dd>
</dl>
</li>
</ul>
<a name="read-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.80">read</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#read-java.lang.String-">ConfigStore</a></code></span></div>
<div class="block">Returns the contents of the configuration file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#read-java.lang.String-">read</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The config file name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The contents of the configuration file.
<br>A blank string if the config does not exist.
<br>Never <jk>null</jk>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd>
</dl>
</li>
</ul>
<a name="write-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.94">write</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;expectedContents,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newContents)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#write-java.lang.String-java.lang.String-java.lang.String-">ConfigStore</a></code></span></div>
<div class="block">Saves the contents of the configuration file if the underlying storage hasn't been modified.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#write-java.lang.String-java.lang.String-java.lang.String-">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The config file name.</dd>
<dd><code>expectedContents</code> - The expected contents of the file.</dd>
<dd><code>newContents</code> - The new contents.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If <jk>null</jk>, then we successfully stored the contents of the file.
<br>Otherwise the contents of the file have changed and we return the new contents of the file.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd>
</dl>
</li>
</ul>
<a name="exists-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.111">exists</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#exists-java.lang.String-">ConfigStore</a></code></span></div>
<div class="block">Checks whether the configuration with the specified name exists in this store.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#exists-java.lang.String-">exists</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The config name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><jk>true</jk> if the configuration with the specified name exists in this store.</dd>
</dl>
</li>
</ul>
<a name="update-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStore.html" title="class in org.apache.juneau.config.store">ConfigClasspathStore</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.120">update</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newContents)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#update-java.lang.String-java.lang.String-">ConfigStore</a></code></span></div>
<div class="block">Called when the physical contents of a config file have changed.
<p>
Triggers calls to <a href="../../../../../org/apache/juneau/config/store/ConfigStoreListener.html#onChange-java.lang.String-"><code>ConfigStoreListener.onChange(String)</code></a> on all registered listeners.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#update-java.lang.String-java.lang.String-">update</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The config name (e.g. the filename without the extension).</dd>
<dd><code>newContents</code> - The new contents.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.133">close</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">No-op.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="toMap--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toMap</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/config/store/ConfigClasspathStore.html#line.142">toMap</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.html#toMap--">Context</a></code></span></div>
<div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html#toMap--">toMap</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new map containing the properties defined on this context.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/juneau/config/store/ConfigClasspathStoreBuilder.html" title="class in org.apache.juneau.config.store"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/config/store/ConfigClasspathStore.html" target="_top">Frames</a></li>
<li><a href="ConfigClasspathStore.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>