mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 08:20:39 +01:00
231 lines
14 KiB
HTML
231 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>WebResource (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.delivery.web.resource, interface: WebResource">
|
|
<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><a href="#nested-class-summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.delivery.web.resource</a></div>
|
|
<h1 title="Interface WebResource" class="title">Interface WebResource</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="WebResource.ByteResource.html" title="class in com.djrapitops.plan.delivery.web.resource">WebResource.ByteResource</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WebResource</span></div>
|
|
<div class="block">Represents a customizable resource.
|
|
<p>
|
|
You can use the create methods for simple resources when using <a href="../ResourceService.html" title="interface in com.djrapitops.plan.delivery.web"><code>ResourceService</code></a>.
|
|
<p>
|
|
It is assumed that any text based files are encoded in UTF-8.</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">Interface</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="WebResource.ByteResource.html" class="type-name-link" title="class in com.djrapitops.plan.delivery.web.resource">WebResource.ByteResource</a></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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>byte[]</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#asBytes()" class="member-name-link">asBytes</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab3"><code><a href="#asStream()" class="member-name-link">asStream</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#asString()" class="member-name-link">asString</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Return the resource as a UTF-8 String.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#create(byte%5B%5D)" class="member-name-link">create</a><wbr>(byte[] content)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Create a new WebResource from byte array.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#create(java.io.InputStream)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Creates a new WebResource from an InputStream.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#create(java.lang.String)" class="member-name-link">create</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> utf8String)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Create a new WebResource from an UTF-8 String.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="create(byte[])">
|
|
<h3>create</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></span> <span class="element-name">create</span><wbr><span class="parameters">(byte[] content)</span></div>
|
|
<div class="block">Create a new WebResource from byte array.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>content</code> - Bytes of the resource.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>WebResource.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="create(java.lang.String)">
|
|
<h3>create</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></span> <span class="element-name">create</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> utf8String)</span></div>
|
|
<div class="block">Create a new WebResource from an UTF-8 String.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>utf8String</code> - String in UTF-8 encoding.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>WebResource.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="create(java.io.InputStream)">
|
|
<h3>create</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in)</span>
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/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">Creates a new WebResource from an InputStream.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>in</code> - InputStream for the resource, closed after inside the method.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>WebResource.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the stream can not be read.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="asBytes()">
|
|
<h3>asBytes</h3>
|
|
<div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name">asBytes</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="asString()">
|
|
<h3>asString</h3>
|
|
<div class="member-signature"><span class="return-type"><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></span> <span class="element-name">asString</span>()</div>
|
|
<div class="block">Return the resource as a UTF-8 String.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The resource in UTF-8.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="asStream()">
|
|
<h3>asStream</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">asStream</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|