mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 00:39:34 +01:00
400 lines
18 KiB
HTML
400 lines
18 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="fi">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>SettingsSvc (Plan 5.1-SNAPSHOT API)</title>
|
|
<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) {
|
|
parent.document.title="SettingsSvc (Plan 5.1-SNAPSHOT API)";
|
|
}
|
|
}
|
|
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.Holder.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/djrapitops/plan/settings/SpongeConfigSystem.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/djrapitops/plan/settings/SettingsSvc.html" target="_top">Frames</a></li>
|
|
<li><a href="SettingsSvc.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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 SettingsSvc" class="title">Class SettingsSvc</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.settings.SettingsSvc</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">SettingsSvc</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 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.Holder.html" title="class in com.djrapitops.plan.settings">SettingsService.Holder</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"> </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/SettingsSvc.html#SettingsSvc-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plan.utilities.logging.ErrorLogger-">SettingsSvc</a></span>(<a href="../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title="class in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/SettingsSvc.html#getInteger-java.lang.String-java.util.function.Supplier-">getInteger</a></span>(java.lang.String path,
|
|
java.util.function.Supplier<java.lang.Integer> 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/SettingsSvc.html#getString-java.lang.String-java.util.function.Supplier-">getString</a></span>(java.lang.String path,
|
|
java.util.function.Supplier<java.lang.String> 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<java.lang.String></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsSvc.html#getStringList-java.lang.String-java.util.function.Supplier-">getStringList</a></span>(java.lang.String path,
|
|
java.util.function.Supplier<java.util.List<java.lang.String>> 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/SettingsSvc.html#register--">register</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><T> void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/settings/SettingsSvc.html#set-java.lang.String-java.util.function.Supplier-">set</a></span>(java.lang.String pluginPath,
|
|
java.util.function.Supplier<T> defaultValue)</code> </td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class 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 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="SettingsSvc-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plan.utilities.logging.ErrorLogger-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SettingsSvc</h4>
|
|
<pre>@Inject
|
|
public SettingsSvc(<a href="../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title="class in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</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 void 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 java.lang.String getString(java.lang.String path,
|
|
java.util.function.Supplier<java.lang.String> defaultValue)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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>() -> "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 <T> void set(java.lang.String pluginPath,
|
|
java.util.function.Supplier<T> 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 java.lang.Integer getInteger(java.lang.String path,
|
|
java.util.function.Supplier<java.lang.Integer> defaultValue)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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>() -> 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 java.util.List<java.lang.String> getStringList(java.lang.String path,
|
|
java.util.function.Supplier<java.util.List<java.lang.String>> defaultValue)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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>() -> 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.Holder.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/djrapitops/plan/settings/SpongeConfigSystem.html" title="class in com.djrapitops.plan.settings"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/djrapitops/plan/settings/SettingsSvc.html" target="_top">Frames</a></li>
|
|
<li><a href="SettingsSvc.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|