mirror of
https://github.com/mbierlee/mirage-config.git
synced 2024-11-14 20:34:00 +01:00
Add autogenerated documentation
This commit is contained in:
Mike Bierlee
parent
d9e0b61909
commit
75becace37
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,7 +1,6 @@
|
||||||
.dub
|
.dub
|
||||||
docs.json
|
docs.json
|
||||||
__dummy.html
|
__dummy.html
|
||||||
docs/
|
|
||||||
/mirage-config
|
/mirage-config
|
||||||
mirage-config.so
|
mirage-config.so
|
||||||
mirage-config.dylib
|
mirage-config.dylib
|
||||||
|
|
|
||||||
3
docs/css/style.min.css
vendored
Normal file
3
docs/css/style.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
1
docs/file_hashes.json
Normal file
1
docs/file_hashes.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{"mirage\\java\\loadJavaProperties.html":"3CFB11333EED6108332D9CD224713225","mirage\\java\\JavaPropertiesFactory.parseConfig.html":"7D499617F49F848BD7C4C2DFED47317A","mirage\\config\\SubstituteEnvironmentVariables.html":"363CDE300F2C363095DEAACD1794591E","mirage\\config\\SubstituteConfigVariables.html":"DC1AA3901EFBFA70804043EED478F84B","mirage\\config\\ConfigCreationException.html":"8A3502A9D94F6B1B50B184460655BF82","mirage\\json.html":"0C5EEB2E81199B95457E2F6929F1D7D7","mirage\\config\\ConfigPathNotFoundException.html":"9EDE0DF8D61260E8E3C7ACD4A9A40BC6","mirage\\json\\loadJsonConfig.html":"F52125B328BCC409E485B85D4F858B68","mirage\\json\\parseJsonConfig.html":"677D3E59D2991BB2B394C1E4460CEB82","mirage\\java.html":"8034CDC674527F61443A662554C9F89A","mirage\\config\\PathParseException.html":"43C5D15980EA97E0B9667751B08096F2","mirage\\java\\JavaPropertiesFactory.html":"7E16C638D80689922EC8567ED470C0FA","mirage\\config\\ConfigFactory.parseConfig.html":"D8CF3B738A4BDEE8CC82ED0BBAFE3337","mirage\\config\\ConfigFactory.loadFile.html":"14032712C1F7B5F6E02832AF0D3CD17F","mirage\\config\\ConfigNode.html":"4B55A2D7047031068C722360E5D094E7","mirage\\config\\ArrayNode.html":"E3B94306051791B22AB1BF50087F97FA","mirage\\config\\ObjectNode.html":"7B0AD2303C0B6F7B4F15FC3583F32318","mirage\\json\\JsonConfigFactory.html":"B5135F783DC880D1B209347CF99AF37F","mirage\\config\\ConfigDictionary.set.html":"F24F485FA9502315F265FE1306D4DDAB","mirage\\config\\ConfigFactory.html":"11858B67D8FA24642C70462F51D599E4","sitemap.xml":"373867A581E2C882A8180864112DDF02","index.html":"8D84495B941A7CE322883F7DF09C4D77","mirage\\config\\ConfigDictionary.get.html":"DE33737B0DB3460F513D2A81442382BB","symbols.js":"B5572FB75F19E2D3AA53D193EAAF71FD","mirage\\java\\parseJavaProperties.html":"B51432D0C5B2E1E11DC82CE108275712","mirage\\json\\JsonConfigFactory.parseJson.html":"05749B35FD8D0D99BDB794F20A19A202","mirage\\config\\ConfigDictionary.html":"F7F2D064BE54A54F0211BA840D3E6E1F","mirage\\config\\ConfigReadException.html":"DEC45E3788EC5824C38EB60AA51F42C2","mirage\\config\\ConfigDictionary.getConfig.html":"A49B86FAFC8DF95CAD8DE34D5BF91588","mirage.html":"6086E13195053C9A596A09E992F414FF","mirage\\config.html":"C91969C8EE9AAE237E7B6E7380D4EED7","mirage\\json\\JsonConfigFactory.parseConfig.html":"80D0185E3FC7C6EF33E17583F2C918B5","mirage\\config\\ValueNode.html":"66538106380060D5C0810FF79FB192C4"}
|
||||||
BIN
docs/fonts/fontello.woff
Normal file
BIN
docs/fonts/fontello.woff
Normal file
Binary file not shown.
BIN
docs/fonts/raleway-regular.woff
Normal file
BIN
docs/fonts/raleway-regular.woff
Normal file
Binary file not shown.
104
docs/index.html
Normal file
104
docs/index.html
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>API documentation</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 ">
|
||||||
|
<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>API documentation</h1>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Module</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="./mirage/config.html">mirage.config</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Base utilities for working with configurations.
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="./mirage/java.html">mirage.java</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Utilities for loading Java properties files.
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="./mirage/json.html">mirage.json</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Utilities for loading JSON configurations.
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="./mirage.html">mirage</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
<div id="license-info"></div>
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
13
docs/js/script.min.js
vendored
Normal file
13
docs/js/script.min.js
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
var searchCounter,lastSearchString
|
||||||
|
function setupDdox(){for(var e=document.querySelectorAll(".tree-view .package"),t=0;t<e.length;++t)e[t].addEventListener("click",toggleTree)
|
||||||
|
for(e=document.querySelectorAll(".tree-view .package a"),t=0;t<e.length;++t)e[t].addEventListener("click",function(e){e.stopPropagation()})
|
||||||
|
for(e=document.querySelectorAll(".tree-view.collapsed ul"),t=0;t<e.length;++t)e[t].style.display="none"
|
||||||
|
document.getElementById("symbolSearch").setAttribute("tabindex","1000")}function toggleTree(e){var t,l,n,s=this.parentNode
|
||||||
|
for(s.classList.toggle("collapsed"),t=s.children,l=s.classList.contains("collapsed")?"none":"block",n=1;n<t.length;++n)t[n].style.display=l
|
||||||
|
return this.style.display="none",!(this.style.display="block")}function performSymbolSearch(e,t){var l,m,n,s,r,a,i,o,h,c,d,u,g,p,y=function(e){return document.getElementById(e)}
|
||||||
|
if("undefined"===e&&(e=26),void 0===t&&(t=40),(l=y("symbolSearch").value.toLowerCase())!=lastSearchString&&(lastSearchString=l,++searchCounter,y("symbolSearchResults").style.display="none",y("symbolSearchResults").innerHTML="",y("symbolSearch").classList.remove("with_results"),!(0==(m=l.trim().split(/\s+/)).length||1==m.length&&m[0].length<2))){for(n=[],s=0;s<symbols.length;++s){for(o in r=symbols[s],a=!0,m)if(r.name.toLowerCase().indexOf(m[o])<0){a=!1
|
||||||
|
break}a&&n.push(r)}for(n.sort(function(e,t){var l,n,s,r,a,i,o,h,c,d,u=0<=e.attributes.indexOf("deprecated"),g=0<=t.attributes.indexOf("deprecated")
|
||||||
|
return u!=g?u-g:(l=e.name.toLowerCase(),n=t.name.toLowerCase(),s=l.split("."),r=n.split("."),a=s[s.length-1],i=r[r.length-1],(o=0<=m.indexOf(a))!=(h=0<=m.indexOf(i))?h-o:(c=f(s))!=(d=f(r))?c-d:s.length<r.length?-1:s.length>r.length?1:a.length<i.length?-1:a.length>i.length?1:l<n?-1:n<l?1:0)}),s=0;s<n.length&&s<t;s++){for(r=n[s],(i=document.createElement("li")).classList.add(r.kind),o=0;o<r.attributes.length;++o)i.classList.add(r.attributes[o])
|
||||||
|
for(u="."+(c=(h=r.name).split("."))[d=c.length-1];0<d&&c[d-1].length+u.length<=e;)u="."+c[--d]+u
|
||||||
|
u=0<d?".."+u:u.substr(1),(g=document.createElement("a")).setAttribute("href",symbolSearchRootDir+r.path),g.setAttribute("title",h),g.setAttribute("tabindex",1001),g.textContent=u,i.appendChild(g),y("symbolSearchResults").appendChild(i)}n.length>t&&((p=document.createElement("li")).innerHTML="…"+(n.length-100)+" additional results",y("symbolSearchResults").appendChild(p)),n.length&&(y("symbolSearchResults").style.display="initial",y("symbolSearch").classList.add("with_results"))}function f(e){for(var t=e.length-1;0<=t;t--)for(o in m)if(e[t].length>=m[o].length&&e[t].substr(0,m[o].length)==m[o])return e.length-1-t
|
||||||
|
return e.length}}searchCounter=0,lastSearchString=""
|
||||||
75
docs/mirage.html
Normal file
75
docs/mirage.html
Normal file
|
|
@ -0,0 +1,75 @@
|
||||||
|
<!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</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 selected">
|
||||||
|
<a href="./mirage.html">mirage</a>
|
||||||
|
</div>
|
||||||
|
<ul class="tree-view">
|
||||||
|
<li>
|
||||||
|
<div class="module ">
|
||||||
|
<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</h1><p></p>
|
||||||
|
<section></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>
|
||||||
219
docs/mirage/config.html
Normal file
219
docs/mirage/config.html
Normal file
|
|
@ -0,0 +1,219 @@
|
||||||
|
<!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>
|
||||||
89
docs/mirage/config/ArrayNode.html
Normal file
89
docs/mirage/config/ArrayNode.html
Normal file
|
|
@ -0,0 +1,89 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ArrayNode</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>Class ArrayNode</h1><p>A configuration item that is an array.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ArrayNode</span>
|
||||||
|
<br> : <a href="../../mirage/config/ConfigNode.html"><span class="typ">ConfigNode</span></a>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section><p>Contains other ConfigNodes as children.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/ConfigCreationException.html
Normal file
86
docs/mirage/config/ConfigCreationException.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ConfigCreationException</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>Class ConfigCreationException</h1><p>Used by ConfigFactory instances when loading or parsing configuration fails.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ConfigCreationException</span>
|
||||||
|
<br> : <span class="pln">object<wbr/></span><span class="pun">.</span><span class="typ">Exception</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
202
docs/mirage/config/ConfigDictionary.get.html
Normal file
202
docs/mirage/config/ConfigDictionary.get.html
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>ConfigDictionary.get - multiple declarations</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>ConfigDictionary.get - multiple declarations</h1>
|
||||||
|
<nav class="page-nav">
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="#0">
|
||||||
|
Function <code>ConfigDictionary.get</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#1">
|
||||||
|
Function <code>ConfigDictionary.get</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#2">
|
||||||
|
Function <code>ConfigDictionary.get</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav><h2 id="0">Function ConfigDictionary.get</h2><p>Get values from the configuration using config path notation.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="typ">string</span> <span class="pln">get</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">configPath</span><span class="pun">,</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">defaultValue</span> <span class="pun">=</span> <span class="kwd">null</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="configPath">configPath</td><td> Path to the wanted config value. The path is separated by dots, e.g. "server.public.hostname".
|
||||||
|
Values from arrays can be selected by brackets, for example: "server[3].hostname.ports[0]".
|
||||||
|
When the config is just a value, for example just a string, it can be fetched by just specifying "." as path.
|
||||||
|
Although the path should be universally the same over all types of config files, some might not lend to this structure,
|
||||||
|
and have a more specific way of retrieving data from the config. See the examples and specific config factories for
|
||||||
|
more details.</td></tr>
|
||||||
|
<tr><td id="defaultValue">defaultValue</td><td> (Optional) Value to return when the given configPath is invalid. When not supplied a ConfigPathNotFoundException exception is thrown.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Throws</h3>
|
||||||
|
<p>ConfigReadException when something goes wrong reading the config.
|
||||||
|
ConfigPathNotFoundException when the given path does not exist in the config.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The value at the path in the configuration. To convert it use get!T().
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<h2 id="1">Function ConfigDictionary.get</h2><p>Get values from the configuration and attempts to convert them to the specified type.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="typ">ConvertToType</span> <span class="pln">get</span>(ConvertToType)
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">configPath</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="configPath">configPath</td><td> Path to the wanted config value. See get().</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Throws</h3>
|
||||||
|
<p>ConfigReadException when something goes wrong reading the config.
|
||||||
|
ConfigPathNotFoundException when the given path does not exist in the config.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The value at the path in the configuration.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>See Also</h3>
|
||||||
|
<p>get
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<h2 id="2">Function ConfigDictionary.get</h2><p>Get values from the configuration and attempts to convert them to the specified type.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="typ">ConvertToType</span> <span class="pln">get</span>(ConvertToType)
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">configPath</span><span class="pun">,</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">ConvertToType</span> <span class="pln">defaultValue</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="configPath">configPath</td><td> Path to the wanted config value. See get().</td></tr>
|
||||||
|
<tr><td id="defaultValue">defaultValue</td><td> (Optional) Value to return when the given configPath is invalid. When not supplied a ConfigPathNotFoundException exception is thrown.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Throws</h3>
|
||||||
|
<p>ConfigReadException when something goes wrong reading the config.
|
||||||
|
ConfigPathNotFoundException when the given path does not exist in the config.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The value at the path in the configuration.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>See Also</h3>
|
||||||
|
<p>get
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
102
docs/mirage/config/ConfigDictionary.getConfig.html
Normal file
102
docs/mirage/config/ConfigDictionary.getConfig.html
Normal file
|
|
@ -0,0 +1,102 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function ConfigDictionary.getConfig</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>Function ConfigDictionary.getConfig</h1><p>Fetch a sub-section of the config as another config.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">getConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">configPath</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section><p>Commonly used for example to fetch further configuration from arrays, e.g.: <code class="lang-d"><span class="pln">getConfig</span><span class="pun">(</span><span class="str">"http.servers[3]"</span><span class="pun">)</span></code>
|
||||||
|
which then returns the rest of the config at that path.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="configPath">configPath</td><td> Path to the wanted config. See get().</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>A sub-section of the configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
143
docs/mirage/config/ConfigDictionary.html
Normal file
143
docs/mirage/config/ConfigDictionary.html
Normal file
|
|
@ -0,0 +1,143 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ConfigDictionary</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>Class ConfigDictionary</h1><p>A ConfigDictionary contains the configuration tree and facilities to get values from that tree.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ConfigDictionary</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<section><h2>Methods</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.get.html" class="public">
|
||||||
|
<code>get</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(configPath, defaultValue)</span>
|
||||||
|
</td>
|
||||||
|
<td>Get values from the configuration using config path notation.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.get.html" class="public">
|
||||||
|
<code>get</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(configPath)</span>
|
||||||
|
</td>
|
||||||
|
<td>Get values from the configuration and attempts to convert them to the specified type.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.get.html" class="public">
|
||||||
|
<code>get</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(configPath, defaultValue)</span>
|
||||||
|
</td>
|
||||||
|
<td>Get values from the configuration and attempts to convert them to the specified type.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.getConfig.html" class="public">
|
||||||
|
<code>getConfig</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(configPath)</span>
|
||||||
|
</td>
|
||||||
|
<td>Fetch a sub-section of the config as another config.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.set.html" class="public">
|
||||||
|
<code>set</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(configPath, value)</span>
|
||||||
|
</td>
|
||||||
|
<td>Assign a value at the given path.
|
||||||
|
</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>
|
||||||
98
docs/mirage/config/ConfigDictionary.set.html
Normal file
98
docs/mirage/config/ConfigDictionary.set.html
Normal file
|
|
@ -0,0 +1,98 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function ConfigDictionary.set</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>Function ConfigDictionary.set</h1><p>Assign a value at the given path.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="typ">void</span> <span class="pln">set</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">configPath</span><span class="pun">,</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">value</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="configPath">configPath</td><td> Path where to assign the value to. If the path does not exist, it will be created.</td></tr>
|
||||||
|
<tr><td id="value">value</td><td> Value to set at path.</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>
|
||||||
113
docs/mirage/config/ConfigFactory.html
Normal file
113
docs/mirage/config/ConfigFactory.html
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ConfigFactory</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>Class ConfigFactory</h1><p>The base class used by configuration factories for specific file types.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ConfigFactory</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<section><h2>Methods</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigFactory.loadFile.html" class="public">
|
||||||
|
<code>loadFile</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(path)</span>
|
||||||
|
</td>
|
||||||
|
<td>Loads a configuration from the specified path from disk.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigFactory.parseConfig.html" class="public">
|
||||||
|
<code>parseConfig</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(contents)</span>
|
||||||
|
</td>
|
||||||
|
<td>Parse configuration from the given string.
|
||||||
|
</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>
|
||||||
99
docs/mirage/config/ConfigFactory.loadFile.html
Normal file
99
docs/mirage/config/ConfigFactory.loadFile.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function ConfigFactory.loadFile</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>Function ConfigFactory.loadFile</h1><p>Loads a configuration from the specified path from disk.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">loadFile</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">path</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="path">path</td><td> Path to file. OS dependent, but UNIX paths are generally working.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
99
docs/mirage/config/ConfigFactory.parseConfig.html
Normal file
99
docs/mirage/config/ConfigFactory.parseConfig.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function ConfigFactory.parseConfig</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>Function ConfigFactory.parseConfig</h1><p>Parse configuration from the given string.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">contents</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="contents">contents</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/ConfigNode.html
Normal file
86
docs/mirage/config/ConfigNode.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Interface ConfigNode</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>Interface ConfigNode</h1><p>The configuration tree is made up of specific types of ConfigNodes.
|
||||||
|
Used as generic type for ConfigFactory and ConfigDictionary.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">interface</span> <span class="typ">ConfigNode</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/ConfigPathNotFoundException.html
Normal file
86
docs/mirage/config/ConfigPathNotFoundException.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ConfigPathNotFoundException</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>Class ConfigPathNotFoundException</h1><p>Used by ConfigDictionary when the supplied path does not exist.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ConfigPathNotFoundException</span>
|
||||||
|
<br> : <span class="pln">object<wbr/></span><span class="pun">.</span><span class="typ">Exception</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/ConfigReadException.html
Normal file
86
docs/mirage/config/ConfigReadException.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ConfigReadException</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>Class ConfigReadException</h1><p>Used by the ConfigDictionary when something goes wrong when reading configuration.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ConfigReadException</span>
|
||||||
|
<br> : <span class="pln">object<wbr/></span><span class="pun">.</span><span class="typ">Exception</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
89
docs/mirage/config/ObjectNode.html
Normal file
89
docs/mirage/config/ObjectNode.html
Normal file
|
|
@ -0,0 +1,89 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ObjectNode</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>Class ObjectNode</h1><p>A configuration item that is an object.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ObjectNode</span>
|
||||||
|
<br> : <a href="../../mirage/config/ConfigNode.html"><span class="typ">ConfigNode</span></a>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section><p>ObjectNodes contain a node dictionary that points to other ConfigNodes.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/PathParseException.html
Normal file
86
docs/mirage/config/PathParseException.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class PathParseException</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>Class PathParseException</h1><p>Used by ConfigDictionary when there is something wrong with the path when calling ConfigDictionary.get()
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">PathParseException</span>
|
||||||
|
<br> : <span class="pln">object<wbr/></span><span class="pun">.</span><span class="typ">Exception</span>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
85
docs/mirage/config/SubstituteConfigVariables.html
Normal file
85
docs/mirage/config/SubstituteConfigVariables.html
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Alias SubstituteConfigVariables</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>Alias SubstituteConfigVariables</h1><p>Used in a ConfigDictionary to enable to disable config path substitution.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">alias</span> <span class="pln">SubstituteConfigVariables</span>
|
||||||
|
<span class="pun">=</span> <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")<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
85
docs/mirage/config/SubstituteEnvironmentVariables.html
Normal file
85
docs/mirage/config/SubstituteEnvironmentVariables.html
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Alias SubstituteEnvironmentVariables</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>Alias SubstituteEnvironmentVariables</h1><p>Used in a ConfigDictionary to enable to disable environment variable substitution.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">alias</span> <span class="pln">SubstituteEnvironmentVariables</span>
|
||||||
|
<span class="pun">=</span> <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")<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
86
docs/mirage/config/ValueNode.html
Normal file
86
docs/mirage/config/ValueNode.html
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class ValueNode</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>Class ValueNode</h1><p>A configuration item that is any sort of primitive value (strings, numbers or null).
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">ValueNode</span>
|
||||||
|
<br> : <a href="../../mirage/config/ConfigNode.html"><span class="typ">ConfigNode</span></a>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
122
docs/mirage/java.html
Normal file
122
docs/mirage/java.html
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<!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.java</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 ">
|
||||||
|
<a href="../mirage/config.html">config</a>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<div class="module selected">
|
||||||
|
<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.java</h1><p>Utilities for loading Java properties files.
|
||||||
|
</p><section></section>
|
||||||
|
|
||||||
|
<section></section>
|
||||||
|
<section>
|
||||||
|
<h2>Functions</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<code>
|
||||||
|
<a id="loadJavaProperties" class="public" href="../mirage/java/loadJavaProperties.html">loadJavaProperties</a><span class="tableEntryAnnotation">(filePath)</span>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Load a Java properties file from disk.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<code>
|
||||||
|
<a id="parseJavaProperties" class="public" href="../mirage/java/parseJavaProperties.html">parseJavaProperties</a><span class="tableEntryAnnotation">(properties)</span>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Parse Java properties from the given Java properties string.
|
||||||
|
</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="JavaPropertiesFactory" class="public" href="../mirage/java/JavaPropertiesFactory.html">JavaPropertiesFactory</a>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Creates configuration files from Java properties.
|
||||||
|
</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>
|
||||||
114
docs/mirage/java/JavaPropertiesFactory.html
Normal file
114
docs/mirage/java/JavaPropertiesFactory.html
Normal file
|
|
@ -0,0 +1,114 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class JavaPropertiesFactory</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 ">
|
||||||
|
<a href="../../mirage/config.html">config</a>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<div class="module selected">
|
||||||
|
<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>Class JavaPropertiesFactory</h1><p>Creates configuration files from Java properties.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">JavaPropertiesFactory</span>
|
||||||
|
<br> : <a href="../../mirage/config/ConfigFactory.html"><span class="typ">ConfigFactory</span></a>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<section><h2>Methods</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/java/JavaPropertiesFactory.parseConfig.html" class="public">
|
||||||
|
<code>parseConfig</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(contents)</span>
|
||||||
|
</td>
|
||||||
|
<td>Parse configuration from the given Java properties string.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigFactory.loadFile.html" class="public inherited">
|
||||||
|
<code>loadFile</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(path)</span>
|
||||||
|
</td>
|
||||||
|
<td>Loads a configuration from the specified path from disk.
|
||||||
|
</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>
|
||||||
99
docs/mirage/java/JavaPropertiesFactory.parseConfig.html
Normal file
99
docs/mirage/java/JavaPropertiesFactory.parseConfig.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function JavaPropertiesFactory.parseConfig</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 ">
|
||||||
|
<a href="../../mirage/config.html">config</a>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<div class="module selected">
|
||||||
|
<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>Function JavaPropertiesFactory.parseConfig</h1><p>Parse configuration from the given Java properties string.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">override </span><a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">contents</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="contents">contents</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
99
docs/mirage/java/loadJavaProperties.html
Normal file
99
docs/mirage/java/loadJavaProperties.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function loadJavaProperties</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 ">
|
||||||
|
<a href="../../mirage/config.html">config</a>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<div class="module selected">
|
||||||
|
<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>Function loadJavaProperties</h1><p>Load a Java properties file from disk.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">loadJavaProperties</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">filePath</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="filePath">filePath</td><td> Path to the Java properties file.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The loaded configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
99
docs/mirage/java/parseJavaProperties.html
Normal file
99
docs/mirage/java/parseJavaProperties.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function parseJavaProperties</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 ">
|
||||||
|
<a href="../../mirage/config.html">config</a>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<div class="module selected">
|
||||||
|
<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>Function parseJavaProperties</h1><p>Parse Java properties from the given Java properties string.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseJavaProperties</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">properties</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="properties">properties</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
131
docs/mirage/json.html
Normal file
131
docs/mirage/json.html
Normal file
|
|
@ -0,0 +1,131 @@
|
||||||
|
<!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.json</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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.json</h1><p>Utilities for loading JSON configurations.
|
||||||
|
</p><section></section>
|
||||||
|
|
||||||
|
<section></section>
|
||||||
|
<section>
|
||||||
|
<h2>Functions</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<code>
|
||||||
|
<a id="loadJsonConfig" class="public" href="../mirage/json/loadJsonConfig.html">loadJsonConfig</a><span class="tableEntryAnnotation">(filePath)</span>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Load a JSON configuration file from disk.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<code>
|
||||||
|
<a id="parseJsonConfig" class="public" href="../mirage/json/parseJsonConfig.html">parseJsonConfig</a><span class="tableEntryAnnotation">(json)</span>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Parse JSON config from the given JSON string.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<code>
|
||||||
|
<a id="parseJsonConfig" class="public" href="../mirage/json/parseJsonConfig.html">parseJsonConfig</a><span class="tableEntryAnnotation">(json)</span>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Parse JSON config from the given JSONValue.
|
||||||
|
</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="JsonConfigFactory" class="public" href="../mirage/json/JsonConfigFactory.html">JsonConfigFactory</a>
|
||||||
|
</code>
|
||||||
|
</td>
|
||||||
|
<td>Creates configuration dictionaries from JSONs.
|
||||||
|
</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>
|
||||||
134
docs/mirage/json/JsonConfigFactory.html
Normal file
134
docs/mirage/json/JsonConfigFactory.html
Normal file
|
|
@ -0,0 +1,134 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Class JsonConfigFactory</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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>Class JsonConfigFactory</h1><p>Creates configuration dictionaries from JSONs.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">class</span> <span class="typ">JsonConfigFactory</span>
|
||||||
|
<br> : <a href="../../mirage/config/ConfigFactory.html"><span class="typ">ConfigFactory</span></a>
|
||||||
|
<span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<section><h2>Methods</h2>
|
||||||
|
<table>
|
||||||
|
<col class="caption"/>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th><th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/json/JsonConfigFactory.parseConfig.html" class="public">
|
||||||
|
<code>parseConfig</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(contents)</span>
|
||||||
|
</td>
|
||||||
|
<td>Parse configuration from the given JSON string.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/json/JsonConfigFactory.parseJson.html" class="public">
|
||||||
|
<code>parseJson</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(json)</span>
|
||||||
|
</td>
|
||||||
|
<td>Parse configuration from a JSONValue tree.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/json/JsonConfigFactory.parseJson.html" class="public">
|
||||||
|
<code>parseJson</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(json)</span>
|
||||||
|
</td>
|
||||||
|
<td>Alias for parseConfig
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<a href="../../mirage/config/ConfigFactory.loadFile.html" class="public inherited">
|
||||||
|
<code>loadFile</code>
|
||||||
|
</a>
|
||||||
|
<span class="tableEntryAnnotation">(path)</span>
|
||||||
|
</td>
|
||||||
|
<td>Loads a configuration from the specified path from disk.
|
||||||
|
</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>
|
||||||
99
docs/mirage/json/JsonConfigFactory.parseConfig.html
Normal file
99
docs/mirage/json/JsonConfigFactory.parseConfig.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function JsonConfigFactory.parseConfig</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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>Function JsonConfigFactory.parseConfig</h1><p>Parse configuration from the given JSON string.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<span class="kwd">override </span><a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">contents</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="contents">contents</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
142
docs/mirage/json/JsonConfigFactory.parseJson.html
Normal file
142
docs/mirage/json/JsonConfigFactory.parseJson.html
Normal file
|
|
@ -0,0 +1,142 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>JsonConfigFactory.parseJson - multiple declarations</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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>JsonConfigFactory.parseJson - multiple declarations</h1>
|
||||||
|
<nav class="page-nav">
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="#0">
|
||||||
|
Function <code>JsonConfigFactory.parseJson</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#1">
|
||||||
|
Function <code>JsonConfigFactory.parseJson</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav><h2 id="0">Function JsonConfigFactory.parseJson</h2><p>Parse configuration from a JSONValue tree.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseJson</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pln">std<wbr/></span><span class="pun">.</span><span class="pln">json<wbr/></span><span class="pun">.</span><span class="typ">JSONValue</span> <span class="pln">json</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="json">json</td><td> JSONValue config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<h2 id="1">Function JsonConfigFactory.parseJson</h2><p>Alias for parseConfig
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseJson</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="typ">string</span> <span class="pln">json</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="json">json</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section><h3>See Also</h3>
|
||||||
|
<p>parseConfig
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
99
docs/mirage/json/loadJsonConfig.html
Normal file
99
docs/mirage/json/loadJsonConfig.html
Normal file
|
|
@ -0,0 +1,99 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>Function loadJsonConfig</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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>Function loadJsonConfig</h1><p>Load a JSON configuration file from disk.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">loadJsonConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">filePath</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h2>Parameters</h2>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="filePath">filePath</td><td> Path to the JSON configuration file.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h2>Returns</h2>
|
||||||
|
<p>The loaded configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
138
docs/mirage/json/parseJsonConfig.html
Normal file
138
docs/mirage/json/parseJsonConfig.html
Normal file
|
|
@ -0,0 +1,138 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8"/>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
|
||||||
|
<title>parseJsonConfig - multiple declarations</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 ">
|
||||||
|
<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 selected">
|
||||||
|
<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>parseJsonConfig - multiple declarations</h1>
|
||||||
|
<nav class="page-nav">
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="#0">
|
||||||
|
Function <code>parseJsonConfig</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#1">
|
||||||
|
Function <code>parseJsonConfig</code>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav><h2 id="0">Function parseJsonConfig</h2><p>Parse JSON config from the given JSON string.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseJsonConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">json</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="json">json</td><td> Text contents of the config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<h2 id="1">Function parseJsonConfig</h2><p>Parse JSON config from the given JSONValue.
|
||||||
|
</p>
|
||||||
|
<div class="prototype">
|
||||||
|
<code class="lang-d">
|
||||||
|
<div class="single-prototype">
|
||||||
|
<a href="../../mirage/config/ConfigDictionary.html"><span class="typ">ConfigDictionary</span></a> <span class="pln">parseJsonConfig</span>
|
||||||
|
<span class="pun">(</span>
|
||||||
|
<br/>
|
||||||
|
<span class="kwd">const</span><span class="pun">(</span><span class="pln">std<wbr/></span><span class="pun">.</span><span class="pln">json<wbr/></span><span class="pun">.</span><span class="typ">JSONValue</span><span class="pun">)</span> <span class="pln">json</span>
|
||||||
|
<br/>
|
||||||
|
<span class="pun">)</span><span class="pun">;</span>
|
||||||
|
</div>
|
||||||
|
</code>
|
||||||
|
</div>
|
||||||
|
<section></section>
|
||||||
|
|
||||||
|
<section><h3>Parameters</h3>
|
||||||
|
<table><col class="caption"><tr><th>Name</th><th>Description</th></tr>
|
||||||
|
<tr><td id="json">json</td><td> JSONValue config to be parsed.</td></tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section><h3>Returns</h3>
|
||||||
|
<p>The parsed configuration.
|
||||||
|
</p>
|
||||||
|
</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>
|
||||||
40
docs/sitemap.xml
Normal file
40
docs/sitemap.xml
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
|
<url><loc>http://127.0.0.1/index.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ArrayNode.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigCreationException.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.get.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.get.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.get.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.getConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigDictionary.set.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigFactory.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigFactory.loadFile.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigFactory.parseConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigNode.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigPathNotFoundException.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigReadException.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ObjectNode.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/PathParseException.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/SubstituteConfigVariables.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/SubstituteEnvironmentVariables.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ValueNode.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/java.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/java/JavaPropertiesFactory.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/java/JavaPropertiesFactory.parseConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigFactory.loadFile.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/java/loadJavaProperties.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/java/parseJavaProperties.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/JsonConfigFactory.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/JsonConfigFactory.parseConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/JsonConfigFactory.parseJson.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/JsonConfigFactory.parseJson.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/config/ConfigFactory.loadFile.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/loadJsonConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/parseJsonConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage/json/parseJsonConfig.html</loc></url>
|
||||||
|
<url><loc>http://127.0.0.1/mirage.html</loc></url>
|
||||||
|
</urlset>
|
||||||
33
docs/symbols.js
Normal file
33
docs/symbols.js
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
// symbol index generated by DDOX - do not edit
|
||||||
|
var symbols = [
|
||||||
|
{name: 'mirage.config', kind: "module", path: './mirage/config.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ArrayNode', kind: "classdeclaration", path: './mirage/config/ArrayNode.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigCreationException', kind: "classdeclaration", path: './mirage/config/ConfigCreationException.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigDictionary', kind: "classdeclaration", path: './mirage/config/ConfigDictionary.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigDictionary.get', kind: "functiondeclaration", path: './mirage/config/ConfigDictionary.get.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigDictionary.getConfig', kind: "functiondeclaration", path: './mirage/config/ConfigDictionary.getConfig.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigDictionary.set', kind: "functiondeclaration", path: './mirage/config/ConfigDictionary.set.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigFactory', kind: "classdeclaration", path: './mirage/config/ConfigFactory.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigFactory.loadFile', kind: "functiondeclaration", path: './mirage/config/ConfigFactory.loadFile.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigFactory.parseConfig', kind: "functiondeclaration", path: './mirage/config/ConfigFactory.parseConfig.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigNode', kind: "interfacedeclaration", path: './mirage/config/ConfigNode.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigPathNotFoundException', kind: "classdeclaration", path: './mirage/config/ConfigPathNotFoundException.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ConfigReadException', kind: "classdeclaration", path: './mirage/config/ConfigReadException.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ObjectNode', kind: "classdeclaration", path: './mirage/config/ObjectNode.html', attributes: []},
|
||||||
|
{name: 'mirage.config.PathParseException', kind: "classdeclaration", path: './mirage/config/PathParseException.html', attributes: []},
|
||||||
|
{name: 'mirage.config.SubstituteConfigVariables', kind: "aliasdeclaration", path: './mirage/config/SubstituteConfigVariables.html', attributes: []},
|
||||||
|
{name: 'mirage.config.SubstituteEnvironmentVariables', kind: "aliasdeclaration", path: './mirage/config/SubstituteEnvironmentVariables.html', attributes: []},
|
||||||
|
{name: 'mirage.config.ValueNode', kind: "classdeclaration", path: './mirage/config/ValueNode.html', attributes: []},
|
||||||
|
{name: 'mirage.java', kind: "module", path: './mirage/java.html', attributes: []},
|
||||||
|
{name: 'mirage.java.JavaPropertiesFactory', kind: "classdeclaration", path: './mirage/java/JavaPropertiesFactory.html', attributes: []},
|
||||||
|
{name: 'mirage.java.JavaPropertiesFactory.parseConfig', kind: "functiondeclaration", path: './mirage/java/JavaPropertiesFactory.parseConfig.html', attributes: ["override"]},
|
||||||
|
{name: 'mirage.java.loadJavaProperties', kind: "functiondeclaration", path: './mirage/java/loadJavaProperties.html', attributes: []},
|
||||||
|
{name: 'mirage.java.parseJavaProperties', kind: "functiondeclaration", path: './mirage/java/parseJavaProperties.html', attributes: []},
|
||||||
|
{name: 'mirage.json', kind: "module", path: './mirage/json.html', attributes: []},
|
||||||
|
{name: 'mirage.json.JsonConfigFactory', kind: "classdeclaration", path: './mirage/json/JsonConfigFactory.html', attributes: []},
|
||||||
|
{name: 'mirage.json.JsonConfigFactory.parseConfig', kind: "functiondeclaration", path: './mirage/json/JsonConfigFactory.parseConfig.html', attributes: ["override"]},
|
||||||
|
{name: 'mirage.json.JsonConfigFactory.parseJson', kind: "functiondeclaration", path: './mirage/json/JsonConfigFactory.parseJson.html', attributes: []},
|
||||||
|
{name: 'mirage.json.loadJsonConfig', kind: "functiondeclaration", path: './mirage/json/loadJsonConfig.html', attributes: []},
|
||||||
|
{name: 'mirage.json.parseJsonConfig', kind: "functiondeclaration", path: './mirage/json/parseJsonConfig.html', attributes: []},
|
||||||
|
{name: 'mirage', kind: "module", path: './mirage.html', attributes: []},
|
||||||
|
];
|
||||||
|
|
@ -59,7 +59,7 @@ class JavaPropertiesFactory : ConfigFactory {
|
||||||
* Parse Java properties from the given Java properties string.
|
* Parse Java properties from the given Java properties string.
|
||||||
|
|
||||||
* Params:
|
* Params:
|
||||||
* json = Text contents of the config to be parsed.
|
* properties = Text contents of the config to be parsed.
|
||||||
* Returns: The parsed configuration.
|
* Returns: The parsed configuration.
|
||||||
*/
|
*/
|
||||||
ConfigDictionary parseJavaProperties(const string properties) {
|
ConfigDictionary parseJavaProperties(const string properties) {
|
||||||
|
|
|
||||||
|
|
@ -36,7 +36,7 @@ class JsonConfigFactory : ConfigFactory {
|
||||||
* Parse configuration from a JSONValue tree.
|
* Parse configuration from a JSONValue tree.
|
||||||
*
|
*
|
||||||
* Params:
|
* Params:
|
||||||
* contents = JSONValue config to be parsed.
|
* json = JSONValue config to be parsed.
|
||||||
* Returns: The parsed configuration.
|
* Returns: The parsed configuration.
|
||||||
*/
|
*/
|
||||||
ConfigDictionary parseJson(JSONValue json) {
|
ConfigDictionary parseJson(JSONValue json) {
|
||||||
|
|
@ -47,7 +47,7 @@ class JsonConfigFactory : ConfigFactory {
|
||||||
* Alias for parseConfig
|
* Alias for parseConfig
|
||||||
*
|
*
|
||||||
* Params:
|
* Params:
|
||||||
* contents = Text contents of the config to be parsed.
|
* json = Text contents of the config to be parsed.
|
||||||
* Returns: The parsed configuration.
|
* Returns: The parsed configuration.
|
||||||
* See_Also: parseConfig
|
* See_Also: parseConfig
|
||||||
*/
|
*/
|
||||||
|
|
@ -111,7 +111,7 @@ ConfigDictionary parseJsonConfig(const string json) {
|
||||||
* Parse JSON config from the given JSONValue.
|
* Parse JSON config from the given JSONValue.
|
||||||
*
|
*
|
||||||
* Params:
|
* Params:
|
||||||
* contents = JSONValue config to be parsed.
|
* json = JSONValue config to be parsed.
|
||||||
* Returns: The parsed configuration.
|
* Returns: The parsed configuration.
|
||||||
*/
|
*/
|
||||||
ConfigDictionary parseJsonConfig(const JSONValue json) {
|
ConfigDictionary parseJsonConfig(const JSONValue json) {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue