mirror of
https://github.com/mbierlee/mirage-config.git
synced 2024-11-15 04:44:01 +01:00
219 lines
6.8 KiB
HTML
219 lines
6.8 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||
|
|
<title>Module mirage.config</title>
|
||
|
|
<link rel="stylesheet" href="../css/style.min.css"/>
|
||
|
|
<script type="text/javascript" src="../js/script.min.js"></script>
|
||
|
|
</head>
|
||
|
|
<body onload="setupDdox();">
|
||
|
|
<header></header>
|
||
|
|
<nav id="main-nav">
|
||
|
|
<div>
|
||
|
|
<noscript>
|
||
|
|
<p style="color: red">The search functionality needs JavaScript enabled</p>
|
||
|
|
</noscript>
|
||
|
|
<div id="symbolSearchPane" style="display: none">
|
||
|
|
<form action="#" method="GET">
|
||
|
|
<input id="symbolSearch" type="text" name="q" placeholder="Search for symbols" autocomplete="off" onchange="performSymbolSearch(24);" onkeypress="this.onchange();" onpaste="this.onchange();" oninput="this.onchange();" autofocus/>
|
||
|
|
</form>
|
||
|
|
<ul id="symbolSearchResults" class="symbolList" style="display: none"></ul><script type="application/javascript" src="../symbols.js"></script><script type="application/javascript">var symbolSearchRootDir = "../";
|
||
|
|
document.getElementById('symbolSearchPane').style.display = 'block';</script>
|
||
|
|
</div>
|
||
|
|
<ul class="tree-view">
|
||
|
|
<li class="tree-view ">
|
||
|
|
<div class="package ">
|
||
|
|
<a href="../mirage.html">mirage</a>
|
||
|
|
</div>
|
||
|
|
<ul class="tree-view">
|
||
|
|
<li>
|
||
|
|
<div class="module selected">
|
||
|
|
<a href="../mirage/config.html">config</a>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<div class="module ">
|
||
|
|
<a href="../mirage/java.html">java</a>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<div class="module ">
|
||
|
|
<a href="../mirage/json.html">json</a>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<p id="main-nav-footer">
|
||
|
|
Built with
|
||
|
|
<a href="https://github.com/MartinNowak/scod">scod</a>
|
||
|
|
</p>
|
||
|
|
</nav>
|
||
|
|
<div id="main-contents">
|
||
|
|
<div>
|
||
|
|
<h1>Module mirage.config</h1><p>Base utilities for working with configurations.
|
||
|
|
</p><section></section>
|
||
|
|
|
||
|
|
<section></section>
|
||
|
|
<section>
|
||
|
|
<h2>Interfaces</h2>
|
||
|
|
<table>
|
||
|
|
<col class="caption"/>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th><th>Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigNode" class="public" href="../mirage/config/ConfigNode.html">ConfigNode</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>The configuration tree is made up of specific types of ConfigNodes.
|
||
|
|
Used as generic type for ConfigFactory and ConfigDictionary.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
<section>
|
||
|
|
<h2>Classes</h2>
|
||
|
|
<table>
|
||
|
|
<col class="caption"/>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th><th>Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ArrayNode" class="public" href="../mirage/config/ArrayNode.html">ArrayNode</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>A configuration item that is an array.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigCreationException" class="public" href="../mirage/config/ConfigCreationException.html">ConfigCreationException</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>Used by ConfigFactory instances when loading or parsing configuration fails.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigDictionary" class="public" href="../mirage/config/ConfigDictionary.html">ConfigDictionary</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>A ConfigDictionary contains the configuration tree and facilities to get values from that tree.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigFactory" class="public" href="../mirage/config/ConfigFactory.html">ConfigFactory</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>The base class used by configuration factories for specific file types.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigPathNotFoundException" class="public" href="../mirage/config/ConfigPathNotFoundException.html">ConfigPathNotFoundException</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>Used by ConfigDictionary when the supplied path does not exist.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ConfigReadException" class="public" href="../mirage/config/ConfigReadException.html">ConfigReadException</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>Used by the ConfigDictionary when something goes wrong when reading configuration.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ObjectNode" class="public" href="../mirage/config/ObjectNode.html">ObjectNode</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>A configuration item that is an object.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="PathParseException" class="public" href="../mirage/config/PathParseException.html">PathParseException</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>Used by ConfigDictionary when there is something wrong with the path when calling ConfigDictionary.get()
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<a id="ValueNode" class="public" href="../mirage/config/ValueNode.html">ValueNode</a>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>A configuration item that is any sort of primitive value (strings, numbers or null).
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
<section>
|
||
|
|
<h2>Aliases</h2>
|
||
|
|
<table>
|
||
|
|
<col class="caption"/>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th><th>Type</th><th>Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<a id="SubstituteConfigVariables" class="public" href="../mirage/config/SubstituteConfigVariables.html">
|
||
|
|
<code>SubstituteConfigVariables</code>
|
||
|
|
</a>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code class="prettyprint lang-d"><span class="pln">std<wbr/></span><span class="pun">.</span><span class="pln">typecons<wbr/></span><span class="pun">.</span><span class="typ">Flag</span>!("SubstituteConfigVariables")</code>
|
||
|
|
</td>
|
||
|
|
<td>Used in a ConfigDictionary to enable to disable config path substitution.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<a id="SubstituteEnvironmentVariables" class="public" href="../mirage/config/SubstituteEnvironmentVariables.html">
|
||
|
|
<code>SubstituteEnvironmentVariables</code>
|
||
|
|
</a>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code class="prettyprint lang-d"><span class="pln">std<wbr/></span><span class="pun">.</span><span class="pln">typecons<wbr/></span><span class="pun">.</span><span class="typ">Flag</span>!("SubstituteEnvironmentVariables")</code>
|
||
|
|
</td>
|
||
|
|
<td>Used in a ConfigDictionary to enable to disable environment variable substitution.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
<div id="license-info">
|
||
|
|
<p>Mike Bierlee, m.bierlee@lostmoment.com
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>2022 Mike Bierlee
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>This software is licensed under the terms of the MIT license.
|
||
|
|
The full terms of the license can be found in the LICENSE file.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|