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-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
< title > SettingsService (Plan 5.1-SNAPSHOT API)< / title >
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-03-21 15:43:05 +01:00
parent.document.title="SettingsService (Plan 5.1-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":17,"i1":6,"i2":6,"i3":6};
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/settings/ProxyConfigSystem.html" title = "class in com.djrapitops.plan.settings" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
2020-03-21 15:43:05 +01:00
< li > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.Holder.html" title = "class in com.djrapitops.plan.settings" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-10-05 10:27:37 +02:00
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/djrapitops/plan/settings/SettingsService.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "SettingsService.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 > < 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 = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / 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 = "Interface SettingsService" class = "title" > Interface SettingsService< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Known Implementing Classes:< / dt >
2020-03-21 15:43:05 +01:00
< dd > < a href = "../../../../com/djrapitops/plan/settings/SettingsSvc.html" title = "class in com.djrapitops.plan.settings" > SettingsSvc< / a > < / dd >
2019-10-05 10:27:37 +02:00
< / dl >
< hr >
< br >
< pre > public interface < span class = "typeNameLabel" > SettingsService< / span > < / pre >
< div class = "block" > Service for defining plugin specific settings to the Plan config.
< p >
All given paths will be prepended with "Plugins." to place the settings in the plugins config section.
It is recommended to use setting paths < code > "< Plugin_name> .Some_setting"< / code >
< p >
Requires Capability SETTINGS_API< / 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" > < / 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 < / code > < / td >
2020-03-21 15:43:05 +01:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.Holder.html" title = "class in com.djrapitops.plan.settings" > SettingsService.Holder< / a > < / span > < / code > < / td >
2019-10-05 10:27:37 +02:00
< / 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 = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / 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 = "t3" class = "tableTab" > < span > < a href = "javascript:show(4);" > Abstract Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t5" class = "tableTab" > < span > < a href = "javascript:show(16);" > Default 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 > static < a href = "../../../../com/djrapitops/plan/settings/SettingsService.html" title = "interface in com.djrapitops.plan.settings" > SettingsService< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.html#getInstance--" > getInstance< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > java.lang.Integer< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.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 = "i2" class = "altColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.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 = "i3" class = "rowColor" >
< 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/SettingsService.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 >
< / 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 = "getInstance--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getInstance< / h4 >
< pre > static < a href = "../../../../com/djrapitops/plan/settings/SettingsService.html" title = "interface in com.djrapitops.plan.settings" > SettingsService< / a > getInstance()< / pre >
< / li >
< / ul >
< a name = "getString-java.lang.String-java.util.function.Supplier-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getString< / h4 >
< pre > java.lang.String getString(java.lang.String path,
java.util.function.Supplier< java.lang.String> defaultValue)< / pre >
< div class = "block" > Get a String from the config or the default value.< / div >
< dl >
< 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 = "getInteger-java.lang.String-java.util.function.Supplier-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getInteger< / h4 >
< pre > java.lang.Integer getInteger(java.lang.String path,
java.util.function.Supplier< java.lang.Integer> defaultValue)< / pre >
< div class = "block" > Get a Integer from the config or the default value.< / div >
< dl >
< 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 > 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" > Get a String list from the config or the default value.< / div >
< dl >
< 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/ProxyConfigSystem.html" title = "class in com.djrapitops.plan.settings" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
2020-03-21 15:43:05 +01:00
< li > < a href = "../../../../com/djrapitops/plan/settings/SettingsService.Holder.html" title = "class in com.djrapitops.plan.settings" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-10-05 10:27:37 +02:00
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/djrapitops/plan/settings/SettingsService.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "SettingsService.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 > < 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 = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
