<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (21) --> <title>Config (server 1.5-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: dev.plex.config, class: Config"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var pathtoroot = "../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> <button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span> </button> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a> </div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">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#class">Help</a></li> </ul> <ul class="sub-nav-list-small"> <li> <p>Summary:</p> <ul> <li>Nested</li> <li><a href="#field-summary">Field</a></li> <li><a href="#constructor-summary">Constr</a></li> <li><a href="#method-summary">Method</a></li> </ul> </li> <li> <p>Detail:</p> <ul> <li><a href="#field-detail">Field</a></li> <li><a href="#constructor-detail">Constr</a></li> <li><a href="#method-detail">Method</a></li> </ul> </li> </ul> </div> <div class="sub-nav"> <div id="navbar-sub-list"> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field-summary">Field</a> | </li> <li><a href="#constructor-summary">Constr</a> | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li><a href="#field-detail">Field</a> | </li> <li><a href="#constructor-detail">Constr</a> | </li> <li><a href="#method-detail">Method</a></li> </ul> </div> <div class="nav-list-search"><a href="../../../search.html">SEARCH</a> <input type="text" id="search-input" disabled placeholder="Search"> <input type="reset" id="reset-button" disabled value="reset"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">dev.plex.config</a></div> <h1 title="Class Config" class="title">Class Config</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">org.bukkit.configuration.MemorySection <div class="inheritance">org.bukkit.configuration.MemoryConfiguration <div class="inheritance">org.bukkit.configuration.file.FileConfiguration <div class="inheritance">org.bukkit.configuration.file.YamlConfiguration <div class="inheritance">dev.plex.config.Config</div> </div> </div> </div> </div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code>org.bukkit.configuration.Configuration</code>, <code>org.bukkit.configuration.ConfigurationSection</code> </dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Config</span> <span class="extends-implements">extends org.bukkit.configuration.file.YamlConfiguration</span> </div> <div class="block">Creates a custom Config object</div> </section> <section class="summary"> <ul class="summary-list"> <!-- =========== FIELD SUMMARY =========== --> <li> <section class="field-summary" id="field-summary"> <h2>Field Summary</h2> <div class="caption"><span>Fields</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Field</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>private boolean</code></div> <div class="col-second even-row-color"><code><a href="#added" class="member-name-link">added</a></code> </div> <div class="col-last even-row-color"> <div class="block">Whether new entries were added to the file automatically</div> </div> <div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code> </div> <div class="col-second odd-row-color"><code><a href="#file" class="member-name-link">file</a></code> </div> <div class="col-last odd-row-color"> <div class="block">The File instance</div> </div> <div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code> </div> <div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code> </div> <div class="col-last even-row-color"> <div class="block">The file name</div> </div> <div class="col-first odd-row-color"><code>private <a href="../Plex.html" title="class in dev.plex">Plex</a></code> </div> <div class="col-second odd-row-color"><code><a href="#plugin" class="member-name-link">plugin</a></code> </div> <div class="col-last odd-row-color"> <div class="block">The plugin instance</div> </div> </div> <div class="inherited-list"> <h3 id="fields-inherited-from-class-org.bukkit.configuration.file.YamlConfiguration"> Fields inherited from class org.bukkit.configuration.file.YamlConfiguration</h3> <code>BLANK_CONFIG, COMMENT_PREFIX</code></div> <div class="inherited-list"> <h3 id="fields-inherited-from-class-org.bukkit.configuration.MemoryConfiguration">Fields inherited from class org.bukkit.configuration.MemoryConfiguration</h3> <code>defaults, options</code></div> <div class="inherited-list"> <h3 id="fields-inherited-from-class-org.bukkit.configuration.MemorySection">Fields inherited from class org.bukkit.configuration.MemorySection</h3> <code>map</code></div> </section> </li> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Constructor Summary</h2> <div class="caption"><span>Constructors</span></div> <div class="summary-table two-column-summary"> <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(dev.plex.Plex,java.lang.String)" class="member-name-link">Config</a> <wbr> (<a href="../Plex.html" title="class in dev.plex">Plex</a> plugin, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code> </div> <div class="col-last even-row-color"> <div class="block">Creates a config object</div> </div> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"> <button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods </button> <button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods </button> <button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods </button> </div> <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code><a href="#load()" class="member-name-link">load</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code>void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code><a href="#load(boolean)" class="member-name-link">load</a> <wbr> (boolean loadFromFile)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Loads the configuration file</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code><a href="#save()" class="member-name-link">save</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Saves the configuration file</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code>private void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <code><a href="#saveDefault()" class="member-name-link">saveDefault</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Moves the configuration file from the plugin's resources folder to the data folder (plugins/Plex/) </div> </div> </div> </div> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.configuration.file.YamlConfiguration"> Methods inherited from class org.bukkit.configuration.file.YamlConfiguration</h3> <code>loadConfiguration, loadConfiguration, loadFromString, options, saveToString</code> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.configuration.file.FileConfiguration"> Methods inherited from class org.bukkit.configuration.file.FileConfiguration</h3> <code>buildHeader, load, load, load, save, save</code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.configuration.MemoryConfiguration"> Methods inherited from class org.bukkit.configuration.MemoryConfiguration</h3> <code>addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults</code> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.configuration.MemorySection">Methods inherited from class org.bukkit.configuration.MemorySection</h3> <code>contains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set, setComments, setInlineComments, toString</code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.configuration.ConfigurationSection"> Methods inherited from interface org.bukkit.configuration.ConfigurationSection</h3> <code>contains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getComponent, getComponent, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRichMessage, getRichMessage, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isSet, isString, isVector, set, setComments, setComponent, setInlineComments, setRichMessage</code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ FIELD DETAIL =========== --> <li> <section class="field-details" id="field-detail"> <h2>Field Details</h2> <ul class="member-list"> <li> <section class="detail" id="plugin"> <h3>plugin</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../Plex.html" title="class in dev.plex">Plex</a></span> <span class="element-name">plugin</span></div> <div class="block">The plugin instance</div> </section> </li> <li> <section class="detail" id="file"> <h3>file</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name">file</span> </div> <div class="block">The File instance</div> </section> </li> <li> <section class="detail" id="name"> <h3>name</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">name</span></div> <div class="block">The file name</div> </section> </li> <li> <section class="detail" id="added"> <h3>added</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">added</span></div> <div class="block">Whether new entries were added to the file automatically </div> </section> </li> </ul> </section> </li> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor-detail"> <h2>Constructor Details</h2> <ul class="member-list"> <li> <section class="detail" id="<init>(dev.plex.Plex,java.lang.String)"> <h3>Config</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Config</span> <wbr> <span class="parameters">(<a href="../Plex.html" title="class in dev.plex">Plex</a> plugin, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> <div class="block">Creates a config object</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>plugin</code> - The plugin instance</dd> <dd><code>name</code> - The file name</dd> </dl> </section> </li> </ul> </section> </li> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="load()"> <h3>load</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">load</span>() </div> </section> </li> <li> <section class="detail" id="load(boolean)"> <h3>load</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">load</span> <wbr> <span class="parameters">(boolean loadFromFile)</span></div> <div class="block">Loads the configuration file</div> </section> </li> <li> <section class="detail" id="save()"> <h3>save</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">save</span>() </div> <div class="block">Saves the configuration file</div> </section> </li> <li> <section class="detail" id="saveDefault()"> <h3>saveDefault</h3> <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">saveDefault</span>() </div> <div class="block">Moves the configuration file from the plugin's resources folder to the data folder (plugins/Plex/) </div> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>