Plexus/Website
1
0
Fork 0
mirror of https://github.com/plexusorg/Website.git synced 2024-12-23 18:37:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
15bc449f7e
Website/static/javadoc/dev/plex/config/ModuleConfig.html

471 lines
34 KiB
HTML
Raw Normal View History

Add javadocs
2024-11-30 20:17:10 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
Huge documentation update
2024-12-02 18:41:26 +00:00
<!-- Generated by javadoc (21) -->
<title>ModuleConfig (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: ModuleConfig">
<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>
Add javadocs
2024-11-30 20:17:10 +00:00
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
Huge documentation update
2024-12-02 18:41:26 +00:00
<div>JavaScript is disabled on your browser.</div>
Add javadocs
2024-11-30 20:17:10 +00:00
</noscript>
<div class="flex-box">
Huge documentation update
2024-12-02 18:41:26 +00:00
<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">&nbsp;</span><span
class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a
href="package-summary.html">dev.plex.config</a></div>
<h1 title="Class ModuleConfig" class="title">Class ModuleConfig</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.ModuleConfig</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">ModuleConfig</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 <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 even-row-color"><code><a href="#file" class="member-name-link">file</a></code>
</div>
<div class="col-last even-row-color">
<div class="block">The File instance</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/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></code>
</div>
<div class="col-second odd-row-color"><code><a href="#from" class="member-name-link">from</a></code>
</div>
<div class="col-last odd-row-color">
<div class="block">Where the file is in the module JAR</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../module/PlexModule.html"
title="class in dev.plex.module">PlexModule</a></code>
</div>
<div class="col-second even-row-color"><code><a href="#module" class="member-name-link">module</a></code>
</div>
<div class="col-last even-row-color">
<div class="block">The plugin instance</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/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></code>
</div>
<div class="col-second odd-row-color"><code><a href="#to"
class="member-name-link">to</a></code>
</div>
<div class="col-last odd-row-color">
<div class="block">Where it should be copied to in the module folder</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.bukkit.configuration.file.YamlConfiguration">
Fields inherited from
class&nbsp;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&nbsp;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&nbsp;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.module.PlexModule,java.lang.String,java.lang.String)"
class="member-name-link">ModuleConfig</a>
<wbr>
(<a href="../module/PlexModule.html" title="class in dev.plex.module">PlexModule</a>&nbsp;module,
<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>&nbsp;from,
<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>&nbsp;to)</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">
&nbsp;
</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="#save()" class="member-name-link">save</a>()</code></div>
<div class="col-last odd-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>private void</code></div>
<div class="col-second even-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 even-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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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="module">
<h3>module</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span
class="return-type"><a href="../module/PlexModule.html"
title="class in dev.plex.module">PlexModule</a></span>&nbsp;<span
class="element-name">module</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>&nbsp;<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>&nbsp;<span class="element-name">file</span>
</div>
<div class="block">The File instance</div>
</section>
</li>
<li>
<section class="detail" id="from">
<h3>from</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<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>&nbsp;<span
class="element-name">from</span></div>
<div class="block">Where the file is in the module JAR</div>
</section>
</li>
<li>
<section class="detail" id="to">
<h3>to</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<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>&nbsp;<span
class="element-name">to</span></div>
<div class="block">Where it should be copied to in the module folder</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="&lt;init&gt;(dev.plex.module.PlexModule,java.lang.String,java.lang.String)">
<h3>ModuleConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="element-name">ModuleConfig</span>
<wbr>
<span class="parameters">(<a href="../module/PlexModule.html"
title="class in dev.plex.module">PlexModule</a>&nbsp;module,
<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>&nbsp;from,
<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>&nbsp;to)</span></div>
<div class="block">Creates a config object</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>module</code> - The module instance</dd>
<dd><code>to</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>&nbsp;<span
class="return-type">void</span>&nbsp;<span
class="element-name">load</span>()
</div>
</section>
</li>
<li>
<section class="detail" id="save()">
<h3>save</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<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>&nbsp;<span
class="return-type">void</span>&nbsp;<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>
Add javadocs
2024-11-30 20:17:10 +00:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink