Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
635b6f4989
Plan/all/com/djrapitops/plan/delivery/export/Exporter.html

387 lines
18 KiB
HTML
Raw Normal View History

Updated javadocs
2019-10-05 10:27:37 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
Updated javadocs
2020-01-24 11:56:15 +01:00
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:56:10 EET 2020 -->
<title>Exporter (Plan 5.0-SNAPSHOT API)</title>
<meta name="date" content="2020-01-24">
Updated javadocs
2019-10-05 10:27:37 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
Updated javadocs
2020-01-24 11:56:15 +01:00
parent.document.title="Exporter (Plan 5.0-SNAPSHOT API)";
Updated javadocs
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../com/djrapitops/plan/delivery/export/ExportPaths.html" title="class in com.djrapitops.plan.delivery.export"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/delivery/export/Exporter.html" target="_top">Frames</a></li>
<li><a href="Exporter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.delivery.export</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>
<br>
<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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
Updated javadocs
2020-01-24 11:56:15 +01:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#Exporter-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="../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
Updated javadocs
2019-10-05 10:27:37 +02:00
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayerJSONExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerJSONExporter</a>&nbsp;playerJSONExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerPageExporter</a>&nbsp;playerPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayersPageExporter</a>&nbsp;playersPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/ServerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">ServerPageExporter</a>&nbsp;serverPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/NetworkPageExporter.html" title="class in com.djrapitops.plan.delivery.export">NetworkPageExporter</a>&nbsp;networkPageExporter)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#exportPlayerJSON-java.util.UUID-java.lang.String-">exportPlayerJSON</a></span>(java.util.UUID&nbsp;playerUUID,
java.lang.String&nbsp;playerName)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#exportPlayerPage-java.util.UUID-java.lang.String-">exportPlayerPage</a></span>(java.util.UUID&nbsp;playerUUID,
java.lang.String&nbsp;playerName)</code>
<div class="block">Export page of a player.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#exportPlayersPage--">exportPlayersPage</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#exportServerJSON-com.djrapitops.plan.identification.Server-">exportServerJSON</a></span>(<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/Exporter.html#exportServerPage-com.djrapitops.plan.identification.Server-">exportServerPage</a></span>(<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</code>
<div class="block">Export a page of a server.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
Updated javadocs
2020-01-24 11:56:15 +01:00
<a name="Exporter-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-">
Updated javadocs
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Exporter</h4>
<pre>@Inject
Updated javadocs
2020-01-24 11:56:15 +01:00
public&nbsp;Exporter(<a href="../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
Updated javadocs
2019-10-05 10:27:37 +02:00
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayerJSONExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerJSONExporter</a>&nbsp;playerJSONExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayerPageExporter</a>&nbsp;playerPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export">PlayersPageExporter</a>&nbsp;playersPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/ServerPageExporter.html" title="class in com.djrapitops.plan.delivery.export">ServerPageExporter</a>&nbsp;serverPageExporter,
<a href="../../../../../com/djrapitops/plan/delivery/export/NetworkPageExporter.html" title="class in com.djrapitops.plan.delivery.export">NetworkPageExporter</a>&nbsp;networkPageExporter)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="exportServerPage-com.djrapitops.plan.identification.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportServerPage</h4>
<pre>public&nbsp;boolean&nbsp;exportServerPage(<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)
throws <a href="../../../../../com/djrapitops/plan/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>
Updated javadocs
2020-01-24 11:56:15 +01:00
<dd><code><a href="../../../../../com/djrapitops/plan/exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code> - If the export failed due to IO, NotFound or GenerationException.</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
</dl>
</li>
</ul>
<a name="exportServerJSON-com.djrapitops.plan.identification.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportServerJSON</h4>
<pre>public&nbsp;boolean&nbsp;exportServerJSON(<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)
throws <a href="../../../../../com/djrapitops/plan/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="../../../../../com/djrapitops/plan/exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
</dl>
</li>
</ul>
<a name="exportPlayerPage-java.util.UUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportPlayerPage</h4>
<pre>public&nbsp;boolean&nbsp;exportPlayerPage(java.util.UUID&nbsp;playerUUID,
java.lang.String&nbsp;playerName)
throws <a href="../../../../../com/djrapitops/plan/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>
Updated javadocs
2020-01-24 11:56:15 +01:00
<dd><code><a href="../../../../../com/djrapitops/plan/exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code> - If the export failed due to IO, NotFound or GenerationException.</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
</dl>
</li>
</ul>
<a name="exportPlayersPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportPlayersPage</h4>
<pre>public&nbsp;boolean&nbsp;exportPlayersPage()
throws <a href="../../../../../com/djrapitops/plan/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="../../../../../com/djrapitops/plan/exceptions/ExportException.html" title="class in com.djrapitops.plan.exceptions">ExportException</a></code></dd>
</dl>
</li>
</ul>
<a name="exportPlayerJSON-java.util.UUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>exportPlayerJSON</h4>
<pre>public&nbsp;boolean&nbsp;exportPlayerJSON(java.util.UUID&nbsp;playerUUID,
java.lang.String&nbsp;playerName)
throws <a href="../../../../../com/djrapitops/plan/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="../../../../../com/djrapitops/plan/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>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../com/djrapitops/plan/delivery/export/ExportPaths.html" title="class in com.djrapitops.plan.delivery.export"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/delivery/export/Exporter.html" target="_top">Frames</a></li>
<li><a href="Exporter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink