Saber-Factions/javadoc/com/massivecraft/factions/Factions.html

522 lines
21 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181) on Mon Sep 10 10:47:02 CDT 2018 -->
<title>Factions</title>
<meta name="date" content="2018-09-10">
<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="Factions";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":9,"i9":38,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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-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/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/massivecraft/factions/FLocation.html" title="class in com.massivecraft.factions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/massivecraft/factions/Factions.html" target="_top">Frames</a></li>
<li><a href="Factions.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><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><a href="#field.detail">Field</a>&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.massivecraft.factions</div>
<h2 title="Class Factions" class="title">Class Factions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.Factions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/massivecraft/factions/zcore/persist/MemoryFactions.html" title="class in com.massivecraft.factions.zcore.persist">MemoryFactions</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Factions</span>
extends java.lang.Object</pre>
</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 static <a href="../../../com/massivecraft/factions/Factions.html" title="class in com.massivecraft.factions">Factions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#instance">instance</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#Factions--">Factions</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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 <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#createFaction--">createFaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#forceSave--">forceSave</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#forceSave-boolean-">forceSave</a></span>(boolean&nbsp;sync)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.util.ArrayList&lt;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getAllFactions--">getAllFactions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getBestTagMatch-java.lang.String-">getBestTagMatch</a></span>(java.lang.String&nbsp;start)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getByTag-java.lang.String-">getByTag</a></span>(java.lang.String&nbsp;str)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getFactionById-java.lang.String-">getFactionById</a></span>(java.lang.String&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getFactionTags--">getFactionTags</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../com/massivecraft/factions/Factions.html" title="class in com.massivecraft.factions">Factions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getNone--">getNone</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getSafeZone--">getSafeZone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getWarZone--">getWarZone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#getWilderness--">getWilderness</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#isTagTaken-java.lang.String-">isTagTaken</a></span>(java.lang.String&nbsp;str)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#isValidFactionId-java.lang.String-">isValidFactionId</a></span>(java.lang.String&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#load--">load</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/Factions.html#removeFaction-java.lang.String-">removeFaction</a></span>(java.lang.String&nbsp;id)</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="instance">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>instance</h4>
<pre>protected static&nbsp;<a href="../../../com/massivecraft/factions/Factions.html" title="class in com.massivecraft.factions">Factions</a> instance</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Factions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Factions</h4>
<pre>public&nbsp;Factions()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../com/massivecraft/factions/Factions.html" title="class in com.massivecraft.factions">Factions</a>&nbsp;getInstance()</pre>
</li>
</ul>
<a name="getFactionById-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionById</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getFactionById(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a name="getByTag-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByTag</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getByTag(java.lang.String&nbsp;str)</pre>
</li>
</ul>
<a name="getBestTagMatch-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBestTagMatch</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getBestTagMatch(java.lang.String&nbsp;start)</pre>
</li>
</ul>
<a name="isTagTaken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTagTaken</h4>
<pre>public abstract&nbsp;boolean&nbsp;isTagTaken(java.lang.String&nbsp;str)</pre>
</li>
</ul>
<a name="isValidFactionId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidFactionId</h4>
<pre>public abstract&nbsp;boolean&nbsp;isValidFactionId(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a name="createFaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFaction</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;createFaction()</pre>
</li>
</ul>
<a name="removeFaction-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFaction</h4>
<pre>public abstract&nbsp;void&nbsp;removeFaction(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a name="getFactionTags--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionTags</h4>
<pre>public abstract&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getFactionTags()</pre>
</li>
</ul>
<a name="getAllFactions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllFactions</h4>
<pre>public abstract&nbsp;java.util.ArrayList&lt;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&gt;&nbsp;getAllFactions()</pre>
</li>
</ul>
<a name="getNone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNone</h4>
<pre>@Deprecated
public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getNone()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="getWilderness--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWilderness</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getWilderness()</pre>
</li>
</ul>
<a name="getSafeZone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSafeZone</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getSafeZone()</pre>
</li>
</ul>
<a name="getWarZone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarZone</h4>
<pre>public abstract&nbsp;<a href="../../../com/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getWarZone()</pre>
</li>
</ul>
<a name="forceSave--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceSave</h4>
<pre>public abstract&nbsp;void&nbsp;forceSave()</pre>
</li>
</ul>
<a name="forceSave-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceSave</h4>
<pre>public abstract&nbsp;void&nbsp;forceSave(boolean&nbsp;sync)</pre>
</li>
</ul>
<a name="load--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>load</h4>
<pre>public abstract&nbsp;void&nbsp;load()</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="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/massivecraft/factions/Faction.html" title="interface in com.massivecraft.factions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/massivecraft/factions/FLocation.html" title="class in com.massivecraft.factions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/massivecraft/factions/Factions.html" target="_top">Frames</a></li>
<li><a href="Factions.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><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><a href="#field.detail">Field</a>&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>