<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>Resource (Plan 5.3-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="Resource (Plan 5.3-SNAPSHOT API)"; } } catch(err) { } //--> var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6,"i6":1}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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>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 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="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> <dd><code><a href="FileResource.html" title="class in com.djrapitops.plan.storage.file">FileResource</a></code>, <code><a href="JarResource.html" title="class in com.djrapitops.plan.storage.file">JarResource</a></code>, <code><a href="SpongeAssetResource.html" title="class in com.djrapitops.plan.storage.file">SpongeAssetResource</a></code>, <code><a href="StringCachingResource.html" title="class in com.djrapitops.plan.storage.file">StringCachingResource</a></code>, <code><a href="StringResource.html" title="class in com.djrapitops.plan.storage.file">StringResource</a></code></dd> </dl> <hr> <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 =========== --> <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="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> <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>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asBytes()">asBytes</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.io.InputStream</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asInputStream()">asInputStream</a></span>()</code></th> <td class="colLast"> <div class="block">Get the resource as an InputStream.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asLines()">asLines</a></span>()</code></th> <td class="colLast"> <div class="block">Get the resource as lines.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asString()">asString</a></span>()</code></th> <td class="colLast"> <div class="block">Get the resource as a String with each line separated by CRLF newline characters <code>\r\n</code>.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>default <a href="../../delivery/web/resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asWebResource()">asWebResource</a></span>()</code></th> <td class="colLast"> <div class="block">Map to a WebResource used by <a href="../../delivery/web/ResourceService.html" title="interface in com.djrapitops.plan.delivery.web"><code>ResourceService</code></a> APIs.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceName()">getResourceName</a></span>()</code></th> <td class="colLast"> <div class="block">Get the name of this Resource.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>static boolean</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTextResource(java.lang.String)">isTextResource</a></span>​(java.lang.String resourceName)</code></th> <td class="colLast"> <div class="block">Check if a resource is a text based file.</div> </td> </tr> </table> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="getResourceName()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResourceName</h4> <pre class="methodSignature">java.lang.String getResourceName()</pre> <div class="block">Get the name of this Resource.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Relative file path given to <a href="PlanFiles.html" title="class in com.djrapitops.plan.storage.file"><code>PlanFiles</code></a>.</dd> </dl> </li> </ul> <a id="asBytes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asBytes</h4> <pre class="methodSignature">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> <a id="asInputStream()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asInputStream</h4> <pre class="methodSignature">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 id="asLines()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asLines</h4> <pre class="methodSignature">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 id="asString()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asString</h4> <pre class="methodSignature">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> <a id="asWebResource()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asWebResource</h4> <pre class="methodSignature">default <a href="../../delivery/web/resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a> asWebResource()</pre> <div class="block">Map to a WebResource used by <a href="../../delivery/web/ResourceService.html" title="interface in com.djrapitops.plan.delivery.web"><code>ResourceService</code></a> APIs.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The resource</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.UncheckedIOException</code> - if fails to read the file.</dd> </dl> </li> </ul> <a id="isTextResource(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>isTextResource</h4> <pre class="methodSignature">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> </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>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 id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>