mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
425 lines
17 KiB
HTML
425 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>Exporter (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="Exporter (Plan 5.3-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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.delivery.export</a></div>
|
|
<h2 title="Class Exporter" class="title">Class Exporter</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.delivery.export.Exporter</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>@Singleton
|
|
public class <span class="typeNameLabel">Exporter</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Handles export for different pages.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><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)">Exporter</a></span>​(<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></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportPlayerJSON(java.util.UUID,java.lang.String)">exportPlayerJSON</a></span>​(java.util.UUID playerUUID,
|
|
java.lang.String playerName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Export Raw Data JSON of a player.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportPlayerPage(java.util.UUID,java.lang.String)">exportPlayerPage</a></span>​(java.util.UUID playerUUID,
|
|
java.lang.String playerName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Export page of a player.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportPlayersPage()">exportPlayersPage</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportServerJSON(com.djrapitops.plan.identification.Server)">exportServerJSON</a></span>​(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportServerPage(com.djrapitops.plan.identification.Server)">exportServerPage</a></span>​(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Export a page of a server.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a 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)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Exporter</h4>
|
|
<pre>@Inject
|
|
public Exporter​(<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)</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="exportServerPage(com.djrapitops.plan.identification.Server)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exportServerPage</h4>
|
|
<pre class="methodSignature">public boolean exportServerPage​(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)
|
|
throws <a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></pre>
|
|
<div class="block">Export a page of a server.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>server</code> - Server which page is going to be exported</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>false if the page was not exported due to previous failure or is disabled in config.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></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>
|
|
</li>
|
|
</ul>
|
|
<a id="exportServerJSON(com.djrapitops.plan.identification.Server)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exportServerJSON</h4>
|
|
<pre class="methodSignature">public boolean exportServerJSON​(<a href="../../identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a> server)
|
|
throws <a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></pre>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="exportPlayerPage(java.util.UUID,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exportPlayerPage</h4>
|
|
<pre class="methodSignature">public boolean exportPlayerPage​(java.util.UUID playerUUID,
|
|
java.lang.String playerName)
|
|
throws <a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></pre>
|
|
<div class="block">Export page of a player.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>playerName</code> - Name of the player.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>false if the page was not exported due to config settings.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></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>
|
|
</li>
|
|
</ul>
|
|
<a id="exportPlayersPage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exportPlayersPage</h4>
|
|
<pre class="methodSignature">public boolean exportPlayersPage()
|
|
throws <a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></pre>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="exportPlayerJSON(java.util.UUID,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>exportPlayerJSON</h4>
|
|
<pre class="methodSignature">public boolean exportPlayerJSON​(java.util.UUID playerUUID,
|
|
java.lang.String playerName)
|
|
throws <a href="../../exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></pre>
|
|
<div class="block">Export Raw Data JSON of a player.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>playerName</code> - Name of the player.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>false if the json was not exported due to config settings.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></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>
|
|
</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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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>
|