mirror of
https://github.com/lightbend/config.git
synced 2025-02-23 01:30:34 +08:00
863 lines
78 KiB
HTML
863 lines
78 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="sv">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_04) on Fri Jun 29 22:49:50 CEST 2012 -->
|
|
<title>Index</title>
|
|
<meta name="date" content="2012-06-29">
|
|
<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Index";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="./com/typesafe/config/package-summary.html">Package</a></li>
|
|
<li>Class</li>
|
|
<li><a href="./com/typesafe/config/package-tree.html">Tree</a></li>
|
|
<li><a href="./deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="./help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev</li>
|
|
<li>Next</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="./index.html?index-all.html" target="_top">Frames</a></li>
|
|
<li><a href="index-all.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>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="contentContainer"><a href="#_A_">A</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_L_">L</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a name="_A_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">A</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#appendIncluder(com.typesafe.config.ConfigIncluder)">appendIncluder(ConfigIncluder)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a name="_C_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">C</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#checkValid(com.typesafe.config.Config, java.lang.String...)">checkValid(Config, String...)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Validates this config against a reference config, throwing an exception
|
|
if it is invalid.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a> - package com.typesafe.config</dt>
|
|
<dd>
|
|
<div class="block">
|
|
An API for loading and using configuration files, see <a href="https://github.com/havocp/config/">the project site</a>
|
|
for more information.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config"><span class="strong">Config</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">An immutable map from config paths to config values.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config"><span class="strong">ConfigException</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">All exceptions thrown by the library are subclasses of ConfigException.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.html#ConfigException(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.Throwable)">ConfigException(ConfigOrigin, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config">ConfigException</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.html#ConfigException(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config">ConfigException</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.html#ConfigException(java.lang.String, java.lang.Throwable)">ConfigException(String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config">ConfigException</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.html#ConfigException(java.lang.String)">ConfigException(String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config">ConfigException</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config"><span class="strong">ConfigException.BadPath</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that a path expression was invalid.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadPath.html#ConfigException.BadPath(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.BadPath(ConfigOrigin, String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config">ConfigException.BadPath</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadPath.html#ConfigException.BadPath(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String)">ConfigException.BadPath(ConfigOrigin, String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config">ConfigException.BadPath</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadPath.html#ConfigException.BadPath(java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.BadPath(String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config">ConfigException.BadPath</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadPath.html#ConfigException.BadPath(java.lang.String, java.lang.String)">ConfigException.BadPath(String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config">ConfigException.BadPath</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadPath.html#ConfigException.BadPath(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.BadPath(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadPath.html" title="class in com.typesafe.config">ConfigException.BadPath</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.BadValue.html" title="class in com.typesafe.config"><span class="strong">ConfigException.BadValue</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that a value was messed up, for example you may have
|
|
asked for a duration and the value can't be sensibly parsed as a
|
|
duration.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadValue.html#ConfigException.BadValue(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.BadValue(ConfigOrigin, String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadValue.html" title="class in com.typesafe.config">ConfigException.BadValue</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadValue.html#ConfigException.BadValue(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String)">ConfigException.BadValue(ConfigOrigin, String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadValue.html" title="class in com.typesafe.config">ConfigException.BadValue</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadValue.html#ConfigException.BadValue(java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.BadValue(String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadValue.html" title="class in com.typesafe.config">ConfigException.BadValue</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BadValue.html#ConfigException.BadValue(java.lang.String, java.lang.String)">ConfigException.BadValue(String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BadValue.html" title="class in com.typesafe.config">ConfigException.BadValue</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.BugOrBroken.html" title="class in com.typesafe.config"><span class="strong">ConfigException.BugOrBroken</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that there's a bug in something (possibly the
|
|
library itself) or the runtime environment is broken.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BugOrBroken.html#ConfigException.BugOrBroken(java.lang.String, java.lang.Throwable)">ConfigException.BugOrBroken(String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BugOrBroken.html" title="class in com.typesafe.config">ConfigException.BugOrBroken</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.BugOrBroken.html#ConfigException.BugOrBroken(java.lang.String)">ConfigException.BugOrBroken(String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.BugOrBroken.html" title="class in com.typesafe.config">ConfigException.BugOrBroken</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.Generic.html" title="class in com.typesafe.config"><span class="strong">ConfigException.Generic</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception that doesn't fall into any other category.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Generic.html#ConfigException.Generic(java.lang.String, java.lang.Throwable)">ConfigException.Generic(String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Generic.html" title="class in com.typesafe.config">ConfigException.Generic</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Generic.html#ConfigException.Generic(java.lang.String)">ConfigException.Generic(String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Generic.html" title="class in com.typesafe.config">ConfigException.Generic</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.IO.html" title="class in com.typesafe.config"><span class="strong">ConfigException.IO</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that there was an IO error.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.IO.html#ConfigException.IO(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.Throwable)">ConfigException.IO(ConfigOrigin, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.IO.html" title="class in com.typesafe.config">ConfigException.IO</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.IO.html#ConfigException.IO(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.IO(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.IO.html" title="class in com.typesafe.config">ConfigException.IO</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.Missing.html" title="class in com.typesafe.config"><span class="strong">ConfigException.Missing</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicates that the setting was never set to anything, not even
|
|
null.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Missing.html#ConfigException.Missing(java.lang.String, java.lang.Throwable)">ConfigException.Missing(String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Missing.html" title="class in com.typesafe.config">ConfigException.Missing</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Missing.html#ConfigException.Missing(java.lang.String)">ConfigException.Missing(String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Missing.html" title="class in com.typesafe.config">ConfigException.Missing</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Missing.html#ConfigException.Missing(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.Throwable)">ConfigException.Missing(ConfigOrigin, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Missing.html" title="class in com.typesafe.config">ConfigException.Missing</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Missing.html#ConfigException.Missing(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.Missing(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Missing.html" title="class in com.typesafe.config">ConfigException.Missing</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.NotResolved.html" title="class in com.typesafe.config"><span class="strong">ConfigException.NotResolved</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that you tried to use a function that requires
|
|
substitutions to be resolved, but substitutions have not been resolved
|
|
(that is, <a href="./com/typesafe/config/Config.html#resolve()"><code>Config.resolve()</code></a> was not called).</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.NotResolved.html#ConfigException.NotResolved(java.lang.String, java.lang.Throwable)">ConfigException.NotResolved(String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.NotResolved.html" title="class in com.typesafe.config">ConfigException.NotResolved</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.NotResolved.html#ConfigException.NotResolved(java.lang.String)">ConfigException.NotResolved(String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.NotResolved.html" title="class in com.typesafe.config">ConfigException.NotResolved</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.Null.html" title="class in com.typesafe.config"><span class="strong">ConfigException.Null</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicates that the setting was treated as missing because it
|
|
was set to null.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Null.html#ConfigException.Null(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.Null(ConfigOrigin, String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Null.html" title="class in com.typesafe.config">ConfigException.Null</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Null.html#ConfigException.Null(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String)">ConfigException.Null(ConfigOrigin, String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Null.html" title="class in com.typesafe.config">ConfigException.Null</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.Parse.html" title="class in com.typesafe.config"><span class="strong">ConfigException.Parse</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that there was a parse error.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Parse.html#ConfigException.Parse(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.Throwable)">ConfigException.Parse(ConfigOrigin, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Parse.html" title="class in com.typesafe.config">ConfigException.Parse</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.Parse.html#ConfigException.Parse(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.Parse(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.Parse.html" title="class in com.typesafe.config">ConfigException.Parse</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.UnresolvedSubstitution.html" title="class in com.typesafe.config"><span class="strong">ConfigException.UnresolvedSubstitution</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that a substitution did not resolve to anything.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.UnresolvedSubstitution.html#ConfigException.UnresolvedSubstitution(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.Throwable)">ConfigException.UnresolvedSubstitution(ConfigOrigin, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.UnresolvedSubstitution.html" title="class in com.typesafe.config">ConfigException.UnresolvedSubstitution</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.UnresolvedSubstitution.html#ConfigException.UnresolvedSubstitution(com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.UnresolvedSubstitution(ConfigOrigin, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.UnresolvedSubstitution.html" title="class in com.typesafe.config">ConfigException.UnresolvedSubstitution</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.ValidationFailed.html" title="class in com.typesafe.config"><span class="strong">ConfigException.ValidationFailed</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that <a href="./com/typesafe/config/Config.html#checkValid(com.typesafe.config.Config, java.lang.String...)"><code>Config.checkValid(com.typesafe.config.Config, java.lang.String...)</code></a> found validity
|
|
problems.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationFailed.html#ConfigException.ValidationFailed(java.lang.Iterable)">ConfigException.ValidationFailed(Iterable<ConfigException.ValidationProblem>)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationFailed.html" title="class in com.typesafe.config">ConfigException.ValidationFailed</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.ValidationProblem.html" title="class in com.typesafe.config"><span class="strong">ConfigException.ValidationProblem</span></a> - Class in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Information about a problem that occurred in <a href="./com/typesafe/config/Config.html#checkValid(com.typesafe.config.Config, java.lang.String...)"><code>Config.checkValid(com.typesafe.config.Config, java.lang.String...)</code></a>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationProblem.html#ConfigException.ValidationProblem(java.lang.String, com.typesafe.config.ConfigOrigin, java.lang.String)">ConfigException.ValidationProblem(String, ConfigOrigin, String)</a></span> - Constructor for class com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationProblem.html" title="class in com.typesafe.config">ConfigException.ValidationProblem</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigException.WrongType.html" title="class in com.typesafe.config"><span class="strong">ConfigException.WrongType</span></a> - Exception in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Exception indicating that the type of a value does not match the type you
|
|
requested.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.WrongType.html#ConfigException.WrongType(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String, java.lang.String, java.lang.Throwable)">ConfigException.WrongType(ConfigOrigin, String, String, String, Throwable)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.WrongType.html" title="class in com.typesafe.config">ConfigException.WrongType</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.WrongType.html#ConfigException.WrongType(com.typesafe.config.ConfigOrigin, java.lang.String, java.lang.String, java.lang.String)">ConfigException.WrongType(ConfigOrigin, String, String, String)</a></span> - Constructor for exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.WrongType.html" title="class in com.typesafe.config">ConfigException.WrongType</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config"><span class="strong">ConfigFactory</span></a> - Class in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Contains static methods for creating <a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config"><code>Config</code></a> instances.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigIncludeContext.html" title="interface in com.typesafe.config"><span class="strong">ConfigIncludeContext</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Context provided to a <a href="./com/typesafe/config/ConfigIncluder.html" title="interface in com.typesafe.config"><code>ConfigIncluder</code></a>; this interface is only useful
|
|
inside a <code>ConfigIncluder</code> implementation, and is not intended for apps
|
|
to implement.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigIncluder.html" title="interface in com.typesafe.config"><span class="strong">ConfigIncluder</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Implement this interface and provide an instance to
|
|
<a href="./com/typesafe/config/ConfigParseOptions.html#setIncluder(com.typesafe.config.ConfigIncluder)"><code>ConfigParseOptions.setIncluder()</code></a> to
|
|
customize handling of <code>include</code> statements in config files.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigList.html" title="interface in com.typesafe.config"><span class="strong">ConfigList</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Subtype of <a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><code>ConfigValue</code></a> representing a list value, as in JSON's
|
|
<code>[1,2,3]</code> syntax.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigMergeable.html" title="interface in com.typesafe.config"><span class="strong">ConfigMergeable</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Marker for types whose instances can be merged, that is <a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config"><code>Config</code></a> and
|
|
<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><code>ConfigValue</code></a>.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config"><span class="strong">ConfigObject</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Subtype of <a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><code>ConfigValue</code></a> representing an object (dictionary, map)
|
|
value, as in JSON's <code>{ "a" : 42 }</code> syntax.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config"><span class="strong">ConfigOrigin</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">Represents the origin (such as filename and line number) of a
|
|
<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><code>ConfigValue</code></a> for use in error messages.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigParseable.html" title="interface in com.typesafe.config"><span class="strong">ConfigParseable</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">An opaque handle to something that can be parsed, obtained from
|
|
<a href="./com/typesafe/config/ConfigIncludeContext.html" title="interface in com.typesafe.config"><code>ConfigIncludeContext</code></a>.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config"><span class="strong">ConfigParseOptions</span></a> - Class in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">A set of options related to parsing.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#ConfigParseOptions(com.typesafe.config.ConfigSyntax, java.lang.String, boolean, com.typesafe.config.ConfigIncluder)">ConfigParseOptions(ConfigSyntax, String, boolean, ConfigIncluder)</a></span> - Constructor for class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config"><span class="strong">ConfigResolveOptions</span></a> - Class in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">A set of options related to resolving substitutions.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigSyntax.html" title="enum in com.typesafe.config"><span class="strong">ConfigSyntax</span></a> - Enum in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">The syntax of a character stream, <a href="http://json.org">JSON</a>, <a
|
|
href="https://github.com/havocp/config/blob/master/HOCON.md">HOCON</a> aka
|
|
".conf", or <a href=
|
|
"http://download.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.Reader%29"
|
|
>Java properties</a>.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><span class="strong">ConfigValue</span></a> - Interface in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">An immutable value, following the <a href="http://json.org">JSON</a> type
|
|
schema.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config"><span class="strong">ConfigValueFactory</span></a> - Class in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">This class holds some static factory methods for building ConfigValue.</div>
|
|
</dd>
|
|
<dt><a href="./com/typesafe/config/ConfigValueType.html" title="enum in com.typesafe.config"><span class="strong">ConfigValueType</span></a> - Enum in <a href="./com/typesafe/config/package-summary.html">com.typesafe.config</a></dt>
|
|
<dd>
|
|
<div class="block">The type of a configuration value (following the <a
|
|
href="http://json.org">JSON</a> type schema).</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_D_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">D</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#defaultOverrides()">defaultOverrides()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Obtains the default override configuration, which currently consists of
|
|
system properties.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#defaultReference()">defaultReference()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Obtains the default reference configuration, which is currently created
|
|
by merging all resources "reference.conf" found on the classpath and
|
|
overriding the result with system properties.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#defaults()">defaults()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigResolveOptions.html#defaults()">defaults()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config">ConfigResolveOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the default resolve options.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigOrigin.html#description()">description()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config">ConfigOrigin</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a string describing the origin of a value or exception.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_E_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">E</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#empty()">empty()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Gets an empty configuration.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#empty(java.lang.String)">empty(String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Gets an empty configuration with a description to be used to create a
|
|
<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config"><code>ConfigOrigin</code></a> for this <code>Config</code>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#entrySet()">entrySet()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the set of path-value pairs, excluding any null values, found by
|
|
recursing <a href="./com/typesafe/config/Config.html#root()"><code>the root object</code></a>.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_F_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">F</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigOrigin.html#filename()">filename()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config">ConfigOrigin</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a filename describing the origin.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromAnyRef(java.lang.Object, java.lang.String)">fromAnyRef(Object, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Creates a ConfigValue from a plain Java boxed value, which may be a
|
|
Boolean, Number, String, Map, Iterable, or null.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromAnyRef(java.lang.Object)">fromAnyRef(Object)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the other overload <a href="./com/typesafe/config/ConfigValueFactory.html#fromAnyRef(java.lang.Object, java.lang.String)"><code>ConfigValueFactory.fromAnyRef(Object,String)</code></a> for details,
|
|
this one just uses a default origin description.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromIterable(java.lang.Iterable, java.lang.String)">fromIterable(Iterable<? extends Object>, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the fromAnyRef() documentation for details.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromIterable(java.lang.Iterable)">fromIterable(Iterable<? extends Object>)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the other overload of <a href="./com/typesafe/config/ConfigValueFactory.html#fromIterable(java.lang.Iterable, java.lang.String)"><code>ConfigValueFactory.fromIterable(Iterable, String)</code></a> for
|
|
details, this one just uses a default origin description.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromMap(java.util.Map, java.lang.String)">fromMap(Map<String, ? extends Object>, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the fromAnyRef() documentation for details.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueFactory.html#fromMap(java.util.Map)">fromMap(Map<String, ? extends Object>)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigValueFactory.html" title="class in com.typesafe.config">ConfigValueFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the other overload <a href="./com/typesafe/config/ConfigValueFactory.html#fromMap(java.util.Map, java.lang.String)"><code>ConfigValueFactory.fromMap(Map,String)</code></a> for details, this one
|
|
just uses a default origin description.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_G_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">G</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigObject.html#get(java.lang.Object)">get(Object)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config">ConfigObject</a></dt>
|
|
<dd>
|
|
<div class="block">Gets a <a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config"><code>ConfigValue</code></a> at the given key, or returns null if there is
|
|
no value.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#getAllowMissing()">getAllowMissing()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getAnyRef(java.lang.String)">getAnyRef(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets the value at the path as an unwrapped Java boxed value (
|
|
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang"><code>Boolean</code></a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang"><code>Integer</code></a>, and
|
|
so on - see <a href="./com/typesafe/config/ConfigValue.html#unwrapped()"><code>ConfigValue.unwrapped()</code></a>).</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getAnyRefList(java.lang.String)">getAnyRefList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getBoolean(java.lang.String)">getBoolean(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getBooleanList(java.lang.String)">getBooleanList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getBytes(java.lang.String)">getBytes(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets a value as a size in bytes (parses special strings like "128M").</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getBytesList(java.lang.String)">getBytesList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getConfig(java.lang.String)">getConfig(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getConfigList(java.lang.String)">getConfigList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getDouble(java.lang.String)">getDouble(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getDoubleList(java.lang.String)">getDoubleList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#getIncluder()">getIncluder()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getInt(java.lang.String)">getInt(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getIntList(java.lang.String)">getIntList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getList(java.lang.String)">getList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets a list value (with any element type) as a <a href="./com/typesafe/config/ConfigList.html" title="interface in com.typesafe.config"><code>ConfigList</code></a>, which
|
|
implements <code>java.util.List<ConfigValue></code>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getLong(java.lang.String)">getLong(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getLongList(java.lang.String)">getLongList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getMilliseconds(java.lang.String)">getMilliseconds(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Get value as a duration in milliseconds.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getMillisecondsList(java.lang.String)">getMillisecondsList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getNanoseconds(java.lang.String)">getNanoseconds(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Get value as a duration in nanoseconds.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getNanosecondsList(java.lang.String)">getNanosecondsList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getNumber(java.lang.String)">getNumber(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getNumberList(java.lang.String)">getNumberList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getObject(java.lang.String)">getObject(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getObjectList(java.lang.String)">getObjectList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#getOriginDescription()">getOriginDescription()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getString(java.lang.String)">getString(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getStringList(java.lang.String)">getStringList(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#getSyntax()">getSyntax()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigResolveOptions.html#getUseSystemEnvironment()">getUseSystemEnvironment()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config">ConfigResolveOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Returns whether the options enable use of system environment variables.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#getValue(java.lang.String)">getValue(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets the value at the given path, unless the value is a null value or
|
|
missing, in which case it throws just like the other getters.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_H_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">H</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#hasPath(java.lang.String)">hasPath(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Checks whether a value is present and non-null at the given path.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_I_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">I</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigIncluder.html#include(com.typesafe.config.ConfigIncludeContext, java.lang.String)">include(ConfigIncludeContext, String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigIncluder.html" title="interface in com.typesafe.config">ConfigIncluder</a></dt>
|
|
<dd>
|
|
<div class="block">Parses another item to be included.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#isEmpty()">isEmpty()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Returns true if the <code>Config</code>'s root object contains no key-value
|
|
pairs.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_L_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">L</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigOrigin.html#lineNumber()">lineNumber()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config">ConfigOrigin</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a line number where the value or exception originated.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#load(java.lang.String)">load(String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Loads an application's configuration from the given classpath resource or
|
|
classpath resource basename, sandwiches it between default reference
|
|
config and default overrides, and then resolves it.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#load(java.lang.String, com.typesafe.config.ConfigParseOptions, com.typesafe.config.ConfigResolveOptions)">load(String, ConfigParseOptions, ConfigResolveOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Like <a href="./com/typesafe/config/ConfigFactory.html#load(java.lang.String)"><code>ConfigFactory.load(String)</code></a> but allows you to specify parse and resolve
|
|
options.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#load(com.typesafe.config.Config)">load(Config)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Assembles a standard configuration using a custom <code>Config</code>
|
|
object rather than loading "application.conf".</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#load(com.typesafe.config.Config, com.typesafe.config.ConfigResolveOptions)">load(Config, ConfigResolveOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Like <a href="./com/typesafe/config/ConfigFactory.html#load(com.typesafe.config.Config)"><code>ConfigFactory.load(Config)</code></a> but allows you to specify
|
|
<a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config"><code>ConfigResolveOptions</code></a>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#load()">load()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Loads a default configuration, equivalent to <a href="./com/typesafe/config/ConfigFactory.html#load(java.lang.String)"><code>load("application")</code></a> in most cases.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_N_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">N</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigResolveOptions.html#noSystem()">noSystem()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config">ConfigResolveOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Returns resolve options that disable any reference to "system" data
|
|
(currently, this means environment variables).</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_O_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">O</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseable.html#options()">options()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigParseable.html" title="interface in com.typesafe.config">ConfigParseable</a></dt>
|
|
<dd>
|
|
<div class="block">Get the initial options, which can be modified then passed to parse().</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#origin()">origin()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets the origin of the <code>Config</code>, which may be a file, or a file
|
|
with a line number, or just a descriptive phrase.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.html#origin()">origin()</a></span> - Method in exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.html" title="class in com.typesafe.config">ConfigException</a></dt>
|
|
<dd>
|
|
<div class="block">Returns an "origin" (such as a filename and line number) for the
|
|
exception, or null if none is available.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationProblem.html#origin()">origin()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationProblem.html" title="class in com.typesafe.config">ConfigException.ValidationProblem</a></dt>
|
|
<dd>
|
|
<div class="block">Returns where the problem occurred (origin may include info on the
|
|
file, line number, etc.).</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseable.html#origin()">origin()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigParseable.html" title="interface in com.typesafe.config">ConfigParseable</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a <a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config"><code>ConfigOrigin</code></a> describing the origin of the parseable
|
|
item.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValue.html#origin()">origin()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config">ConfigValue</a></dt>
|
|
<dd>
|
|
<div class="block">The origin of the value (file, line number, etc.), for debugging and
|
|
error messages.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_P_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">P</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseable.html#parse(com.typesafe.config.ConfigParseOptions)">parse(ConfigParseOptions)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigParseable.html" title="interface in com.typesafe.config">ConfigParseable</a></dt>
|
|
<dd>
|
|
<div class="block">Parse whatever it is.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseFile(java.io.File, com.typesafe.config.ConfigParseOptions)">parseFile(File, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseFile(java.io.File)">parseFile(File)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseFileAnySyntax(java.io.File, com.typesafe.config.ConfigParseOptions)">parseFileAnySyntax(File, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Parses a file with a flexible extension.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseFileAnySyntax(java.io.File)">parseFileAnySyntax(File)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseMap(java.util.Map, java.lang.String)">parseMap(Map<String, ? extends Object>, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Creates a <code>Config</code> based on a <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> from paths to
|
|
plain Java values.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseMap(java.util.Map)">parseMap(Map<String, ? extends Object>)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">See the other overload of <a href="./com/typesafe/config/ConfigFactory.html#parseMap(java.util.Map, java.lang.String)"><code>ConfigFactory.parseMap(Map, String)</code></a> for details,
|
|
this one just uses a default origin description.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions)">parseProperties(Properties, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Converts a Java <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> object to a
|
|
<a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config"><code>ConfigObject</code></a> using the rules documented in the <a
|
|
href="https://github.com/havocp/config/blob/master/HOCON.md">HOCON
|
|
spec</a>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseProperties(java.util.Properties)">parseProperties(Properties)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseReader(java.io.Reader, com.typesafe.config.ConfigParseOptions)">parseReader(Reader, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseReader(java.io.Reader)">parseReader(Reader)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseResources(java.lang.Class, java.lang.String, com.typesafe.config.ConfigParseOptions)">parseResources(Class<?>, String, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Parses all resources on the classpath with the given name and merges them
|
|
into a single <code>Config</code>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseResources(java.lang.Class, java.lang.String)">parseResources(Class<?>, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseResourcesAnySyntax(java.lang.Class, java.lang.String, com.typesafe.config.ConfigParseOptions)">parseResourcesAnySyntax(Class<?>, String, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Parses classpath resources with a flexible extension.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseResourcesAnySyntax(java.lang.Class, java.lang.String)">parseResourcesAnySyntax(Class<?>, String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseString(java.lang.String, com.typesafe.config.ConfigParseOptions)">parseString(String, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseString(java.lang.String)">parseString(String)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseURL(java.net.URL, com.typesafe.config.ConfigParseOptions)">parseURL(URL, ConfigParseOptions)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#parseURL(java.net.URL)">parseURL(URL)</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationProblem.html#path()">path()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationProblem.html" title="class in com.typesafe.config">ConfigException.ValidationProblem</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the config setting causing the problem.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#prependIncluder(com.typesafe.config.ConfigIncluder)">prependIncluder(ConfigIncluder)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationProblem.html#problem()">problem()</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationProblem.html" title="class in com.typesafe.config">ConfigException.ValidationProblem</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a description of the problem.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigException.ValidationFailed.html#problems()">problems()</a></span> - Method in exception com.typesafe.config.<a href="./com/typesafe/config/ConfigException.ValidationFailed.html" title="class in com.typesafe.config">ConfigException.ValidationFailed</a></dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a name="_R_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">R</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigIncludeContext.html#relativeTo(java.lang.String)">relativeTo(String)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigIncludeContext.html" title="interface in com.typesafe.config">ConfigIncludeContext</a></dt>
|
|
<dd>
|
|
<div class="block">Tries to find a name relative to whatever is doing the including, for
|
|
example in the same directory as the file doing the including.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValue.html#render()">render()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config">ConfigValue</a></dt>
|
|
<dd>
|
|
<div class="block">Renders the config value as a HOCON string.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#resolve()">resolve()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a replacement config with all substitutions (the
|
|
<code>${foo.bar}</code> syntax, see <a
|
|
href="https://github.com/havocp/config/blob/master/HOCON.md">the
|
|
spec</a>) resolved.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#resolve(com.typesafe.config.ConfigResolveOptions)">resolve(ConfigResolveOptions)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Like <a href="./com/typesafe/config/Config.html#resolve()"><code>Config.resolve()</code></a> but allows you to specify non-default
|
|
options.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigOrigin.html#resource()">resource()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config">ConfigOrigin</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a classpath resource name describing the origin.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#root()">root()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd>
|
|
<div class="block">Gets the <code>Config</code> as a tree of <a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config"><code>ConfigObject</code></a>.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_S_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">S</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#setAllowMissing(boolean)">setAllowMissing(boolean)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Set to false to throw an exception if the item being parsed (for example
|
|
a file) is missing.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#setIncluder(com.typesafe.config.ConfigIncluder)">setIncluder(ConfigIncluder)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Set a ConfigIncluder which customizes how includes are handled.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#setOriginDescription(java.lang.String)">setOriginDescription(String)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Set a description for the thing being parsed.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigParseOptions.html#setSyntax(com.typesafe.config.ConfigSyntax)">setSyntax(ConfigSyntax)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigParseOptions.html" title="class in com.typesafe.config">ConfigParseOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Set the file format.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigResolveOptions.html#setUseSystemEnvironment(boolean)">setUseSystemEnvironment(boolean)</a></span> - Method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigResolveOptions.html" title="class in com.typesafe.config">ConfigResolveOptions</a></dt>
|
|
<dd>
|
|
<div class="block">Returns options with use of environment variables set to the given value.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#systemEnvironment()">systemEnvironment()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Gets a <code>Config</code> containing the system's environment variables.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigFactory.html#systemProperties()">systemProperties()</a></span> - Static method in class com.typesafe.config.<a href="./com/typesafe/config/ConfigFactory.html" title="class in com.typesafe.config">ConfigFactory</a></dt>
|
|
<dd>
|
|
<div class="block">Gets a <code>Config</code> containing the system properties from
|
|
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/System.html?is-external=true#getProperties()" title="class or interface in java.lang"><code>System.getProperties()</code></a>, parsed and converted as with
|
|
<a href="./com/typesafe/config/ConfigFactory.html#parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions)"><code>ConfigFactory.parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions)</code></a>.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_T_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">T</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigObject.html#toConfig()">toConfig()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config">ConfigObject</a></dt>
|
|
<dd>
|
|
<div class="block">Converts this object to a <a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config"><code>Config</code></a> instance, enabling you to use
|
|
path expressions to find values in the object.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_U_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">U</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigList.html#unwrapped()">unwrapped()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigList.html" title="interface in com.typesafe.config">ConfigList</a></dt>
|
|
<dd>
|
|
<div class="block">Recursively unwraps the list, returning a list of plain Java values such
|
|
as Integer or String or whatever is in the list.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigObject.html#unwrapped()">unwrapped()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config">ConfigObject</a></dt>
|
|
<dd>
|
|
<div class="block">Recursively unwraps the object, returning a map from String to whatever
|
|
plain Java values are unwrapped from the object's values.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValue.html#unwrapped()">unwrapped()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config">ConfigValue</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the value as a plain Java boxed value, that is, a <code>String</code>,
|
|
<code>Number</code>, <code>Boolean</code>, <code>Map<String,Object></code>,
|
|
<code>List<Object></code>, or <code>null</code>, matching the <a href="./com/typesafe/config/ConfigValue.html#valueType()"><code>ConfigValue.valueType()</code></a>
|
|
of this <code>ConfigValue</code>.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigOrigin.html#url()">url()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigOrigin.html" title="interface in com.typesafe.config">ConfigOrigin</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a URL describing the origin.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_V_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">V</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigSyntax.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.typesafe.config.<a href="./com/typesafe/config/ConfigSyntax.html" title="enum in com.typesafe.config">ConfigSyntax</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.typesafe.config.<a href="./com/typesafe/config/ConfigValueType.html" title="enum in com.typesafe.config">ConfigValueType</a></dt>
|
|
<dd>
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigSyntax.html#values()">values()</a></span> - Static method in enum com.typesafe.config.<a href="./com/typesafe/config/ConfigSyntax.html" title="enum in com.typesafe.config">ConfigSyntax</a></dt>
|
|
<dd>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValueType.html#values()">values()</a></span> - Static method in enum com.typesafe.config.<a href="./com/typesafe/config/ConfigValueType.html" title="enum in com.typesafe.config">ConfigValueType</a></dt>
|
|
<dd>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValue.html#valueType()">valueType()</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config">ConfigValue</a></dt>
|
|
<dd>
|
|
<div class="block">The <a href="./com/typesafe/config/ConfigValueType.html" title="enum in com.typesafe.config"><code>ConfigValueType</code></a> of the value; matches the JSON type schema.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_W_">
|
|
<!-- -->
|
|
</a>
|
|
<h2 class="title">W</h2>
|
|
<dl>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/Config.html#withFallback(com.typesafe.config.ConfigMergeable)">withFallback(ConfigMergeable)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/Config.html" title="interface in com.typesafe.config">Config</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigIncluder.html#withFallback(com.typesafe.config.ConfigIncluder)">withFallback(ConfigIncluder)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigIncluder.html" title="interface in com.typesafe.config">ConfigIncluder</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a new includer that falls back to the given includer.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigMergeable.html#withFallback(com.typesafe.config.ConfigMergeable)">withFallback(ConfigMergeable)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigMergeable.html" title="interface in com.typesafe.config">ConfigMergeable</a></dt>
|
|
<dd>
|
|
<div class="block">Returns a new value computed by merging this value with another, with
|
|
keys in this value "winning" over the other one.</div>
|
|
</dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigObject.html#withFallback(com.typesafe.config.ConfigMergeable)">withFallback(ConfigMergeable)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigObject.html" title="interface in com.typesafe.config">ConfigObject</a></dt>
|
|
<dd> </dd>
|
|
<dt><span class="strong"><a href="./com/typesafe/config/ConfigValue.html#withFallback(com.typesafe.config.ConfigMergeable)">withFallback(ConfigMergeable)</a></span> - Method in interface com.typesafe.config.<a href="./com/typesafe/config/ConfigValue.html" title="interface in com.typesafe.config">ConfigValue</a></dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<a href="#_A_">A</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_L_">L</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> </div>
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="./com/typesafe/config/package-summary.html">Package</a></li>
|
|
<li>Class</li>
|
|
<li><a href="./com/typesafe/config/package-tree.html">Tree</a></li>
|
|
<li><a href="./deprecated-list.html">Deprecated</a></li>
|
|
<li class="navBarCell1Rev">Index</li>
|
|
<li><a href="./help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev</li>
|
|
<li>Next</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="./index.html?index-all.html" target="_top">Frames</a></li>
|
|
<li><a href="index-all.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>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|