2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > SpongePlanFiles (Plan 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../jquery/jquery-ui.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="SpongePlanFiles (Plan 5.2-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":10};
2019-08-05 11:13:19 +02:00
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";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
2021-03-10 09:12:21 +01:00
< li > < a href = "#field.summary" > Field< / a > | < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.storage.file< / a > < / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Class SpongePlanFiles" class = "title" > Class SpongePlanFiles< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
2021-03-10 09:12:21 +01:00
< li > < a href = "PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > com.djrapitops.plan.storage.file.PlanFiles< / a > < / li >
2019-08-05 11:13:19 +02:00
< li >
< ul class = "inheritance" >
2019-10-05 10:27:37 +02:00
< li > com.djrapitops.plan.storage.file.SpongePlanFiles< / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Implemented Interfaces:< / dt >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "../../SubSystem.html" title = "interface in com.djrapitops.plan" > SubSystem< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< pre > @Singleton
public class < span class = "typeNameLabel" > SpongePlanFiles< / span >
2021-03-10 09:12:21 +01:00
extends < a href = "PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > PlanFiles< / a > < / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Implements jar resource fetching with Sponge Asset API.< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- =========== FIELD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "field.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Field Summary< / h3 >
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "fields.inherited.from.class.com.djrapitops.plan.storage.file.PlanFiles" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2021-03-10 09:12:21 +01:00
< h3 > 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 > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "constructor.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-08-05 11:13:19 +02:00
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
2021-03-10 09:12:21 +01:00
< th class = "colFirst" scope = "col" > Constructor< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr class = "altColor" >
2021-03-10 09:12:21 +01:00
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction,com.djrapitops.plan.PlanPlugin)" > SpongePlanFiles< / a > < / span > ​ (java.io.File 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)< / code > < / th >
< td class = "colLast" > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-08-05 11:13:19 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i0" class = "altColor" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / td >
< / tr >
< / table >
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "methods.inherited.from.class.com.djrapitops.plan.storage.file.PlanFiles" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
2021-03-10 09:12:21 +01:00
< h3 > 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#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#getCustomizationDirectory()" > getCustomizationDirectory< / 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 > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "methods.inherited.from.class.java.lang.Object" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / 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 >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "constructor.detail" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "<init>(java.io.File,com.djrapitops.plan.storage.file.JarResource.StreamFunction,com.djrapitops.plan.PlanPlugin)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > SpongePlanFiles< / h4 >
< pre > @Inject
2021-03-10 09:12:21 +01:00
public SpongePlanFiles​ (@Named("dataFolder")
java.io.File 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)< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "getResourceFromJar(java.lang.String)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getResourceFromJar< / h4 >
2021-03-10 09:12:21 +01:00
< 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" > < span class = "descfrmTypeLabel" > 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 >
2019-08-05 11:13:19 +02:00
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > a < a href = "Resource.html" title = "interface in com.djrapitops.plan.storage.file" > < code > Resource< / code > < / a > for accessing the resource.< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../allclasses.html" > All Classes< / a > < / li >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
2021-03-10 09:12:21 +01:00
< li > < a href = "#field.summary" > Field< / a > | < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2019-08-05 11:13:19 +02:00
< / body >
< / html >
