Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-12-26 02:57:52 +01:00
Code Issues Projects Releases Wiki Activity
7415a5e1b1
Plan/all/com/djrapitops/plan/system/settings/paths/key/Setting.html

441 lines
20 KiB
HTML
Raw Normal View History

Updated javadocs
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>
Updated javadocs
2019-08-21 11:10:29 +02:00
<!-- Generated by javadoc (1.8.0_201) on Wed Aug 21 12:09:02 EEST 2019 -->
<title>Setting (Plan 4.9.4 API)</title>
<meta name="date" content="2019-08-21">
Updated javadocs
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) {
Updated javadocs
2019-08-21 11:10:29 +02:00
parent.document.title="Setting (Plan 4.9.4 API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10,"i3":9,"i4":9,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/paths/key/IntegerSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/StringListSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/djrapitops/plan/system/settings/paths/key/Setting.html" target="_top">Frames</a></li>
<li><a href="Setting.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.paths.key</div>
<h2 title="Class Setting" class="title">Class Setting&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.system.settings.paths.key.Setting&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/BooleanSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key">BooleanSetting</a>, <a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/IntegerSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key">IntegerSetting</a>, <a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/StringListSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key">StringListSetting</a>, <a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/StringSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key">StringSetting</a>, <a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/TimeSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key">TimeSetting</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Setting&lt;T&gt;</span>
extends java.lang.Object</pre>
<div class="block">Represents a path to a config value.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#path">path</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#Setting-java.lang.String-java.lang.Class-">Setting</a></span>(java.lang.String&nbsp;path,
java.lang.Class&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#Setting-java.lang.String-java.lang.Class-java.util.function.Predicate-">Setting</a></span>(java.lang.String&nbsp;path,
java.lang.Class&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type,
java.util.function.Predicate&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;validator)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#Setting-java.lang.String-com.djrapitops.plan.data.store.Type-">Setting</a></span>(java.lang.String&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/data/store/Type.html" title="class in com.djrapitops.plan.data.store">Type</a>&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#Setting-java.lang.String-com.djrapitops.plan.data.store.Type-java.util.function.Predicate-">Setting</a></span>(java.lang.String&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/data/store/Type.html" title="class in com.djrapitops.plan.data.store">Type</a>&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type,
java.util.function.Predicate&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;validator)</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#getPath--">getPath</a></span>()</code>
<div class="block">Used to get the String path of a the config setting.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#getValueFrom-com.djrapitops.plan.system.settings.config.ConfigNode-">getValueFrom</a></span>(<a href="../../../../../../../com/djrapitops/plan/system/settings/config/ConfigNode.html" title="class in com.djrapitops.plan.system.settings.config">ConfigNode</a>&nbsp;node)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#isValid-T-">isValid</a></span>(<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#nullValidator-T-">nullValidator</a></span>(T&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html#timeValidator-java.lang.Number-">timeValidator</a></span>(java.lang.Number&nbsp;number)</code>&nbsp;</td>
</tr>
<tr id="i5" 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/paths/key/Setting.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="path">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>path</h4>
<pre>protected final&nbsp;java.lang.String path</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Setting-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Setting</h4>
<pre>public&nbsp;Setting(java.lang.String&nbsp;path,
java.lang.Class&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type)</pre>
</li>
</ul>
<a name="Setting-java.lang.String-java.lang.Class-java.util.function.Predicate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Setting</h4>
<pre>public&nbsp;Setting(java.lang.String&nbsp;path,
java.lang.Class&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type,
java.util.function.Predicate&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;validator)</pre>
</li>
</ul>
<a name="Setting-java.lang.String-com.djrapitops.plan.data.store.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Setting</h4>
<pre>public&nbsp;Setting(java.lang.String&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/data/store/Type.html" title="class in com.djrapitops.plan.data.store">Type</a>&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type)</pre>
</li>
</ul>
<a name="Setting-java.lang.String-com.djrapitops.plan.data.store.Type-java.util.function.Predicate-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Setting</h4>
<pre>public&nbsp;Setting(java.lang.String&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/data/store/Type.html" title="class in com.djrapitops.plan.data.store">Type</a>&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;type,
java.util.function.Predicate&lt;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&gt;&nbsp;validator)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="nullValidator-java.lang.Object-">
<!-- -->
</a><a name="nullValidator-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullValidator</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;boolean&nbsp;nullValidator(T&nbsp;value)</pre>
</li>
</ul>
<a name="timeValidator-java.lang.Number-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeValidator</h4>
<pre>public static&nbsp;boolean&nbsp;timeValidator(java.lang.Number&nbsp;number)</pre>
</li>
</ul>
<a name="getPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPath()</pre>
<div class="block">Used to get the String path of a the config setting.
<p>
Path separates nested levels with a dot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Example: Settings.WebServer.Enabled</dd>
</dl>
</li>
</ul>
<a name="getValueFrom-com.djrapitops.plan.system.settings.config.ConfigNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueFrom</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&nbsp;getValueFrom(<a href="../../../../../../../com/djrapitops/plan/system/settings/config/ConfigNode.html" title="class in com.djrapitops.plan.system.settings.config">ConfigNode</a>&nbsp;node)</pre>
</li>
</ul>
<a name="isValid-java.lang.Object-">
<!-- -->
</a><a name="isValid-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;isValid(<a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/Setting.html" title="type parameter in Setting">T</a>&nbsp;value)</pre>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</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/paths/key/IntegerSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../com/djrapitops/plan/system/settings/paths/key/StringListSetting.html" title="class in com.djrapitops.plan.system.settings.paths.key"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/djrapitops/plan/system/settings/paths/key/Setting.html" target="_top">Frames</a></li>
<li><a href="Setting.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>
Reference in New Issue Copy Permalink