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

445 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ServerFileLoader (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ServerFileLoader (Plan 5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.identification.storage</a></div>
<h2 title="Class ServerFileLoader" class="title">Class ServerFileLoader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../settings/config/ConfigNode.html" title="class in com.djrapitops.plan.settings.config">com.djrapitops.plan.settings.config.ConfigNode</a></li>
<li>
<ul class="inheritance">
<li><a href="../../settings/config/Config.html" title="class in com.djrapitops.plan.settings.config">com.djrapitops.plan.settings.config.Config</a></li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.identification.storage.ServerFileLoader</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<pre>@Singleton
public class <span class="typeNameLabel">ServerFileLoader</span>
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></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode">
<!-- -->
</a>
<h3>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#nodeOrder">nodeOrder</a>, <a href="../../settings/config/ConfigNode.html#parent">parent</a>, <a href="../../settings/config/ConfigNode.html#value">value</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><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></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><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></th>
<td class="colLast">
<div class="block">Load the server information.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare()">prepare</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><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></th>
<td class="colLast">
<div class="block">Save the server information.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.settings.config.Config">
<!-- -->
</a>
<h3>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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.settings.config.ConfigNode">
<!-- -->
</a>
<h3>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#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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(com.djrapitops.plan.storage.file.PlanFiles,com.djrapitops.plan.settings.config.PlanConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerFileLoader</h4>
<pre>@Inject
public&nbsp;ServerFileLoader&#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)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="prepare()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;prepare()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="load(com.djrapitops.plan.identification.ServerUUID)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&gt;&nbsp;load&#8203;(<a href="../ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;loaded)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>loaded</code> - UUID of the server, null if not known</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional of the saved information or empty if it has not been stored.</dd>
</dl>
</li>
</ul>
<a id="save(com.djrapitops.plan.identification.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;save&#8203;(<a href="../Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - Information to save.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></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>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></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>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>