Plan/all/com/djrapitops/plan/system/settings/config/ConfigValueParser.html

338 lines
16 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2019-08-21 11:10:29 +02:00
<!-- Generated by javadoc (1.8.0_201) on Wed Aug 21 12:09:04 EEST 2019 -->
<title>ConfigValueParser (Plan 4.9.4 API)</title>
<meta name="date" content="2019-08-21">
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2019-08-21 11:10:29 +02:00
parent.document.title="ConfigValueParser (Plan 4.9.4 API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":17,"i3":17,"i4":17};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigReader.html" title="class in com.djrapitops.plan.system.settings.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.BooleanParser.html" title="class in com.djrapitops.plan.system.settings.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/system/settings/config/ConfigValueParser.html" target="_top">Frames</a></li>
<li><a href="ConfigValueParser.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.system.settings.config</div>
<h2 title="Interface ConfigValueParser" class="title">Interface ConfigValueParser&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object being parsed.</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.BooleanParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.BooleanParser</a>, <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.IntegerParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.IntegerParser</a>, <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.LongParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.LongParser</a>, <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.StringListParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.StringListParser</a>, <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.StringParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.StringParser</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ConfigValueParser&lt;T&gt;</span></pre>
<div class="block">Utilities for parsing config values.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.BooleanParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.BooleanParser</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.IntegerParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.IntegerParser</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.LongParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.LongParser</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.StringListParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.StringListParser</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.StringParser.html" title="class in com.djrapitops.plan.system.settings.config">ConfigValueParser.StringParser</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html#compose-java.lang.String-">compose</a></span>(java.lang.String&nbsp;fromValue)</code>
<div class="block">Parse a String value in the config into the appropriate object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html#decompose-T-">decompose</a></span>(<a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a>&nbsp;ofValue)</code>
<div class="block">Parse an object into a String value to save in the config.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="interface in com.djrapitops.plan.system.settings.config">ConfigValueParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html#getParserFor-java.lang.Class-">getParserFor</a></span>(java.lang.Class&nbsp;type)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.IllegalArgumentException</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html#nullInvalidException--">nullInvalidException</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="interface in com.djrapitops.plan.system.settings.config">ConfigValueParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html#toStringParser--">toStringParser</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParserFor-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParserFor</h4>
<pre>static&nbsp;<a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="interface in com.djrapitops.plan.system.settings.config">ConfigValueParser</a>&nbsp;getParserFor(java.lang.Class&nbsp;type)</pre>
</li>
</ul>
<a name="toStringParser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toStringParser</h4>
<pre>static&nbsp;<a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="interface in com.djrapitops.plan.system.settings.config">ConfigValueParser</a>&nbsp;toStringParser()</pre>
</li>
</ul>
<a name="compose-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compose</h4>
<pre><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a>&nbsp;compose(java.lang.String&nbsp;fromValue)</pre>
<div class="block">Parse a String value in the config into the appropriate object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromValue</code> - String value in the config.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Config value or null if it could not be parsed.</dd>
</dl>
</li>
</ul>
<a name="decompose-java.lang.Object-">
<!-- -->
</a><a name="decompose-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decompose</h4>
<pre>java.lang.String&nbsp;decompose(<a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a>&nbsp;ofValue)</pre>
<div class="block">Parse an object into a String value to save in the config.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ofValue</code> - Value to save, not null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String format to save in the config.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If null value is given.</dd>
</dl>
</li>
</ul>
<a name="nullInvalidException--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nullInvalidException</h4>
<pre>static&nbsp;java.lang.IllegalArgumentException&nbsp;nullInvalidException()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigReader.html" title="class in com.djrapitops.plan.system.settings.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/system/settings/config/ConfigValueParser.BooleanParser.html" title="class in com.djrapitops.plan.system.settings.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/system/settings/config/ConfigValueParser.html" target="_top">Frames</a></li>
<li><a href="ConfigValueParser.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>