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 > Config (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="Config (Plan 5.1-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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 > Prev Class< / li >
< li > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/djrapitops/plan/settings/config/Config.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Config.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 > < a href = "#fields.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode" > Field< / a > | < / 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.config< / div >
< h2 title = "Class Config" class = "title" > Class Config< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > com.djrapitops.plan.settings.config.ConfigNode< / a > < / li >
< li >
< ul class = "inheritance" >
< li > com.djrapitops.plan.settings.config.Config< / li >
< / ul >
< / 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/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > , < a href = "../../../../../com/djrapitops/plan/identification/ServerInfoFile.html" title = "class in com.djrapitops.plan.identification" > ServerInfoFile< / a > , < a href = "../../../../../com/djrapitops/plan/settings/theme/ThemeConfig.html" title = "class in com.djrapitops.plan.settings.theme" > ThemeConfig< / a > < / dd >
< / dl >
< hr >
< br >
< pre > public class < span class = "typeNameLabel" > Config< / span >
extends < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / pre >
< div class = "block" > Configuration utility for storing settings in a .yml file.
< p >
Based on
https://github.com/Rsl1122/Abstract-Plugin-Framework/blob/72e221d3571ef200727713d10d3684c51e9f469d/AbstractPluginFramework/api/src/main/java/com/djrapitops/plugin/config/Config.java< / 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 >
< ul class = "blockList" >
< li class = "blockList" > < a name = "fields.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode" >
<!-- -->
< / a >
< h3 > Fields inherited from class com.djrapitops.plan.settings.config.< a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / h3 >
< code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#childNodes" > childNodes< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#comment" > comment< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#key" > key< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#nodeOrder" > nodeOrder< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#parent" > parent< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#value" > value< / 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/config/Config.html#Config-java.io.File-" > Config< / a > < / span > (java.io.File configFile)< / code > < / td >
< / tr >
< tr class = "rowColor" >
< td class = "colOne" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/settings/config/Config.html#Config-java.io.File-com.djrapitops.plan.settings.config.ConfigNode-" > Config< / a > < / span > (java.io.File configFile,
< a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > defaults)< / 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 > boolean< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/settings/config/Config.html#equals-java.lang.Object-" > equals< / a > < / span > (java.lang.Object o)< / code > < / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/settings/config/Config.html#hashCode--" > hashCode< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/settings/config/Config.html#read--" > read< / a > < / span > ()< / code > < / 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/config/Config.html#save--" > save< / a > < / span > ()< / code >
< div class = "block" > Find the root node and save.< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode" >
<!-- -->
< / a >
< h3 > Methods inherited from class com.djrapitops.plan.settings.config.< a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / h3 >
< code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#addChild-com.djrapitops.plan.settings.config.ConfigNode-" > addChild< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#addNode-java.lang.String-" > addNode< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#contains-java.lang.String-" > contains< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#copyAll-com.djrapitops.plan.settings.config.ConfigNode-" > copyAll< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#copyMissing-com.djrapitops.plan.settings.config.ConfigNode-" > copyMissing< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getBoolean--" > getBoolean< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getBoolean-java.lang.String-" > getBoolean< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getChildren--" > getChildren< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getComment--" > getComment< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getInteger--" > getInteger< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getInteger-java.lang.String-" > getInteger< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getKey-boolean-" > getKey< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getLong--" > getLong< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getLong-java.lang.String-" > getLong< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getNode-java.lang.String-" > getNode< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getNodeDepth--" > getNodeDepth< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getNodeOrder--" > getNodeOrder< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getParent--" > getParent< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getString--" > getString< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getString-java.lang.String-" > getString< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getStringList--" > getStringList< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getStringList-java.lang.String-" > getStringList< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#getStringMap-boolean-" > getStringMap< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#isLeafNode--" > isLeafNode< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#moveChild-java.lang.String-java.lang.String-" > moveChild< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#remove--" > remove< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#removeChild-com.djrapitops.plan.settings.config.ConfigNode-" > removeChild< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#removeNode-java.lang.String-" > removeNode< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#reorder-java.util.List-" > reorder< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#set-java.lang.String-T-" > set< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#set-T-" > set< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#setComment-java.util.List-" > setComment< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#sort--" > sort< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#toString--" > toString< / a > , < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#updateParent-com.djrapitops.plan.settings.config.ConfigNode-" > updateP
< / ul >
< 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, finalize, getClass, notify, notifyAll, wait, wait, wait< / 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 = "Config-java.io.File-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > Config< / h4 >
< pre > public Config(java.io.File configFile)< / pre >
< / li >
< / ul >
< a name = "Config-java.io.File-com.djrapitops.plan.settings.config.ConfigNode-" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > Config< / h4 >
< pre > public Config(java.io.File configFile,
< a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > defaults)< / pre >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "read--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > read< / h4 >
< pre > public void read()
throws java.io.IOException< / pre >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "save--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > save< / h4 >
< pre > public void save()
throws java.io.IOException< / pre >
< div class = "block" > < span class = "descfrmTypeLabel" > Description copied from class: < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#save--" > ConfigNode< / a > < / code > < / span > < / div >
< div class = "block" > Find the root node and save.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#save--" > save< / a > < / code > in class < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / code > < / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > - If the save can not be performed.< / dd >
< / dl >
< / li >
< / ul >
< a name = "equals-java.lang.Object-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > equals< / h4 >
< pre > public boolean equals(java.lang.Object o)< / pre >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#equals-java.lang.Object-" > equals< / a > < / code > in class < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "hashCode--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > hashCode< / h4 >
< pre > public int hashCode()< / pre >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html#hashCode--" > hashCode< / a > < / code > in class < code > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > ConfigNode< / a > < / 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 > Prev Class< / li >
< li > < a href = "../../../../../com/djrapitops/plan/settings/config/ConfigNode.html" title = "class in com.djrapitops.plan.settings.config" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/djrapitops/plan/settings/config/Config.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Config.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 > < a href = "#fields.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode" > Field< / a > | < / 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 >