Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-02 00:39:34 +01:00
Code Issues Projects Releases Wiki Activity
dd315e724f
Plan/all/com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html
Rsl1122 dd315e724f Updated javadocs
2020-03-21 16:43:05 +02:00

301 lines
12 KiB
HTML
Raw Blame History

<!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 -->
<title>AbstractPlanPlaceHolder (Plan 5.1-SNAPSHOT API)</title>
<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="AbstractPlanPlaceHolder (Plan 5.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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="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/addons/placeholderapi/placeholders/OperatorPlaceholders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html" target="_top">Frames</a></li>
<li><a href="AbstractPlanPlaceHolder.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">com.djrapitops.plan.addons.placeholderapi.placeholders</div>
<h2 title="Class AbstractPlanPlaceHolder" class="title">Class AbstractPlanPlaceHolder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.addons.placeholderapi.placeholders.AbstractPlanPlaceHolder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/OperatorPlaceholders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders">OperatorPlaceholders</a>, <a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/PlayerPlaceHolder.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders">PlayerPlaceHolder</a>, <a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/ServerPlaceHolders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders">ServerPlaceHolders</a>, <a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/SessionPlaceHolder.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders">SessionPlaceHolder</a>, <a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/WorldTimePlaceHolder.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders">WorldTimePlaceHolder</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPlanPlaceHolder</span>
extends java.lang.Object</pre>
<div class="block">abstract class used for plan placeholders list. This class contains most used
methods (static methods and non-static one). It is also used as a universe
interface for the Plan-placeholders instances
<a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html#onPlaceholderRequest-org.bukkit.entity.Player-java.lang.String-"><code>onPlaceholderRequest(Player, String)</code></a>. Check <a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html" title="class in com.djrapitops.plan.addons.placeholderapi"><code>PlanPlaceHolders</code></a>
to learn more how it is used.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html" title="class in com.djrapitops.plan.addons.placeholderapi"><code>PlanPlaceHolders</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../com/djrapitops/plan/identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html#serverInfo">serverInfo</a></span></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="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>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html#onPlaceholderRequest-org.bukkit.entity.Player-java.lang.String-">onPlaceholderRequest</a></span>(org.bukkit.entity.Player&nbsp;p,
java.lang.String&nbsp;params)</code>
<div class="block">Look up the placeholder and check if it is registered in this instance.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="serverInfo">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>serverInfo</h4>
<pre>protected final&nbsp;<a href="../../../../../../com/djrapitops/plan/identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a> 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="onPlaceholderRequest-org.bukkit.entity.Player-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onPlaceholderRequest</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;onPlaceholderRequest(org.bukkit.entity.Player&nbsp;p,
java.lang.String&nbsp;params)
throws java.lang.Exception</pre>
<div class="block">Look up the placeholder and check if it is registered in this instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - the player who is viewing the placeholder</dd>
<dd><code>params</code> - the placeholder to look up to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the placeholder if found, or empty <code>String</code> if no
value found but the placeholder is registered,
otherwise <code>null</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if any error occurs</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/addons/placeholderapi/placeholders/OperatorPlaceholders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/addons/placeholderapi/placeholders/AbstractPlanPlaceHolder.html" target="_top">Frames</a></li>
<li><a href="AbstractPlanPlaceHolder.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink