mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-29 12:37:40 +01:00
199 lines
15 KiB
HTML
199 lines
15 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>SpongePlanFiles (Plan 5.5-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.storage.file, class: SpongePlanFiles">
|
|
<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.6.0.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: </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="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">com.djrapitops.plan.storage.file</a></div>
|
|
<h1 title="Class SpongePlanFiles" class="title">Class SpongePlanFiles</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
|
|
<div class="inheritance"><a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file">com.djrapitops.plan.storage.file.PlanFiles</a>
|
|
<div class="inheritance">com.djrapitops.plan.storage.file.SpongePlanFiles</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</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">SpongePlanFiles</span>
|
|
<span class="extends-implements">extends <a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></span></div>
|
|
<div class="block">Implements jar resource fetching with Sponge Asset API.</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.storage.file.PlanFiles">Fields inherited from class com.djrapitops.plan.storage.file.<a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></h3>
|
|
<code><a href="PlanFiles.html#getResourceStream">getResourceStream</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><a href="#%3Cinit%3E(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction,com.djrapitops.plan.PlanPlugin,dagger.Lazy)" class="member-name-link">SpongePlanFiles</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dataFolder,
|
|
<a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> getResourceStream,
|
|
<a href="../../PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a> plugin,
|
|
dagger.Lazy<<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>> config)</code></div>
|
|
<div class="col-last even-row-color"> </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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResourceFromJar(java.lang.String)" class="member-name-link">getResourceFromJar</a><wbr>(<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> resourceName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.djrapitops.plan.storage.file.PlanFiles">Methods inherited from class com.djrapitops.plan.storage.file.<a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></h3>
|
|
<code><a href="PlanFiles.html#attemptToFind(java.lang.String)">attemptToFind</a>, <a href="PlanFiles.html#disable()">disable</a>, <a href="PlanFiles.html#enable()">enable</a>, <a href="PlanFiles.html#getConfigFile()">getConfigFile</a>, <a href="PlanFiles.html#getCustomizableResource(java.lang.String)">getCustomizableResource</a>, <a href="PlanFiles.html#getDataDirectory()">getDataDirectory</a>, <a href="PlanFiles.html#getDataFolder()">getDataFolder</a>, <a href="PlanFiles.html#getFileFromPluginFolder(java.lang.String)">getFileFromPluginFolder</a>, <a href="PlanFiles.html#getJSONStorageDirectory()">getJSONStorageDirectory</a>, <a href="PlanFiles.html#getLocaleFile()">getLocaleFile</a>, <a href="PlanFiles.html#getLogsDirectory()">getLogsDirectory</a>, <a href="PlanFiles.html#getLogsFolder()">getLogsFolder</a>, <a href="PlanFiles.html#getResourceFromPluginFolder(java.lang.String)">getResourceFromPluginFolder</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/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="<init>(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction,com.djrapitops.plan.PlanPlugin,dagger.Lazy)">
|
|
<h3>SpongePlanFiles</h3>
|
|
<div class="member-signature"><span class="annotations">@Inject
|
|
</span><span class="modifiers">public</span> <span class="element-name">SpongePlanFiles</span><wbr><span class="parameters">(@Named("dataFolder")
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dataFolder,
|
|
<a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> getResourceStream,
|
|
<a href="../../PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a> plugin,
|
|
dagger.Lazy<<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>> 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="getResourceFromJar(java.lang.String)">
|
|
<h3>getResourceFromJar</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></span> <span class="element-name">getResourceFromJar</span><wbr><span class="parameters">(<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> resourceName)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="PlanFiles.html#getResourceFromJar(java.lang.String)">PlanFiles</a></code></span></div>
|
|
<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 class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="PlanFiles.html#getResourceFromJar(java.lang.String)">getResourceFromJar</a></code> in class <code><a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>resourceName</code> - Path to the file inside jar/assets/plan/ folder.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|