AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-07-05 16:30:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
5455fbe8b9
Scissors-Website/public/javadoc/1.17.1/org/bukkit/configuration/serialization/ConfigurationSerializable.html
Telesphoreo 21e269497a Add Javadocs
2022-07-05 18:33:56 -05:00

166 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ConfigurationSerializable (Scissors-API 1.17.1-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.serialization, interface: ConfigurationSerializable">
<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.serialization</a></div>
<h1 title="Interface ConfigurationSerializable" class="title">Interface ConfigurationSerializable</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../../../../com/destroystokyo/paper/inventory/meta/ArmorStandMeta.html" title="interface in com.destroystokyo.paper.inventory.meta">ArmorStandMeta</a></code>, <code><a href="../../inventory/meta/AxolotlBucketMeta.html" title="interface in org.bukkit.inventory.meta">AxolotlBucketMeta</a></code>, <code><a href="../../inventory/meta/BannerMeta.html" title="interface in org.bukkit.inventory.meta">BannerMeta</a></code>, <code><a href="../../inventory/meta/BlockDataMeta.html" title="interface in org.bukkit.inventory.meta">BlockDataMeta</a></code>, <code><a href="../../inventory/meta/BlockStateMeta.html" title="interface in org.bukkit.inventory.meta">BlockStateMeta</a></code>, <code><a href="../../inventory/meta/BookMeta.html" title="interface in org.bukkit.inventory.meta">BookMeta</a></code>, <code><a href="../../inventory/meta/BundleMeta.html" title="interface in org.bukkit.inventory.meta">BundleMeta</a></code>, <code><a href="../../inventory/meta/CompassMeta.html" title="interface in org.bukkit.inventory.meta">CompassMeta</a></code>, <code><a href="../../inventory/meta/CrossbowMeta.html" title="interface in org.bukkit.inventory.meta">CrossbowMeta</a></code>, <code><a href="../../inventory/meta/Damageable.html" title="interface in org.bukkit.inventory.meta">Damageable</a></code>, <code><a href="../../inventory/meta/EnchantmentStorageMeta.html" title="interface in org.bukkit.inventory.meta">EnchantmentStorageMeta</a></code>, <code><a href="../../inventory/meta/FireworkEffectMeta.html" title="interface in org.bukkit.inventory.meta">FireworkEffectMeta</a></code>, <code><a href="../../inventory/meta/FireworkMeta.html" title="interface in org.bukkit.inventory.meta">FireworkMeta</a></code>, <code><a href="../../inventory/meta/ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></code>, <code><a href="../../inventory/meta/KnowledgeBookMeta.html" title="interface in org.bukkit.inventory.meta">KnowledgeBookMeta</a></code>, <code><a href="../../inventory/meta/LeatherArmorMeta.html" title="interface in org.bukkit.inventory.meta">LeatherArmorMeta</a></code>, <code><a href="../../inventory/meta/MapMeta.html" title="interface in org.bukkit.inventory.meta">MapMeta</a></code>, <code><a href="../../OfflinePlayer.html" title="interface in org.bukkit">OfflinePlayer</a></code>, <code><a href="../../entity/Player.html" title="interface in org.bukkit.entity">Player</a></code>, <code><a href="../../inventory/meta/PotionMeta.html" title="interface in org.bukkit.inventory.meta">PotionMeta</a></code>, <code><a href="../../inventory/meta/SkullMeta.html" title="interface in org.bukkit.inventory.meta">SkullMeta</a></code>, <code><a href="../../inventory/meta/SpawnEggMeta.html" title="interface in org.bukkit.inventory.meta">SpawnEggMeta</a></code>, <code><a href="../../inventory/meta/SuspiciousStewMeta.html" title="interface in org.bukkit.inventory.meta">SuspiciousStewMeta</a></code>, <code><a href="../../inventory/meta/TropicalFishBucketMeta.html" title="interface in org.bukkit.inventory.meta">TropicalFishBucketMeta</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../attribute/AttributeModifier.html" title="class in org.bukkit.attribute">AttributeModifier</a></code>, <code><a href="../../util/BlockVector.html" title="class in org.bukkit.util">BlockVector</a></code>, <code><a href="../../util/BoundingBox.html" title="class in org.bukkit.util">BoundingBox</a></code>, <code><a href="../../Color.html" title="class in org.bukkit">Color</a></code>, <code><a href="../../FireworkEffect.html" title="class in org.bukkit">FireworkEffect</a></code>, <code><a href="../../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a></code>, <code><a href="../../Location.html" title="class in org.bukkit">Location</a></code>, <code><a href="../../block/banner/Pattern.html" title="class in org.bukkit.block.banner">Pattern</a></code>, <code><a href="../../potion/PotionEffect.html" title="class in org.bukkit.potion">PotionEffect</a></code>, <code><a href="../../util/Vector.html" title="class in org.bukkit.util">Vector</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ConfigurationSerializable</span></div>
<div class="block">Represents an object that may be serialized.
<p>
These objects MUST implement one of the following, in addition to the
methods as defined by this interface:
<ul>
<li>A static method "deserialize" that accepts a single <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"><code>Map</code></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"><code>String</code></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"><code>Object</code></a>&gt; and returns the class.</li>
<li>A static method "valueOf" that accepts a single <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"><code>Map</code></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"><code>String</code></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"><code>Object</code></a>&gt; and returns the class.</li>
<li>A constructor that accepts a single <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"><code>Map</code></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"><code>String</code></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"><code>Object</code></a>&gt;.</li>
</ul>
In addition to implementing this interface, you must register the class
with <a href="ConfigurationSerialization.html#registerClass(java.lang.Class)"><code>ConfigurationSerialization.registerClass(Class)</code></a>.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="DelegateDeserialization.html" title="annotation interface in org.bukkit.configuration.serialization"><code>DelegateDeserialization</code></a></li>
<li><a href="SerializableAs.html" title="annotation interface in org.bukkit.configuration.serialization"><code>SerializableAs</code></a></li>
</ul>
</dd>
</dl>
</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><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#serialize()" class="member-name-link">serialize</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Creates a Map representation of this class.</div>
</div>
</div>
</div>
</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="serialize()">
<h3>serialize</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/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;</span>&nbsp;<span class="element-name">serialize</span>()</div>
<div class="block">Creates a Map representation of this class.
<p>
This class must provide a method to restore this class, as defined in
the <a href="ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization"><code>ConfigurationSerializable</code></a> interface javadocs.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Map containing the current state of this class</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