PlotSquared/doc/com/intellectualcrafters/plot/flag/FlagManager.html
2014-11-16 11:14:40 +01:00

525 lines
28 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:54 CET 2014 -->
<title>FlagManager</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "FlagManager";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-files/index-1.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/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/flag/FlagManager.html"
target="_top">Frames</a></li>
<li><a href="FlagManager.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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.intellectualcrafters.plot.flag</div>
<h2 title="Class FlagManager" class="title">Class FlagManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.plot.flag.FlagManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">FlagManager</span>
extends java.lang.Object</pre>
<div class="block">Flag Manager Utility</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="overviewSummary" 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">
<td class="colOne"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#FlagManager()">FlagManager</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#addFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">addFlag</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</code>
<div class="block">Register an AbstractFlag with PlotSquared</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#getFlag(java.lang.String)">getFlag</a></strong>(java.lang.String&nbsp;string)</code>
<div class="block">Get an AbstractFlag by a string Returns null if flag does not exist
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#getFlag(java.lang.String,%20boolean)">getFlag</a></strong>(java.lang.String&nbsp;string,
boolean&nbsp;create)</code>
<div class="block">Get an AbstractFlag by a string</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#getFlags()">getFlags</a></strong>()</code>
<div class="block">Get a list of registered AbstractFlag objects</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#getFlags(org.bukkit.entity.Player)">getFlags</a></strong>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get a list of registerd AbstragFlag objects based on player
permissions
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#getPlotFlags(com.intellectualcrafters.plot.object.Plot)">getPlotFlags</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;plot)</code>
<div class="block">Get the flags for a plot</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#parseFlags(java.util.List)">parseFlags</a></strong>(java.util.List&lt;java.lang.String&gt;&nbsp;flagstrings)</code>&nbsp;
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#removeFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">removeFlag</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</code>
<div class="block">Remove a registered AbstractFlag</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#removeFlag(com.intellectualcrafters.plot.flag.Flag[],%20java.lang.String)">removeFlag</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]&nbsp;flags,
java.lang.String&nbsp;r)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html#removeFlag(java.util.Set,%20java.lang.String)">removeFlag</a></strong>(java.util.Set&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>&gt;&nbsp;flags,
java.lang.String&nbsp;r)</code>&nbsp;</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>
<a name="FlagManager()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FlagManager</h4>
<pre>public&nbsp;FlagManager()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFlag</h4>
<pre>public static&nbsp;boolean&nbsp;addFlag(<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</pre>
<div class="block">Register an AbstractFlag with PlotSquared</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>flag</code> - Flag to register</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>success?</dd>
</dl>
</li>
</ul>
<a name="removeFlag(com.intellectualcrafters.plot.flag.Flag[], java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFlag</h4>
<pre>public static&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]&nbsp;removeFlag(<a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]&nbsp;flags,
java.lang.String&nbsp;r)</pre>
</li>
</ul>
<a name="removeFlag(java.util.Set, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFlag</h4>
<pre>public static&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]&nbsp;removeFlag(java.util.Set&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>&gt;&nbsp;flags,
java.lang.String&nbsp;r)</pre>
</li>
</ul>
<a name="getFlags()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags</h4>
<pre>public static&nbsp;java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;&nbsp;getFlags()</pre>
<div class="block">Get a list of registered AbstractFlag objects</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>List (AbstractFlag)</dd>
</dl>
</li>
</ul>
<a name="getFlags(org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags</h4>
<pre>public static&nbsp;java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;&nbsp;getFlags(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get a list of registerd AbstragFlag objects based on player permissions
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> - with permissions</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>List (AbstractFlag)</dd>
</dl>
</li>
</ul>
<a name="getFlag(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlag</h4>
<pre>public static&nbsp;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;getFlag(java.lang.String&nbsp;string)</pre>
<div class="block">Get an AbstractFlag by a string Returns null if flag does not exist</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>string</code> - Flag Key</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>AbstractFlag</dd>
</dl>
</li>
</ul>
<a name="getFlag(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlag</h4>
<pre>public static&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;getFlag(java.lang.String&nbsp;string,
boolean&nbsp;create)</pre>
<div class="block">Get an AbstractFlag by a string</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>string</code> - Flag Key</dd>
<dd><code>create</code> - If to create the flag if it does not exist</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>AbstractFlag</dd>
</dl>
</li>
</ul>
<a name="removeFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFlag</h4>
<pre>public static&nbsp;boolean&nbsp;removeFlag(<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</pre>
<div class="block">Remove a registered AbstractFlag</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>flag</code> - Flag Key</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>boolean Result of operation</dd>
</dl>
</li>
</ul>
<a name="parseFlags(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseFlags</h4>
<pre>public static&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag">Flag</a>[]&nbsp;parseFlags(java.util.List&lt;java.lang.String&gt;&nbsp;flagstrings)</pre>
</li>
</ul>
<a name="getPlotFlags(com.intellectualcrafters.plot.object.Plot)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPlotFlags</h4>
<pre>public static&nbsp;java.util.List&lt;<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&gt;&nbsp;getPlotFlags(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;plot)</pre>
<div class="block">Get the flags for a plot</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>plot</code> - Plot to search in</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>List (AbstractFlag)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-files/index-1.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/intellectualcrafters/plot/flag/Flag.html"
title="class in com.intellectualcrafters.plot.flag"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/flag/FlagManager.html"
target="_top">Frames</a></li>
<li><a href="FlagManager.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</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>