<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (16) --> <title>JarResource (Plan 5.4-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: JarResource"> <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.5.1.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">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </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">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" 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 JarResource" class="title">Class JarResource</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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">com.djrapitops.plan.storage.file.JarResource</div> </div> <section class="description"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JarResource</span> <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> implements <a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></span></div> <div class="block"><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file"><code>Resource</code></a> implementation for something that is read via InputStream.</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== NESTED CLASS SUMMARY ======== --> <li> <section class="nested-class-summary" id="nested.class.summary"> <h2>Nested Class Summary</h2> <div class="caption"><span>Nested Classes</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Class</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>static interface </code></div> <div class="col-second even-row-color"><code><span class="member-name-link"><a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a></span></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code>static interface </code></div> <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="JarResource.StreamSupplier.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamSupplier</a></span></code></div> <div class="col-last odd-row-color"> </div> </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><span class="member-name-link"><a href="#%3Cinit%3E(java.lang.String,com.djrapitops.plan.storage.file.JarResource.StreamFunction)">JarResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName, <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> streamFunction)</code></div> <div class="col-last even-row-color"> </div> <div class="col-constructor-name odd-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(java.lang.String,com.djrapitops.plan.storage.file.JarResource.StreamSupplier)">JarResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName, <a href="JarResource.StreamSupplier.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamSupplier</a> streamSupplier)</code></div> <div class="col-last odd-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-tab2 method-summary-table-tab4 method-summary-table"><code>byte[]</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#asBytes()">asBytes</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#asInputStream()">asInputStream</a></span>()</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Get the resource as an InputStream.</div> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#asLines()">asLines</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Get the resource as lines.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#asString()">asString</a></span>()</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Get the resource as a String with each line separated by CRLF newline characters <code>\r\n</code>.</div> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getResourceName()">getResourceName</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Get the name of this Resource.</div> </div> </div> </div> </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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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> <div class="inherited-list"> <h3 id="methods.inherited.from.class.com.djrapitops.plan.storage.file.Resource">Methods inherited from interface com.djrapitops.plan.storage.file.<a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></h3> <code><a href="Resource.html#asParsed(com.google.gson.Gson,com.google.gson.reflect.TypeToken)">asParsed</a>, <a href="Resource.html#asWebResource()">asWebResource</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.lang.String,com.djrapitops.plan.storage.file.JarResource.StreamSupplier)"> <h3>JarResource</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JarResource</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName, <a href="JarResource.StreamSupplier.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamSupplier</a> streamSupplier)</span></div> </section> </li> <li> <section class="detail" id="<init>(java.lang.String,com.djrapitops.plan.storage.file.JarResource.StreamFunction)"> <h3>JarResource</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JarResource</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName, <a href="JarResource.StreamFunction.html" title="interface in com.djrapitops.plan.storage.file">JarResource.StreamFunction</a> streamFunction)</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="asInputStream()"> <h3>asInputStream</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a></span> <span class="element-name">asInputStream</span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Resource.html#asInputStream()">Resource</a></code></span></div> <div class="block">Get the resource as an InputStream.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Resource.html#asInputStream()">asInputStream</a></code> in interface <code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> <dt>Returns:</dt> <dd>InputStream of the resource, not closed automatically.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the resource is unavailable.</dd> </dl> </section> </li> <li> <section class="detail" id="asLines()"> <h3>asLines</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">asLines</span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Resource.html#asLines()">Resource</a></code></span></div> <div class="block">Get the resource as lines.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Resource.html#asLines()">asLines</a></code> in interface <code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> <dt>Returns:</dt> <dd>Lines of the resource file.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the resource is unavailable.</dd> </dl> </section> </li> <li> <section class="detail" id="asString()"> <h3>asString</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">asString</span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Resource.html#asString()">Resource</a></code></span></div> <div class="block">Get the resource as a String with each line separated by CRLF newline characters <code>\r\n</code>.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Resource.html#asString()">asString</a></code> in interface <code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> <dt>Returns:</dt> <dd>Flat string with each line separated by <code>\r\n</code>.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the resource is unavailable.</dd> </dl> </section> </li> <li> <section class="detail" id="asBytes()"> <h3>asBytes</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">asBytes</span>() throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Resource.html#asBytes()">asBytes</a></code> in interface <code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> </dl> </section> </li> <li> <section class="detail" id="getResourceName()"> <h3>getResourceName</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getResourceName</span>()</div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Resource.html#getResourceName()">Resource</a></code></span></div> <div class="block">Get the name of this Resource.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="Resource.html#getResourceName()">getResourceName</a></code> in interface <code><a href="Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a></code></dd> <dt>Returns:</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> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>