amalthea-mc/ShopChest
1
0
Fork 0
mirror of https://github.com/amalthea-mc/ShopChest.git synced 2024-11-14 14:41:08 +00:00
Code Issues Projects Releases Wiki Activity
8aafd24f21
ShopChest/javadoc/de/epiceric/shopchest/utils/ShopUtils.html
Eric 8aafd24f21 Updated Javadoc
2016-08-16 20:28:43 +02:00

437 lines
18 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="de">
<head>
<!-- Generated by javadoc (1.8.0_74) on Tue Aug 16 20:25:46 CEST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ShopUtils (ShopChest 1.10.0 API)</title>
<meta name="date" content="2016-08-16">
<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="ShopUtils (ShopChest 1.10.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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="class-use/ShopUtils.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="../../../../de/epiceric/shopchest/utils/Metrics.Plotter.html" title="class in de.epiceric.shopchest.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../de/epiceric/shopchest/utils/UpdateChecker.html" title="class in de.epiceric.shopchest.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/epiceric/shopchest/utils/ShopUtils.html" target="_top">Frames</a></li>
<li><a href="ShopUtils.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">de.epiceric.shopchest.utils</div>
<h2 title="Class ShopUtils" class="title">Class ShopUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>de.epiceric.shopchest.utils.ShopUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ShopUtils</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</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">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#ShopUtils-de.epiceric.shopchest.ShopChest-">ShopUtils</a></span>(<a href="../../../../de/epiceric/shopchest/ShopChest.html" title="class in de.epiceric.shopchest">ShopChest</a>&nbsp;plugin)</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="../../../../de/epiceric/shopchest/utils/ShopUtils.html#addShop-de.epiceric.shopchest.shop.Shop-boolean-">addShop</a></span>(<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>&nbsp;shop,
boolean&nbsp;addToDatabase)</code>
<div class="block">Add a shop</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#getShop-org.bukkit.Location-">getShop</a></span>(org.bukkit.Location&nbsp;location)</code>
<div class="block">Get the shop at a given location</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#getShopAmount-org.bukkit.OfflinePlayer-">getShopAmount</a></span>(org.bukkit.OfflinePlayer&nbsp;p)</code>
<div class="block">Get the amount of shops of a player</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#getShopLimit-org.bukkit.entity.Player-">getShopLimit</a></span>(org.bukkit.entity.Player&nbsp;p)</code>
<div class="block">Get the shop limits of a player</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#getShops--">getShops</a></span>()</code>
<div class="block">Get all Shops</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#isShop-org.bukkit.Location-">isShop</a></span>(org.bukkit.Location&nbsp;location)</code>
<div class="block">Checks whether there is a shop at a given location</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#reloadShops-boolean-">reloadShops</a></span>(boolean&nbsp;reloadConfig)</code>
<div class="block">Reload the shops</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/utils/ShopUtils.html#removeShop-de.epiceric.shopchest.shop.Shop-boolean-">removeShop</a></span>(<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>&nbsp;shop,
boolean&nbsp;removeFromDatabase)</code>
<div class="block">Remove a shop</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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="ShopUtils-de.epiceric.shopchest.ShopChest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ShopUtils</h4>
<pre>public&nbsp;ShopUtils(<a href="../../../../de/epiceric/shopchest/ShopChest.html" title="class in de.epiceric.shopchest">ShopChest</a>&nbsp;plugin)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getShop-org.bukkit.Location-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShop</h4>
<pre>public&nbsp;<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>&nbsp;getShop(org.bukkit.Location&nbsp;location)</pre>
<div class="block">Get the shop at a given location</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>location</code> - Location of the shop</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Shop at the given location or <b>null</b> if no shop is found there</dd>
</dl>
</li>
</ul>
<a name="isShop-org.bukkit.Location-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShop</h4>
<pre>public&nbsp;boolean&nbsp;isShop(org.bukkit.Location&nbsp;location)</pre>
<div class="block">Checks whether there is a shop at a given location</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>location</code> - Location to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether there is a shop at the given location</dd>
</dl>
</li>
</ul>
<a name="getShops--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShops</h4>
<pre>public&nbsp;<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>[]&nbsp;getShops()</pre>
<div class="block">Get all Shops</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of all Shops</dd>
</dl>
</li>
</ul>
<a name="addShop-de.epiceric.shopchest.shop.Shop-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addShop</h4>
<pre>public&nbsp;void&nbsp;addShop(<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>&nbsp;shop,
boolean&nbsp;addToDatabase)</pre>
<div class="block">Add a shop</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shop</code> - Shop to add</dd>
<dd><code>addToDatabase</code> - Whether the shop should also be added to the database</dd>
</dl>
</li>
</ul>
<a name="removeShop-de.epiceric.shopchest.shop.Shop-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeShop</h4>
<pre>public&nbsp;void&nbsp;removeShop(<a href="../../../../de/epiceric/shopchest/shop/Shop.html" title="class in de.epiceric.shopchest.shop">Shop</a>&nbsp;shop,
boolean&nbsp;removeFromDatabase)</pre>
<div class="block">Remove a shop</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shop</code> - Shop to remove</dd>
<dd><code>removeFromDatabase</code> - Whether the shop should also be removed from the database</dd>
</dl>
</li>
</ul>
<a name="getShopLimit-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShopLimit</h4>
<pre>public&nbsp;int&nbsp;getShopLimit(org.bukkit.entity.Player&nbsp;p)</pre>
<div class="block">Get the shop limits of a player</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - Player, whose shop limits should be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The shop limits of the given player</dd>
</dl>
</li>
</ul>
<a name="getShopAmount-org.bukkit.OfflinePlayer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShopAmount</h4>
<pre>public&nbsp;int&nbsp;getShopAmount(org.bukkit.OfflinePlayer&nbsp;p)</pre>
<div class="block">Get the amount of shops of a player</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - Player, whose shops should be counted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The amount of a shops a player has (if <a href="../../../../de/epiceric/shopchest/config/Config.html#exclude_admin_shops"><code>Config.exclude_admin_shops</code></a> is true, admin shops won't be counted)</dd>
</dl>
</li>
</ul>
<a name="reloadShops-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reloadShops</h4>
<pre>public&nbsp;int&nbsp;reloadShops(boolean&nbsp;reloadConfig)</pre>
<div class="block">Reload the shops</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reloadConfig</code> - Whether the configuration should also be reloaded</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Amount of shops, which were reloaded</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="class-use/ShopUtils.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="../../../../de/epiceric/shopchest/utils/Metrics.Plotter.html" title="class in de.epiceric.shopchest.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../de/epiceric/shopchest/utils/UpdateChecker.html" title="class in de.epiceric.shopchest.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/epiceric/shopchest/utils/ShopUtils.html" target="_top">Frames</a></li>
<li><a href="ShopUtils.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink