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 >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
< title > Resource (Plan 5.1-SNAPSHOT API)< / title >
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) {
2020-03-21 15:43:05 +01:00
parent.document.title="Resource (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2020-03-21 15:43:05 +01:00
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6,"i6":17};
2020-01-24 11:56:15 +01:00
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
2019-08-05 11:13:19 +02:00
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" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/storage/file/ResourceCache.html" title = "class in com.djrapitops.plan.storage.file" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/storage/file/Resource.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "Resource.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../../allclasses-noframe.html" > All 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: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / 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" >
2019-10-05 10:27:37 +02:00
< div class = "subTitle" > com.djrapitops.plan.storage.file< / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Interface Resource" class = "title" > Interface Resource< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Known Implementing Classes:< / dt >
2019-10-05 10:27:37 +02:00
< dd > < a href = "../../../../../com/djrapitops/plan/storage/file/FileResource.html" title = "class in com.djrapitops.plan.storage.file" > FileResource< / a > , < a href = "../../../../../com/djrapitops/plan/storage/file/JarResource.html" title = "class in com.djrapitops.plan.storage.file" > JarResource< / a > , < a href = "../../../../../com/djrapitops/plan/storage/file/SpongeAssetResource.html" title = "class in com.djrapitops.plan.storage.file" > SpongeAssetResource< / a > , < a href = "../../../../../com/djrapitops/plan/storage/file/StringCachingResource.html" title = "class in com.djrapitops.plan.storage.file" > StringCachingResource< / a > , < a href = "../../../../../com/djrapitops/plan/storage/file/StringResource.html" title = "class in com.djrapitops.plan.storage.file" > StringResource< / a > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< br >
< pre > public interface < span class = "typeNameLabel" > Resource< / span > < / pre >
< div class = "block" > Interface for accessing plugin resources in jar or plugin files.< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========== 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" >
2020-01-24 11:56:15 +01:00
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / span > < span class = "tabEnd" > < / span > < / span > < span id = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / 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 = "t3" class = "tableTab" > < span > < a href = "javascript:show(4);" > Abstract Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t5" class = "tableTab" > < span > < a href = "javascript:show(16);" > Default Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < / caption >
2019-08-05 11:13:19 +02:00
< 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" >
2020-03-21 15:43:05 +01:00
< td class = "colFirst" > < code > byte[]< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#asBytes--" > asBytes< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i1" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > java.io.InputStream< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#asInputStream--" > asInputStream< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the resource as an InputStream.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i2" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > java.util.List< java.lang.String> < / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#asLines--" > asLines< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the resource as lines.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i3" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#asString--" > asString< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the resource as a String with each line separated by CRLF newline characters < code > \r\n< / code > .< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > default < a href = "../../../../../com/djrapitops/plan/delivery/web/resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#asWebResource--" > asWebResource< / a > < / span > ()< / code > < / td >
< / tr >
< tr id = "i5" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#getResourceName--" > getResourceName< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get the name of this Resource.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i6" class = "altColor" >
2020-01-24 11:56:15 +01:00
< td class = "colFirst" > < code > static boolean< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/storage/file/Resource.html#isTextResource-java.lang.String-" > isTextResource< / a > < / span > (java.lang.String resourceName)< / code >
< div class = "block" > Check if a resource is a text based file.< / div >
< / td >
< / tr >
2019-08-05 11:13:19 +02:00
< / table >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "getResourceName--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getResourceName< / h4 >
< pre > java.lang.String getResourceName()< / pre >
< div class = "block" > Get the name of this Resource.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
2019-10-05 10:27:37 +02:00
< dd > Relative file path given to < a href = "../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > < code > PlanFiles< / code > < / a > .< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
2020-03-21 15:43:05 +01:00
< a name = "asBytes--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > asBytes< / h4 >
< pre > byte[] asBytes()
throws java.io.IOException< / pre >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > < / dd >
< / dl >
< / li >
< / ul >
2019-08-05 11:13:19 +02:00
< a name = "asInputStream--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > asInputStream< / h4 >
< pre > java.io.InputStream asInputStream()
throws java.io.IOException< / pre >
< div class = "block" > Get the resource as an InputStream.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > InputStream of the resource, not closed automatically.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > - If the resource is unavailable.< / dd >
< / dl >
< / li >
< / ul >
< a name = "asLines--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > asLines< / h4 >
< pre > java.util.List< java.lang.String> asLines()
throws java.io.IOException< / pre >
< div class = "block" > Get the resource as lines.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Lines of the resource file.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > - If the resource is unavailable.< / dd >
< / dl >
< / li >
< / ul >
< a name = "asString--" >
<!-- -->
< / a >
2020-01-24 11:56:15 +01:00
< ul class = "blockList" >
2019-08-05 11:13:19 +02:00
< li class = "blockList" >
< h4 > asString< / h4 >
< pre > java.lang.String asString()
throws java.io.IOException< / pre >
< div class = "block" > Get the resource as a String with each line separated by CRLF newline characters < code > \r\n< / code > .< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Flat string with each line separated by < code > \r\n< / code > .< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.IOException< / code > - If the resource is unavailable.< / dd >
< / dl >
< / li >
< / ul >
2020-03-21 15:43:05 +01:00
< a name = "asWebResource--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > asWebResource< / h4 >
< pre > default < a href = "../../../../../com/djrapitops/plan/delivery/web/resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > asWebResource()< / pre >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.io.UncheckedIOException< / code > - if fails to read the file< / dd >
< / dl >
< / li >
< / ul >
2020-01-24 11:56:15 +01:00
< a name = "isTextResource-java.lang.String-" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > isTextResource< / h4 >
< pre > static boolean isTextResource(java.lang.String resourceName)< / pre >
< div class = "block" > Check if a resource is a text based file.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > resourceName< / code > - Name of the resource< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > true if the resource is text based.< / dd >
< / dl >
< / li >
< / ul >
2019-08-05 11:13:19 +02:00
< / 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" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/storage/file/ResourceCache.html" title = "class in com.djrapitops.plan.storage.file" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/storage/file/Resource.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "Resource.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../../allclasses-noframe.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 >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
