Plan/all/com/djrapitops/plan/settings/SettingsServiceImplementation.html

401 lines
18 KiB
HTML
Raw Normal View History

2019-10-05 10:27:37 +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>
2020-01-24 11:56:15 +01:00
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:56:09 EET 2020 -->
<title>SettingsServiceImplementation (Plan 5.0-SNAPSHOT API)</title>
<meta name="date" content="2020-01-24">
2019-10-05 10:27:37 +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) {
2020-01-24 11:56:15 +01:00
parent.document.title="SettingsServiceImplementation (Plan 5.0-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/settings/SettingsService.SettingsServiceHolder.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/settings/SpongeConfigSystem.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/settings/SettingsServiceImplementation.html" target="_top">Frames</a></li>
<li><a href="SettingsServiceImplementation.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>Field&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>Field&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.settings</div>
<h2 title="Class SettingsServiceImplementation" class="title">Class SettingsServiceImplementation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.settings.SettingsServiceImplementation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></dd>
</dl>
<hr>
<br>
<pre>@Singleton
public class <span class="typeNameLabel">SettingsServiceImplementation</span>
extends java.lang.Object
implements <a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></pre>
<div class="block">Implementation for <a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings"><code>SettingsService</code></a>.</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.djrapitops.plan.settings.SettingsService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.djrapitops.plan.settings.<a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></h3>
<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.SettingsServiceHolder.html" title="class in com.djrapitops.plan.settings">SettingsService.SettingsServiceHolder</a></code></li>
</ul>
</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/settings/SettingsServiceImplementation.html#SettingsServiceImplementation-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plugin.logging.error.ErrorHandler-">SettingsServiceImplementation</a></span>(<a href="../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
com.djrapitops.plugin.logging.error.ErrorHandler&nbsp;errorHandler)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsServiceImplementation.html#getInteger-java.lang.String-java.util.function.Supplier-">getInteger</a></span>(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.lang.Integer&gt;&nbsp;defaultValue)</code>
<div class="block">Get a Integer from the config or the default value.</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/settings/SettingsServiceImplementation.html#getString-java.lang.String-java.util.function.Supplier-">getString</a></span>(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.lang.String&gt;&nbsp;defaultValue)</code>
<div class="block">Get a String from the config or the default value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsServiceImplementation.html#getStringList-java.lang.String-java.util.function.Supplier-">getStringList</a></span>(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.util.List&lt;java.lang.String&gt;&gt;&nbsp;defaultValue)</code>
<div class="block">Get a String list from the config or the default value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsServiceImplementation.html#register--">register</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsServiceImplementation.html#set-java.lang.String-java.util.function.Supplier-">set</a></span>(java.lang.String&nbsp;pluginPath,
java.util.function.Supplier&lt;T&gt;&nbsp;defaultValue)</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, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plan.settings.SettingsService">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plan.settings.<a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></h3>
<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getInstance--">getInstance</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SettingsServiceImplementation-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plugin.logging.error.ErrorHandler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SettingsServiceImplementation</h4>
<pre>@Inject
public&nbsp;SettingsServiceImplementation(<a href="../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
com.djrapitops.plugin.logging.error.ErrorHandler&nbsp;errorHandler)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="register--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>public&nbsp;void&nbsp;register()</pre>
</li>
</ul>
<a name="getString-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getString(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.lang.String&gt;&nbsp;defaultValue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getString-java.lang.String-java.util.function.Supplier-">SettingsService</a></code></span></div>
<div class="block">Get a String from the config or the default value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getString-java.lang.String-java.util.function.Supplier-">getString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - Path in the config</dd>
<dd><code>defaultValue</code> - Supplier for the default value, <code>() -&gt; "Example"</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value in the config</dd>
</dl>
</li>
</ul>
<a name="set-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;void&nbsp;set(java.lang.String&nbsp;pluginPath,
java.util.function.Supplier&lt;T&gt;&nbsp;defaultValue)</pre>
</li>
</ul>
<a name="getInteger-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteger</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getInteger(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.lang.Integer&gt;&nbsp;defaultValue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getInteger-java.lang.String-java.util.function.Supplier-">SettingsService</a></code></span></div>
<div class="block">Get a Integer from the config or the default value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getInteger-java.lang.String-java.util.function.Supplier-">getInteger</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - Path in the config</dd>
<dd><code>defaultValue</code> - Supplier for the default value, <code>() -&gt; 500</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value in the config</dd>
</dl>
</li>
</ul>
<a name="getStringList-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStringList</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getStringList(java.lang.String&nbsp;path,
java.util.function.Supplier&lt;java.util.List&lt;java.lang.String&gt;&gt;&nbsp;defaultValue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getStringList-java.lang.String-java.util.function.Supplier-">SettingsService</a></code></span></div>
<div class="block">Get a String list from the config or the default value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html#getStringList-java.lang.String-java.util.function.Supplier-">getStringList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/djrapitops/plan/settings/SettingsService.html" title="interface in com.djrapitops.plan.settings">SettingsService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - Path in the config</dd>
<dd><code>defaultValue</code> - Supplier for the default value, <code>() -&gt; Arrays.asList("Example", "Another")</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value in the config</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/settings/SettingsService.SettingsServiceHolder.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/settings/SpongeConfigSystem.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/settings/SettingsServiceImplementation.html" target="_top">Frames</a></li>
<li><a href="SettingsServiceImplementation.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>Field&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>Field&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>