<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>PlanFiles (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="PlanFiles (Plan 5.2-SNAPSHOT API)"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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 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: </li> <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> <ul class="subNavList"> <li>Detail: </li> <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> </div> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </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> <a href="package-summary.html">com.djrapitops.plan.storage.file</a></div> <h2 title="Class PlanFiles" class="title">Class PlanFiles</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.djrapitops.plan.storage.file.PlanFiles</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><code><a href="SpongePlanFiles.html" title="class in com.djrapitops.plan.storage.file">SpongePlanFiles</a></code></dd> </dl> <hr> <pre>@Singleton public class <span class="typeNameLabel">PlanFiles</span> extends java.lang.Object implements <a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></pre> <div class="block">Abstracts File methods of Plugin classes so that they can be tested without Mocks.</div> </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> <table class="memberSummary"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Field</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceStream">getResourceStream</a></span></code></th> <td class="colLast"> </td> </tr> </table> </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"> </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(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction)">PlanFiles</a></span>​(java.io.File dataFolder, <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> getResourceStream)</code></th> <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disable()">disable</a></span>()</code></th> <td class="colLast"> <div class="block">Performs disable actions for the subsystem</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enable()">enable</a></span>()</code></th> <td class="colLast"> <div class="block">Performs enable actions for the subsystem.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigFile()">getConfigFile</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.util.Optional<<a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomizableResource(java.lang.String)">getCustomizableResource</a></span>​(java.lang.String resourceName)</code></th> <td class="colLast"> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.nio.file.Path</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomizationDirectory()">getCustomizationDirectory</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.nio.file.Path</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataDirectory()">getDataDirectory</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataFolder()">getDataFolder</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileFromPluginFolder(java.lang.String)">getFileFromPluginFolder</a></span>​(java.lang.String name)</code></th> <td class="colLast"> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>java.nio.file.Path</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJSONStorageDirectory()">getJSONStorageDirectory</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocaleFile()">getLocaleFile</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>java.nio.file.Path</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogsDirectory()">getLogsDirectory</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogsFolder()">getLogsFolder</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceFromJar(java.lang.String)">getResourceFromJar</a></span>​(java.lang.String resourceName)</code></th> <td class="colLast"> <div class="block">Get a file in the jar as a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a>.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceFromPluginFolder(java.lang.String)">getResourceFromPluginFolder</a></span>​(java.lang.String resourceName)</code></th> <td class="colLast"> <div class="block">Get a file from plugin folder as a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a>.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a id="getResourceStream"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getResourceStream</h4> <pre>protected final <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> getResourceStream</pre> </li> </ul> </li> </ul> </section> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>PlanFiles</h4> <pre>@Inject public PlanFiles​(@Named("dataFolder") java.io.File dataFolder, <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> getResourceStream)</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="getDataFolder()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDataFolder</h4> <pre class="methodSignature">public java.io.File getDataFolder()</pre> </li> </ul> <a id="getDataDirectory()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDataDirectory</h4> <pre class="methodSignature">public java.nio.file.Path getDataDirectory()</pre> </li> </ul> <a id="getCustomizationDirectory()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCustomizationDirectory</h4> <pre class="methodSignature">public java.nio.file.Path getCustomizationDirectory()</pre> </li> </ul> <a id="getLogsFolder()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLogsFolder</h4> <pre class="methodSignature">public java.io.File getLogsFolder()</pre> </li> </ul> <a id="getLogsDirectory()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLogsDirectory</h4> <pre class="methodSignature">public java.nio.file.Path getLogsDirectory()</pre> </li> </ul> <a id="getConfigFile()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getConfigFile</h4> <pre class="methodSignature">public java.io.File getConfigFile()</pre> </li> </ul> <a id="getLocaleFile()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocaleFile</h4> <pre class="methodSignature">public java.io.File getLocaleFile()</pre> </li> </ul> <a id="getFileFromPluginFolder(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFileFromPluginFolder</h4> <pre class="methodSignature">public java.io.File getFileFromPluginFolder​(java.lang.String name)</pre> </li> </ul> <a id="enable()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>enable</h4> <pre class="methodSignature">public void enable()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../SubSystem.html#enable()">SubSystem</a></code></span></div> <div class="block">Performs enable actions for the subsystem.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../SubSystem.html#enable()">enable</a></code> in interface <code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd> </dl> </li> </ul> <a id="disable()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>disable</h4> <pre class="methodSignature">public void disable()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../SubSystem.html#disable()">SubSystem</a></code></span></div> <div class="block">Performs disable actions for the subsystem</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../SubSystem.html#disable()">disable</a></code> in interface <code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd> </dl> </li> </ul> <a id="getResourceFromJar(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResourceFromJar</h4> <pre class="methodSignature">public <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a> getResourceFromJar​(java.lang.String resourceName)</pre> <div class="block">Get a file in the jar as a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>resourceName</code> - Path to the file inside jar/assets/plan/ folder.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a> for accessing the resource.</dd> </dl> </li> </ul> <a id="getResourceFromPluginFolder(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResourceFromPluginFolder</h4> <pre class="methodSignature">public <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a> getResourceFromPluginFolder​(java.lang.String resourceName)</pre> <div class="block">Get a file from plugin folder as a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>resourceName</code> - Path to the file inside the plugin folder.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a> for accessing the resource.</dd> </dl> </li> </ul> <a id="getCustomizableResource(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCustomizableResource</h4> <pre class="methodSignature">public java.util.Optional<<a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a>> getCustomizableResource​(java.lang.String resourceName)</pre> </li> </ul> <a id="getJSONStorageDirectory()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getJSONStorageDirectory</h4> <pre class="methodSignature">public java.nio.file.Path getJSONStorageDirectory()</pre> </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 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: </li> <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> <ul class="subNavList"> <li>Detail: </li> <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> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>