AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-12-28 21:07:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
old-website
Scissors-Website/public/javadoc/1.18.2/org/bukkit/configuration/Configuration.html
Telesphoreo 21e269497a Add Javadocs
2022-07-05 18:33:56 -05:00

273 lines
28 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Configuration (Scissors-API 1.18.2-R0.1-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: org.bukkit.configuration, interface: Configuration">
<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">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.5.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 evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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">
<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>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</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">org.bukkit.configuration</a></div>
<h1 title="Interface Configuration" class="title">Interface Configuration</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="ConfigurationSection.html" title="interface in org.bukkit.configuration">ConfigurationSection</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="file/FileConfiguration.html" title="class in org.bukkit.configuration.file">FileConfiguration</a></code>, <code><a href="MemoryConfiguration.html" title="class in org.bukkit.configuration">MemoryConfiguration</a></code>, <code><a href="file/YamlConfiguration.html" title="class in org.bukkit.configuration.file">YamlConfiguration</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Configuration</span><span class="extends-implements">
extends <a href="ConfigurationSection.html" title="interface in org.bukkit.configuration">ConfigurationSection</a></span></div>
<div class="block">Represents a source of configurable options and settings</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<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-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addDefault(java.lang.String,java.lang.Object)" class="member-name-link">addDefault</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;path,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the default value of the given path as provided.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addDefaults(java.util.Map)" class="member-name-link">addDefaults</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;defaults)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the default values of the given paths as provided.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addDefaults(org.bukkit.configuration.Configuration)" class="member-name-link">addDefaults</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a>&nbsp;defaults)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the default values of the given paths as provided.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDefaults()" class="member-name-link">getDefaults</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the source <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a> for this configuration.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConfigurationOptions.html" title="class in org.bukkit.configuration">ConfigurationOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#options()" class="member-name-link">options</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the <a href="ConfigurationOptions.html" title="class in org.bukkit.configuration"><code>ConfigurationOptions</code></a> for this <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDefaults(org.bukkit.configuration.Configuration)" class="member-name-link">setDefaults</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a>&nbsp;defaults)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the source of all default values for this <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.configuration.ConfigurationSection">Methods inherited from interface&nbsp;org.bukkit.configuration.<a href="ConfigurationSection.html" title="interface in org.bukkit.configuration">ConfigurationSection</a></h3>
<code><a href="ConfigurationSection.html#contains(java.lang.String)">contains</a>, <a href="ConfigurationSection.html#contains(java.lang.String,boolean)">contains</a>, <a href="ConfigurationSection.html#createSection(java.lang.String)">createSection</a>, <a href="ConfigurationSection.html#createSection(java.lang.String,java.util.Map)">createSection</a>, <a href="ConfigurationSection.html#get(java.lang.String)">get</a>, <a href="ConfigurationSection.html#get(java.lang.String,java.lang.Object)">get</a>, <a href="ConfigurationSection.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="ConfigurationSection.html#getBoolean(java.lang.String,boolean)">getBoolean</a>, <a href="ConfigurationSection.html#getBooleanList(java.lang.String)">getBooleanList</a>, <a href="ConfigurationSection.html#getByteList(java.lang.String)">getByteList</a>, <a href="ConfigurationSection.html#getCharacterList(java.lang.String)">getCharacterList</a>, <a href="ConfigurationSection.html#getColor(java.lang.String)">getColor</a>, <a href="ConfigurationSection.html#getColor(java.lang.String,org.bukkit.Color)">getColor</a>, <a href="ConfigurationSection.html#getComments(java.lang.String)">getComments</a>, <a href="ConfigurationSection.html#getConfigurationSection(java.lang.String)">getConfigurationSection</a>, <a href="ConfigurationSection.html#getCurrentPath()">getCurrentPath</a>, <a href="ConfigurationSection.html#getDefaultSection()">getDefaultSection</a>, <a href="ConfigurationSection.html#getDouble(java.lang.String)">getDouble</a>, <a href="ConfigurationSection.html#getDouble(java.lang.String,double)">getDouble</a>, <a href="ConfigurationSection.html#getDoubleList(java.lang.String)">getDoubleList</a>, <a href="ConfigurationSection.html#getFloatList(java.lang.String)">getFloatList</a>, <a href="ConfigurationSection.html#getInlineComments(java.lang.String)">getInlineComments</a>, <a href="ConfigurationSection.html#getInt(java.lang.String)">getInt</a>, <a href="ConfigurationSection.html#getInt(java.lang.String,int)">getInt</a>, <a href="ConfigurationSection.html#getIntegerList(java.lang.String)">getIntegerList</a>, <a href="ConfigurationSection.html#getItemStack(java.lang.String)">getItemStack</a>, <a href="ConfigurationSection.html#getItemStack(java.lang.String,org.bukkit.inventory.ItemStack)">getItemStack</a>, <a href="ConfigurationSection.html#getKeys(boolean)">getKeys</a>, <a href="ConfigurationSection.html#getList(java.lang.String)">getList</a>, <a href="ConfigurationSection.html#getList(java.lang.String,java.util.List)">getList</a>, <a href="ConfigurationSection.html#getLocation(java.lang.String)">getLocation</a>, <a href="ConfigurationSection.html#getLocation(java.lang.String,org.bukkit.Location)">getLocation</a>, <a href="ConfigurationSection.html#getLong(java.lang.String)">getLong</a>, <a href="ConfigurationSection.html#getLong(java.lang.String,long)">getLong</a>, <a href="ConfigurationSection.html#getLongList(java.lang.String)">getLongList</a>, <a href="ConfigurationSection.html#getMapList(java.lang.String)">getMapList</a>, <a href="ConfigurationSection.html#getName()">getName</a>, <a href="ConfigurationSection.html#getObject(java.lang.String,java.lang.Class)">getObject</a>, <a href="ConfigurationSection.html#getObject(java.lang.String,java.lang.Class,T)">getObject</a>, <a href="ConfigurationSection.html#getOfflinePlayer(java.lang.String)">getOfflinePlayer</a>, <a href="ConfigurationSection.html#getOfflinePlayer(java.lang.String,org.bukkit.OfflinePlayer)">getOfflinePlayer</a>, <a href="ConfigurationSection.html#getParent()">getParent</a>, <a href="ConfigurationSection.html#getRoot()">getRoot</a>, <a href="ConfigurationSection.html#getSerializable(java.lang.String,java.lang.Class)">getSerializable</a>, <a href="ConfigurationSection.html#getSerializable(java.lang.String,java.lang.Class,T)">getSerializable</a>, <a href="ConfigurationSection.html#getShortList(java.lang.String)">getShortList</a>, <a href="ConfigurationSection.html#getString(java.lang.String)">getString</a>, <a href="ConfigurationSection.html#getString(java.lang.String,java.lang.String)">getString</a>, <a href="ConfigurationSection.html#getStringList(java.lang.String)">getStringList</a>, <a href="ConfigurationSection.html#getValues(boolean)">getValues</a>, <a href="ConfigurationSection.html#getVector(java.lang.String)">getVector</a>, <a href="ConfigurationSection.html#getVector(java.lang.String,org.bukkit.util.Vector)">getVector</a>, <a href="ConfigurationSection.html#isBoolean(java.lang.String)">isBoolean</a>, <a href="ConfigurationSection.html#isColor(java.lang.String)">isColor</a>, <a href="ConfigurationSection.html#isConfigurationSection(java.lang.String)">isConfigurationSection</a>, <a href="ConfigurationSection.html#isDouble(java.lang.String)">isDouble</a>, <a href="ConfigurationSection.html#isInt(java.lang.String)">isInt</a>, <a href="ConfigurationSection.html#isItemStack(java.lang.String)">isItemStack</a>, <a href="ConfigurationSection.html#isList(java.lang.String)">isList</a>, <a href="ConfigurationSection.html#isLocation(java.lang.String)">isLocation</a>, <a href="ConfigurationSection.html#isLong(java.lang.String)">isLong</a>, <a href="ConfigurationSection.html#isOfflinePlayer(java.lang.String)">isOfflinePlayer</a>, <a href="ConfigurationSection.html#isSet(java.lang.String)">isSet</a>, <a href="ConfigurationSection.html#isString(java.lang.String)">isString</a>, <a href="ConfigurationSection.html#isVector(java.lang.String)">isVector</a>, <a href="ConfigurationSection.html#set(java.lang.String,java.lang.Object)">set</a>, <a href="ConfigurationSection.html#setComments(java.lang.String,java.util.List)">setComments</a>, <a href="ConfigurationSection.html#setInlineComments(java.lang.String,java.util.List)">setInlineComments</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="addDefault(java.lang.String,java.lang.Object)">
<h3>addDefault</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addDefault</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;path,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
<div class="block">Sets the default value of the given path as provided.
<p>
If no source <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a> was provided as a default
collection, then a new <a href="MemoryConfiguration.html" title="class in org.bukkit.configuration"><code>MemoryConfiguration</code></a> will be created to
hold the new default value.
<p>
If value is null, the value will be removed from the default
Configuration source.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ConfigurationSection.html#addDefault(java.lang.String,java.lang.Object)">addDefault</a></code>&nbsp;in interface&nbsp;<code><a href="ConfigurationSection.html" title="interface in org.bukkit.configuration">ConfigurationSection</a></code></dd>
<dt>Parameters:</dt>
<dd><code>path</code> - Path of the value to set.</dd>
<dd><code>value</code> - Value to set the default to.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if path is null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addDefaults(java.util.Map)">
<h3>addDefaults</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addDefaults</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;defaults)</span></div>
<div class="block">Sets the default values of the given paths as provided.
<p>
If no source <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a> was provided as a default
collection, then a new <a href="MemoryConfiguration.html" title="class in org.bukkit.configuration"><code>MemoryConfiguration</code></a> will be created to
hold the new default values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>defaults</code> - A map of Path-&gt;Values to add to defaults.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if defaults is null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addDefaults(org.bukkit.configuration.Configuration)">
<h3>addDefaults</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addDefaults</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a>&nbsp;defaults)</span></div>
<div class="block">Sets the default values of the given paths as provided.
<p>
If no source <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a> was provided as a default
collection, then a new <a href="MemoryConfiguration.html" title="class in org.bukkit.configuration"><code>MemoryConfiguration</code></a> will be created to
hold the new default value.
<p>
This method will not hold a reference to the specified Configuration,
nor will it automatically update if that Configuration ever changes. If
you require this, you should set the default source with <a href="#setDefaults(org.bukkit.configuration.Configuration)"><code>setDefaults(org.bukkit.configuration.Configuration)</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>defaults</code> - A configuration holding a list of defaults to copy.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if defaults is null or this.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDefaults(org.bukkit.configuration.Configuration)">
<h3>setDefaults</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setDefaults</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a>&nbsp;defaults)</span></div>
<div class="block">Sets the source of all default values for this <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a>.
<p>
If a previous source was set, or previous default values were defined,
then they will not be copied to the new source.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>defaults</code> - New source of default values for this configuration.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if defaults is null or this.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDefaults()">
<h3>getDefaults</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Configuration.html" title="interface in org.bukkit.configuration">Configuration</a></span>&nbsp;<span class="element-name">getDefaults</span>()</div>
<div class="block">Gets the source <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a> for this configuration.
<p>
If no configuration source was set, but default values were added, then
a <a href="MemoryConfiguration.html" title="class in org.bukkit.configuration"><code>MemoryConfiguration</code></a> will be returned. If no source was set
and no defaults were set, then this method will return null.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Configuration source for default values, or null if none exist.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="options()">
<h3>options</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConfigurationOptions.html" title="class in org.bukkit.configuration">ConfigurationOptions</a></span>&nbsp;<span class="element-name">options</span>()</div>
<div class="block">Gets the <a href="ConfigurationOptions.html" title="class in org.bukkit.configuration"><code>ConfigurationOptions</code></a> for this <a href="Configuration.html" title="interface in org.bukkit.configuration"><code>Configuration</code></a>.
<p>
All setters through this method are chainable.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Options for this configuration</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink