Plan/docs/main/java/com/djrapitops/plan/api/IPlan.html

386 lines
17 KiB
HTML
Raw Normal View History

2017-10-02 20:53:29 +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>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 02 21:49:45 EEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IPlan (Plan 4.0.0 API)</title>
<meta name="date" content="2017-10-02">
<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) {
parent.document.title="IPlan (Plan 4.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/IPlan.html">Use</a></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="../../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?main/java/com/djrapitops/plan/api/IPlan.html" target="_top">Frames</a></li>
<li><a href="IPlan.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>Constr&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>Constr&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">main.java.com.djrapitops.plan.api</div>
<h2 title="Interface IPlan" class="title">Interface IPlan</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.djrapitops.plugin.IPlugin</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a>, <a href="../../../../../../main/java/com/djrapitops/plan/PlanBungee.html" title="class in main.java.com.djrapitops.plan">PlanBungee</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IPlan</span>
extends com.djrapitops.plugin.IPlugin</pre>
<div class="block">Abstraction interface for both Plan and PlanBungee.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Rsl1122</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#addToProcessQueue-main.java.com.djrapitops.plan.systems.processing.Processor...-">addToProcessQueue</a></span>(<a href="../../../../../../main/java/com/djrapitops/plan/systems/processing/Processor.html" title="class in main.java.com.djrapitops.plan.systems.processing">Processor</a>...&nbsp;processors)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getDataFolder--">getDataFolder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getDB--">getDB</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>com.djrapitops.plugin.config.IConfig</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getIConfig--">getIConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/systems/info/InformationManager.html" title="class in main.java.com.djrapitops.plan.systems.info">InformationManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getInfoManager--">getInfoManager</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/systems/queue/ProcessingQueue.html" title="class in main.java.com.djrapitops.plan.systems.queue">ProcessingQueue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getProcessingQueue--">getProcessingQueue</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getResource-java.lang.String-">getResource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resource)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getServerUuid--">getServerUuid</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/ServerVariableHolder.html" title="class in main.java.com.djrapitops.plan">ServerVariableHolder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getVariable--">getVariable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../main/java/com/djrapitops/plan/systems/webserver/WebServer.html" title="class in main.java.com.djrapitops.plan.systems.webserver">WebServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#getWebServer--">getWebServer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../main/java/com/djrapitops/plan/api/IPlan.html#restart--">restart</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plugin.IPlugin">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plugin.IPlugin</h3>
<code>benchmark, copyDefaultConfig, disablePlugin, fetch, getAPFVersion, getColorScheme, getNotificationCenter, getPluginLogger, getPrefix, getRunnableFactory, getUpdateCheckUrl, getUpdateUrl, getVersion, onDisable, onEnable, onEnableDefaultTasks, registerCommand, setColorScheme, setDebugMode, setLog, setLogPrefix, taskStatus</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDB--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDB</h4>
<pre><a href="../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a>&nbsp;getDB()</pre>
</li>
</ul>
<a name="getVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariable</h4>
<pre><a href="../../../../../../main/java/com/djrapitops/plan/ServerVariableHolder.html" title="class in main.java.com.djrapitops.plan">ServerVariableHolder</a>&nbsp;getVariable()</pre>
</li>
</ul>
<a name="getServerUuid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerUuid</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;getServerUuid()</pre>
</li>
</ul>
<a name="getInfoManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfoManager</h4>
<pre><a href="../../../../../../main/java/com/djrapitops/plan/systems/info/InformationManager.html" title="class in main.java.com.djrapitops.plan.systems.info">InformationManager</a>&nbsp;getInfoManager()</pre>
</li>
</ul>
<a name="getWebServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWebServer</h4>
<pre><a href="../../../../../../main/java/com/djrapitops/plan/systems/webserver/WebServer.html" title="class in main.java.com.djrapitops.plan.systems.webserver">WebServer</a>&nbsp;getWebServer()</pre>
</li>
</ul>
<a name="getDataFolder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataFolder</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getDataFolder()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDataFolder</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
</dl>
</li>
</ul>
<a name="getProcessingQueue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessingQueue</h4>
<pre><a href="../../../../../../main/java/com/djrapitops/plan/systems/queue/ProcessingQueue.html" title="class in main.java.com.djrapitops.plan.systems.queue">ProcessingQueue</a>&nbsp;getProcessingQueue()</pre>
</li>
</ul>
<a name="addToProcessQueue-main.java.com.djrapitops.plan.systems.processing.Processor...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToProcessQueue</h4>
<pre>void&nbsp;addToProcessQueue(<a href="../../../../../../main/java/com/djrapitops/plan/systems/processing/Processor.html" title="class in main.java.com.djrapitops.plan.systems.processing">Processor</a>...&nbsp;processors)</pre>
</li>
</ul>
<a name="getResource-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;getResource(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resource)</pre>
</li>
</ul>
<a name="getIConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIConfig</h4>
<pre>com.djrapitops.plugin.config.IConfig&nbsp;getIConfig()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getIConfig</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="restart--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>restart</h4>
<pre>void&nbsp;restart()</pre>
</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="class-use/IPlan.html">Use</a></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="../../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?main/java/com/djrapitops/plan/api/IPlan.html" target="_top">Frames</a></li>
<li><a href="IPlan.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>