Plan/all/com/djrapitops/plan/identification/storage/ServerFileLoader.html

261 lines
22 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>ServerFileLoader (Plan 5.4-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: com.djrapitops.plan.identification.storage, class: ServerFileLoader">
<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">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><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>Field&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"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" 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">com.djrapitops.plan.identification.storage</a></div>
<h1 title="Class ServerFileLoader" class="title">Class ServerFileLoader</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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"><a href="../../settings/config/ConfigNode.html" title="class in com.djrapitops.plan.settings.config">com.djrapitops.plan.settings.config.ConfigNode</a>
<div class="inheritance"><a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">com.djrapitops.plan.settings.config.Config</a>
<div class="inheritance">com.djrapitops.plan.identification.storage.ServerFileLoader</div>
</div>
</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ServerLoader.html" title="interface in com.djrapitops.plan.identification.storage">ServerLoader</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Singleton
</span><span class="modifiers">public class </span><span class="element-name type-name-label">ServerFileLoader</span>
<span class="extends-implements">extends <a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">Config</a>
implements <a href="ServerLoader.html" title="interface in com.djrapitops.plan.identification.storage">ServerLoader</a></span></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="inherited-list">
<h3 id="fields.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode">Fields inherited from class&nbsp;com.djrapitops.plan.settings.config.<a href="../../settings/config/ConfigNode.html" title="class in com.djrapitops.plan.settings.config">ConfigNode</a></h3>
<code><a href="../../settings/config/ConfigNode.html#childNodes">childNodes</a>, <a href="../../settings/config/ConfigNode.html#comment">comment</a>, <a href="../../settings/config/ConfigNode.html#key">key</a>, <a href="../../settings/config/ConfigNode.html#nodeModificationLock">nodeModificationLock</a>, <a href="../../settings/config/ConfigNode.html#nodeOrder">nodeOrder</a>, <a href="../../settings/config/ConfigNode.html#parent">parent</a>, <a href="../../settings/config/ConfigNode.html#value">value</a></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><span class="member-name-link"><a href="#%3Cinit%3E(com.djrapitops.plan.storage.file.PlanFiles,com.djrapitops.plan.settings.config.PlanConfig)">ServerFileLoader</a></span>&#8203;(<a href="../../storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config)</code></div>
<div class="col-last even-row-color">&nbsp;</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">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#hashCode()">hashCode</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#load(com.djrapitops.plan.identification.ServerUUID)">load</a></span>&#8203;(<a href="../ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;loaded)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Load the server information.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#prepare()">prepare</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#save(com.djrapitops.plan.identification.Server)">save</a></span>&#8203;(<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Save the server information.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.djrapitops.plan.settings.config.Config">Methods inherited from class&nbsp;com.djrapitops.plan.settings.config.<a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">Config</a></h3>
<code><a href="../../settings/config/Config.html#getConfigFilePath()">getConfigFilePath</a>, <a href="../../settings/config/Config.html#read()">read</a>, <a href="../../settings/config/Config.html#save()">save</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode">Methods inherited from class&nbsp;com.djrapitops.plan.settings.config.<a href="../../settings/config/ConfigNode.html" title="class in com.djrapitops.plan.settings.config">ConfigNode</a></h3>
<code><a href="../../settings/config/ConfigNode.html#addChild(com.djrapitops.plan.settings.config.ConfigNode)">addChild</a>, <a href="../../settings/config/ConfigNode.html#addNode(java.lang.String)">addNode</a>, <a href="../../settings/config/ConfigNode.html#contains(java.lang.String)">contains</a>, <a href="../../settings/config/ConfigNode.html#copyAll(com.djrapitops.plan.settings.config.ConfigNode)">copyAll</a>, <a href="../../settings/config/ConfigNode.html#copyMissing(com.djrapitops.plan.settings.config.ConfigNode)">copyMissing</a>, <a href="../../settings/config/ConfigNode.html#getBoolean()">getBoolean</a>, <a href="../../settings/config/ConfigNode.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../settings/config/ConfigNode.html#getChildren()">getChildren</a>, <a href="../../settings/config/ConfigNode.html#getComment()">getComment</a>, <a href="../../settings/config/ConfigNode.html#getConfigPaths()">getConfigPaths</a>, <a href="../../settings/config/ConfigNode.html#getDouble()">getDouble</a>, <a href="../../settings/config/ConfigNode.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../settings/config/ConfigNode.html#getInteger()">getInteger</a>, <a href="../../settings/config/ConfigNode.html#getInteger(java.lang.String)">getInteger</a>, <a href="../../settings/config/ConfigNode.html#getKey(boolean)">getKey</a>, <a href="../../settings/config/ConfigNode.html#getLong()">getLong</a>, <a href="../../settings/config/ConfigNode.html#getLong(java.lang.String)">getLong</a>, <a href="../../settings/config/ConfigNode.html#getNode(java.lang.String)">getNode</a>, <a href="../../settings/config/ConfigNode.html#getNodeDepth()">getNodeDepth</a>, <a href="../../settings/config/ConfigNode.html#getNodeOrder()">getNodeOrder</a>, <a href="../../settings/config/ConfigNode.html#getParent()">getParent</a>, <a href="../../settings/config/ConfigNode.html#getString()">getString</a>, <a href="../../settings/config/ConfigNode.html#getString(java.lang.String)">getString</a>, <a href="../../settings/config/ConfigNode.html#getStringList()">getStringList</a>, <a href="../../settings/config/ConfigNode.html#getStringList(java.lang.String)">getStringList</a>, <a href="../../settings/config/ConfigNode.html#getStringMap(boolean)">getStringMap</a>, <a href="../../settings/config/ConfigNode.html#isLeafNode()">isLeafNode</a>, <a href="../../settings/config/ConfigNode.html#moveChild(java.lang.String,java.lang.String)">moveChild</a>, <a href="../../settings/config/ConfigNode.html#remove()">remove</a>, <a href="../../settings/config/ConfigNode.html#removeChild(com.djrapitops.plan.settings.config.ConfigNode)">removeChild</a>, <a href="../../settings/config/ConfigNode.html#removeNode(java.lang.String)">removeNode</a>, <a href="../../settings/config/ConfigNode.html#reorder(java.util.List)">reorder</a>, <a href="../../settings/config/ConfigNode.html#set(java.lang.String,T)">set</a>, <a href="../../settings/config/ConfigNode.html#set(T)">set</a>, <a href="../../settings/config/ConfigNode.html#setComment(java.util.List)">setComment</a>, <a href="../../settings/config/ConfigNode.html#sort()">sort</a>, <a href="../../settings/config/ConfigNode.html#toString()">toString</a>, <a href="../../settings/config/ConfigNode.html#updateParent(com.djrapitops.plan.settings.config.ConfigNode)">updateParent</a></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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= 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;(com.djrapitops.plan.storage.file.PlanFiles,com.djrapitops.plan.settings.config.PlanConfig)">
<h3>ServerFileLoader</h3>
<div class="member-signature"><span class="annotations">@Inject
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">ServerFileLoader</span>&#8203;<span class="parameters">(<a href="../../storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config)</span></div>
</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="prepare()">
<h3>prepare</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">prepare</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="load(com.djrapitops.plan.identification.ServerUUID)">
<h3>load</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&gt;</span>&nbsp;<span class="element-name">load</span>&#8203;<span class="parameters">(<a href="../ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;loaded)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ServerLoader.html#load(com.djrapitops.plan.identification.ServerUUID)">ServerLoader</a></code></span></div>
<div class="block">Load the server information.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ServerLoader.html#load(com.djrapitops.plan.identification.ServerUUID)">load</a></code>&nbsp;in interface&nbsp;<code><a href="ServerLoader.html" title="interface in com.djrapitops.plan.identification.storage">ServerLoader</a></code></dd>
<dt>Parameters:</dt>
<dd><code>loaded</code> - UUID of the server, null if not known</dd>
<dt>Returns:</dt>
<dd>Optional of the saved information or empty if it has not been stored.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="save(com.djrapitops.plan.identification.Server)">
<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>&#8203;<span class="parameters">(<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ServerLoader.html#save(com.djrapitops.plan.identification.Server)">ServerLoader</a></code></span></div>
<div class="block">Save the server information.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ServerLoader.html#save(com.djrapitops.plan.identification.Server)">save</a></code>&nbsp;in interface&nbsp;<code><a href="ServerLoader.html" title="interface in com.djrapitops.plan.identification.storage">ServerLoader</a></code></dd>
<dt>Parameters:</dt>
<dd><code>server</code> - Information to save.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../settings/config/Config.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">Config</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../settings/config/Config.html#hashCode()">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">Config</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>