Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-02 00:39:34 +01:00
Code Issues Projects Releases Wiki Activity
7415a5e1b1
Plan/all/com/djrapitops/plan/system/file/PlanFiles.html

481 lines
21 KiB
HTML
Raw Normal View History

Updated javadocs
2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
Updated javadocs
2019-08-21 11:10:29 +02:00
<!-- Generated by javadoc (1.8.0_201) on Wed Aug 21 12:09:06 EEST 2019 -->
<title>PlanFiles (Plan 4.9.4 API)</title>
<meta name="date" content="2019-08-21">
Updated javadocs
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
Updated javadocs
2019-08-21 11:10:29 +02:00
parent.document.title="PlanFiles (Plan 4.9.4 API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../com/djrapitops/plan/system/file/JarResource.html" title="class in com.djrapitops.plan.system.file"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/system/file/PlanFiles.html" target="_top">Frames</a></li>
<li><a href="PlanFiles.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.system.file</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.system.file.PlanFiles</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../com/djrapitops/plan/system/SubSystem.html" title="interface in com.djrapitops.plan.system">SubSystem</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/djrapitops/plan/system/file/SpongePlanFiles.html" title="class in com.djrapitops.plan.system.file">SpongePlanFiles</a></dd>
</dl>
<hr>
<br>
<pre>@Singleton
public class <span class="typeNameLabel">PlanFiles</span>
extends java.lang.Object
implements <a href="../../../../../com/djrapitops/plan/system/SubSystem.html" title="interface in com.djrapitops.plan.system">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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#plugin">plugin</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#PlanFiles-com.djrapitops.plan.PlanPlugin-">PlanFiles</a></span>(<a href="../../../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a>&nbsp;plugin)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#disable--">disable</a></span>()</code>
<div class="block">Performs disable actions for the subsystem</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#enable--">enable</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getConfigFile--">getConfigFile</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getCustomizableResourceOrDefault-java.lang.String-">getCustomizableResourceOrDefault</a></span>(java.lang.String&nbsp;resourceName)</code>
<div class="block">Get a customizable resource from the plugin files or from the jar if one doesn't exist.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getDataFolder--">getDataFolder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getFileFromPluginFolder-java.lang.String-">getFileFromPluginFolder</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getLocaleFile--">getLocaleFile</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getLogsFolder--">getLogsFolder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getResourceFromJar-java.lang.String-">getResourceFromJar</a></span>(java.lang.String&nbsp;resourceName)</code>
<div class="block">Get a file in the jar as a <a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><code>Resource</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/file/PlanFiles.html#getResourceFromPluginFolder-java.lang.String-">getResourceFromPluginFolder</a></span>(java.lang.String&nbsp;resourceName)</code>
<div class="block">Get a file from plugin folder as a <a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><code>Resource</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="plugin">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>plugin</h4>
<pre>protected final&nbsp;<a href="../../../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a> plugin</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PlanFiles-com.djrapitops.plan.PlanPlugin-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlanFiles</h4>
<pre>@Inject
public&nbsp;PlanFiles(<a href="../../../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a>&nbsp;plugin)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDataFolder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataFolder</h4>
<pre>public&nbsp;java.io.File&nbsp;getDataFolder()</pre>
</li>
</ul>
<a name="getLogsFolder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogsFolder</h4>
<pre>public&nbsp;java.io.File&nbsp;getLogsFolder()</pre>
</li>
</ul>
<a name="getConfigFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigFile</h4>
<pre>public&nbsp;java.io.File&nbsp;getConfigFile()</pre>
</li>
</ul>
<a name="getLocaleFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocaleFile</h4>
<pre>public&nbsp;java.io.File&nbsp;getLocaleFile()</pre>
</li>
</ul>
<a name="getFileFromPluginFolder-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileFromPluginFolder</h4>
<pre>public&nbsp;java.io.File&nbsp;getFileFromPluginFolder(java.lang.String&nbsp;name)</pre>
</li>
</ul>
<a name="enable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre>public&nbsp;void&nbsp;enable()
throws <a href="../../../../../com/djrapitops/plan/api/exceptions/EnableException.html" title="class in com.djrapitops.plan.api.exceptions">EnableException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/djrapitops/plan/system/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="../../../../../com/djrapitops/plan/system/SubSystem.html#enable--">enable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/djrapitops/plan/system/SubSystem.html" title="interface in com.djrapitops.plan.system">SubSystem</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/djrapitops/plan/api/exceptions/EnableException.html" title="class in com.djrapitops.plan.api.exceptions">EnableException</a></code> - If an error occurred during enable and it is fatal to the subsystem.</dd>
</dl>
</li>
</ul>
<a name="disable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disable</h4>
<pre>public&nbsp;void&nbsp;disable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/djrapitops/plan/system/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="../../../../../com/djrapitops/plan/system/SubSystem.html#disable--">disable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/djrapitops/plan/system/SubSystem.html" title="interface in com.djrapitops.plan.system">SubSystem</a></code></dd>
</dl>
</li>
</ul>
<a name="getResourceFromJar-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceFromJar</h4>
<pre>public&nbsp;<a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a>&nbsp;getResourceFromJar(java.lang.String&nbsp;resourceName)</pre>
<div class="block">Get a file in the jar as a <a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.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="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><code>Resource</code></a> for accessing the resource.</dd>
</dl>
</li>
</ul>
<a name="getResourceFromPluginFolder-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceFromPluginFolder</h4>
<pre>public&nbsp;<a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a>&nbsp;getResourceFromPluginFolder(java.lang.String&nbsp;resourceName)</pre>
<div class="block">Get a file from plugin folder as a <a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.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="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><code>Resource</code></a> for accessing the resource.</dd>
</dl>
</li>
</ul>
<a name="getCustomizableResourceOrDefault-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCustomizableResourceOrDefault</h4>
<pre>public&nbsp;<a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file">Resource</a>&nbsp;getCustomizableResourceOrDefault(java.lang.String&nbsp;resourceName)</pre>
<div class="block">Get a customizable resource from the plugin files or from the jar if one doesn't exist.</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="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><code>Resource</code></a> for accessing the resource, either from the plugin folder or jar.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../com/djrapitops/plan/system/file/JarResource.html" title="class in com.djrapitops.plan.system.file"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/system/file/Resource.html" title="interface in com.djrapitops.plan.system.file"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/system/file/PlanFiles.html" target="_top">Frames</a></li>
<li><a href="PlanFiles.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink