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
48c4b75b5c
Plan/all/com/djrapitops/plan/delivery/export/ServerPageExporter.html

323 lines
15 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-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>ServerPageExporter (Plan 5.1-SNAPSHOT API)</title>
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-03-21 15:43:05 +01:00
parent.document.title="ServerPageExporter (Plan 5.1-SNAPSHOT API)";
Updated javadocs
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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><a href="../../../../../com/djrapitops/plan/delivery/export/PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/delivery/export/ServerPageExporter.html" target="_top">Frames</a></li>
<li><a href="ServerPageExporter.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 ServerPageExporter" class="title">Class ServerPageExporter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.export.ServerPageExporter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Singleton
public class <span class="typeNameLabel">ServerPageExporter</span>
extends java.lang.Object</pre>
<div class="block">Handles exporting of /server page html, data and resources.</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-03-21 15:43:05 +01:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/ServerPageExporter.html#ServerPageExporter-com.djrapitops.plan.storage.file.PlanFiles-com.djrapitops.plan.delivery.rendering.pages.PageFactory-com.djrapitops.plan.storage.database.DBSystem-com.djrapitops.plan.delivery.webserver.resolver.json.RootJSONResolver-com.djrapitops.plan.settings.theme.Theme-com.djrapitops.plan.identification.ServerInfo-">ServerPageExporter</a></span>(<a href="../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
Updated javadocs
2019-10-05 10:27:37 +02:00
<a href="../../../../../com/djrapitops/plan/delivery/rendering/pages/PageFactory.html" title="class in com.djrapitops.plan.delivery.rendering.pages">PageFactory</a>&nbsp;pageFactory,
<a href="../../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
Updated javadocs
2020-03-21 15:43:05 +01:00
<a href="../../../../../com/djrapitops/plan/delivery/webserver/resolver/json/RootJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">RootJSONResolver</a>&nbsp;jsonHandler,
Updated javadocs
2019-10-05 10:27:37 +02:00
<a href="../../../../../com/djrapitops/plan/settings/theme/Theme.html" title="class in com.djrapitops.plan.settings.theme">Theme</a>&nbsp;theme,
<a href="../../../../../com/djrapitops/plan/identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo)</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/ServerPageExporter.html#export-java.nio.file.Path-com.djrapitops.plan.identification.Server-">export</a></span>(java.nio.file.Path&nbsp;toDirectory,
Updated javadocs
2020-03-21 15:43:05 +01:00
<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</code>
<div class="block">Perform export for a server page.</div>
</td>
Updated javadocs
2019-10-05 10:27:37 +02:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/delivery/export/ServerPageExporter.html#exportJSON-java.nio.file.Path-com.djrapitops.plan.identification.Server-">exportJSON</a></span>(java.nio.file.Path&nbsp;toDirectory,
Updated javadocs
2020-03-21 15:43:05 +01:00
<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)</code>
<div class="block">Perform export for a server page json payload.</div>
</td>
Updated javadocs
2019-10-05 10:27:37 +02:00
</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-03-21 15:43:05 +01:00
<a name="ServerPageExporter-com.djrapitops.plan.storage.file.PlanFiles-com.djrapitops.plan.delivery.rendering.pages.PageFactory-com.djrapitops.plan.storage.database.DBSystem-com.djrapitops.plan.delivery.webserver.resolver.json.RootJSONResolver-com.djrapitops.plan.settings.theme.Theme-com.djrapitops.plan.identification.ServerInfo-">
Updated javadocs
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerPageExporter</h4>
<pre>@Inject
public&nbsp;ServerPageExporter(<a href="../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
<a href="../../../../../com/djrapitops/plan/delivery/rendering/pages/PageFactory.html" title="class in com.djrapitops.plan.delivery.rendering.pages">PageFactory</a>&nbsp;pageFactory,
<a href="../../../../../com/djrapitops/plan/storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
Updated javadocs
2020-03-21 15:43:05 +01:00
<a href="../../../../../com/djrapitops/plan/delivery/webserver/resolver/json/RootJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">RootJSONResolver</a>&nbsp;jsonHandler,
Updated javadocs
2019-10-05 10:27:37 +02:00
<a href="../../../../../com/djrapitops/plan/settings/theme/Theme.html" title="class in com.djrapitops.plan.settings.theme">Theme</a>&nbsp;theme,
<a href="../../../../../com/djrapitops/plan/identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="export-java.nio.file.Path-com.djrapitops.plan.identification.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>export</h4>
<pre>public&nbsp;void&nbsp;export(java.nio.file.Path&nbsp;toDirectory,
<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)
Updated javadocs
2020-03-21 15:43:05 +01:00
throws java.io.IOException</pre>
<div class="block">Perform export for a server page.</div>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dl>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toDirectory</code> - Path to Export directory</dd>
<dd><code>server</code> - Server to export</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dd><code>java.io.IOException</code> - If a template can not be read from jar/disk or the result written</dd>
<dd><code><a href="../../../../../com/djrapitops/plan/delivery/web/resolver/exception/NotFoundException.html" title="class in com.djrapitops.plan.delivery.web.resolver.exception">NotFoundException</a></code> - If a file or resource that is being exported can not be found</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
</dl>
</li>
</ul>
<a name="exportJSON-java.nio.file.Path-com.djrapitops.plan.identification.Server-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>exportJSON</h4>
<pre>public&nbsp;void&nbsp;exportJSON(java.nio.file.Path&nbsp;toDirectory,
<a href="../../../../../com/djrapitops/plan/identification/Server.html" title="class in com.djrapitops.plan.identification">Server</a>&nbsp;server)
Updated javadocs
2020-03-21 15:43:05 +01:00
throws java.io.IOException</pre>
<div class="block">Perform export for a server page json payload.</div>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dl>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toDirectory</code> - Path to Export directory</dd>
<dd><code>server</code> - Server to export</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
Updated javadocs
2020-03-21 15:43:05 +01:00
<dd><code>java.io.IOException</code> - If a template can not be read from jar/disk or the result written</dd>
<dd><code><a href="../../../../../com/djrapitops/plan/delivery/web/resolver/exception/NotFoundException.html" title="class in com.djrapitops.plan.delivery.web.resolver.exception">NotFoundException</a></code> - If a file or resource that is being exported can not be found</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
</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><a href="../../../../../com/djrapitops/plan/delivery/export/PlayersPageExporter.html" title="class in com.djrapitops.plan.delivery.export"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/delivery/export/ServerPageExporter.html" target="_top">Frames</a></li>
<li><a href="ServerPageExporter.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