mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-27 11:37:41 +01:00
260 lines
20 KiB
HTML
260 lines
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Exporter (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.export, class: Exporter">
|
|
<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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </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-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.export</a></div>
|
|
<h1 title="Class Exporter" class="title">Class Exporter</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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.delivery.export.Exporter</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="annotations">@Singleton
|
|
</span><span class="modifiers">public class </span><span class="element-name type-name-label">Exporter</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Handles export for different pages.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== 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><a href="#%3Cinit%3E(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.delivery.export.PlayerJSONExporter,com.djrapitops.plan.delivery.export.PlayerPageExporter,com.djrapitops.plan.delivery.export.PlayersPageExporter,com.djrapitops.plan.delivery.export.ServerPageExporter,com.djrapitops.plan.delivery.export.NetworkPageExporter)" class="member-name-link">Exporter</a><wbr>(<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="PlayerJSONExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerJSONExporter</a> playerJSONExporter,
|
|
<a href="PlayerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerPageExporter</a> playerPageExporter,
|
|
<a href="PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayersPageExporter</a> playersPageExporter,
|
|
<a href="ServerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">ServerPageExporter</a> serverPageExporter,
|
|
<a href="NetworkPageExporter.html" title="class in com.djrapitops.plan.delivery.export">NetworkPageExporter</a> networkPageExporter)</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-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 method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exportPlayerJSON(java.util.UUID,java.lang.String)" class="member-name-link">exportPlayerJSON</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<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> playerName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Export Raw Data JSON of a player.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exportPlayerPage(java.util.UUID,java.lang.String)" class="member-name-link">exportPlayerPage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<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> playerName)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Export page of a player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exportPlayersPage()" class="member-name-link">exportPlayersPage</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exportServerJSON(com.djrapitops.plan.identification.Server)" class="member-name-link">exportServerJSON</a><wbr>(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exportServerPage(com.djrapitops.plan.identification.Server)" class="member-name-link">exportServerPage</a><wbr>(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Export a page of a server.</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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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>
|
|
</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>(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.delivery.export.PlayerJSONExporter,com.djrapitops.plan.delivery.export.PlayerPageExporter,com.djrapitops.plan.delivery.export.PlayersPageExporter,com.djrapitops.plan.delivery.export.ServerPageExporter,com.djrapitops.plan.delivery.export.NetworkPageExporter)">
|
|
<h3>Exporter</h3>
|
|
<div class="member-signature"><span class="annotations">@Inject
|
|
</span><span class="modifiers">public</span> <span class="element-name">Exporter</span><wbr><span class="parameters">(<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="PlayerJSONExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerJSONExporter</a> playerJSONExporter,
|
|
<a href="PlayerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerPageExporter</a> playerPageExporter,
|
|
<a href="PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayersPageExporter</a> playersPageExporter,
|
|
<a href="ServerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">ServerPageExporter</a> serverPageExporter,
|
|
<a href="NetworkPageExporter.html" title="class in com.djrapitops.plan.delivery.export">NetworkPageExporter</a> networkPageExporter)</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="exportServerPage(com.djrapitops.plan.identification.Server)">
|
|
<h3>exportServerPage</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">exportServerPage</span><wbr><span class="parameters">(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</span>
|
|
throws <span class="exceptions"><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></span></div>
|
|
<div class="block">Export a page of a server.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>server</code> - Server which page is going to be exported</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>false if the page was not exported due to previous failure or is disabled in config.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code> - If the export failed due to IO, NotFound or GenerationException.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="exportServerJSON(com.djrapitops.plan.identification.Server)">
|
|
<h3>exportServerJSON</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">exportServerJSON</span><wbr><span class="parameters">(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</span>
|
|
throws <span class="exceptions"><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></span></div>
|
|
<dl class="notes">
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="exportPlayerPage(java.util.UUID,java.lang.String)">
|
|
<h3>exportPlayerPage</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">exportPlayerPage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<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> playerName)</span>
|
|
throws <span class="exceptions"><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></span></div>
|
|
<div class="block">Export page of a player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>playerName</code> - Name of the player.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>false if the page was not exported due to config settings.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code> - If the export failed due to IO, NotFound or GenerationException.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="exportPlayersPage()">
|
|
<h3>exportPlayersPage</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">exportPlayersPage</span>()
|
|
throws <span class="exceptions"><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></span></div>
|
|
<dl class="notes">
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="exportPlayerJSON(java.util.UUID,java.lang.String)">
|
|
<h3>exportPlayerJSON</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">exportPlayerJSON</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<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> playerName)</span>
|
|
throws <span class="exceptions"><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></span></div>
|
|
<div class="block">Export Raw Data JSON of a player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>playerName</code> - Name of the player.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>false if the json was not exported due to config settings.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code> - If the export failed due to IOException.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|