mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
220 lines
16 KiB
HTML
220 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ConfigValueParser (Plan 5.5-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.settings.config, interface: ConfigValueParser">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.settings.config</a></div>
|
|
<h1 title="Interface ConfigValueParser" class="title">Interface ConfigValueParser<T></h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object being parsed.</dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="ConfigValueParser.BooleanParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.BooleanParser</a></code>, <code><a href="ConfigValueParser.DoubleParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.DoubleParser</a></code>, <code><a href="ConfigValueParser.IntegerParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.IntegerParser</a></code>, <code><a href="ConfigValueParser.LongParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.LongParser</a></code>, <code><a href="ConfigValueParser.StringListParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.StringListParser</a></code>, <code><a href="ConfigValueParser.StringParser.html" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.StringParser</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ConfigValueParser<T></span></div>
|
|
<div class="block">Utilities for parsing config values.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="caption"><span>Nested Classes</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Interface</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="ConfigValueParser.BooleanParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.BooleanParser</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>static class </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="ConfigValueParser.DoubleParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.DoubleParser</a></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="ConfigValueParser.IntegerParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.IntegerParser</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>static class </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="ConfigValueParser.LongParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.LongParser</a></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="ConfigValueParser.StringListParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.StringListParser</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>static class </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="ConfigValueParser.StringParser.html" class="type-name-link" title="class in com.djrapitops.plan.settings.config">ConfigValueParser.StringParser</a></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#compose(java.lang.String)" class="member-name-link">compose</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fromValue)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Parse a String value in the config into the appropriate object.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decompose(T)" class="member-name-link">decompose</a><wbr>(<a href="ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a> ofValue)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Parse an object into a String value to save in the config.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="ConfigValueParser.html" title="interface in com.djrapitops.plan.settings.config">ConfigValueParser</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getParserFor(java.lang.Class)" class="member-name-link">getParserFor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> type)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#nullInvalidException()" class="member-name-link">nullInvalidException</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="ConfigValueParser.html" title="interface in com.djrapitops.plan.settings.config">ConfigValueParser</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#toStringParser()" class="member-name-link">toStringParser</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="getParserFor(java.lang.Class)">
|
|
<h3>getParserFor</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="ConfigValueParser.html" title="interface in com.djrapitops.plan.settings.config">ConfigValueParser</a></span> <span class="element-name">getParserFor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> type)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toStringParser()">
|
|
<h3>toStringParser</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="ConfigValueParser.html" title="interface in com.djrapitops.plan.settings.config">ConfigValueParser</a></span> <span class="element-name">toStringParser</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="compose(java.lang.String)">
|
|
<h3>compose</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a></span> <span class="element-name">compose</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fromValue)</span></div>
|
|
<div class="block">Parse a String value in the config into the appropriate object.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>fromValue</code> - String value in the config.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Config value or null if it could not be parsed.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="decompose(T)">
|
|
<h3 id="decompose(java.lang.Object)">decompose</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">decompose</span><wbr><span class="parameters">(<a href="ConfigValueParser.html" title="type parameter in ConfigValueParser">T</a> ofValue)</span></div>
|
|
<div class="block">Parse an object into a String value to save in the config.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>ofValue</code> - Value to save, not null.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>String format to save in the config.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If null value is given.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="nullInvalidException()">
|
|
<h3>nullInvalidException</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span> <span class="element-name">nullInvalidException</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|