Upstream/ShopChest
1
0
Fork 0
mirror of https://github.com/EpicEricEE/ShopChest.git synced 2024-11-08 11:50:14 +01:00
Code Issues Projects Releases Wiki Activity

Small update to API documentation

Browse Source
This commit is contained in:
Eric 2019-08-13 23:22:35 +02:00
parent ef6ef3dc1c
commit 04b47e2bb0
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/src/main/java/de/epiceric/shopchest/api/shop/Shop.java
View File

@ -6,6 +6,7 @@ import org.bukkit.World;
import org.bukkit.inventory.Inventory; import org.bukkit.inventory.Inventory;
import de.epiceric.shopchest.api.ShopManager; import de.epiceric.shopchest.api.ShopManager;
import de.epiceric.shopchest.api.exceptions.ChestNotFoundException;
/** /**
* Represents a shop * Represents a shop
@ -33,7 +34,7 @@ public interface Shop {
OfflinePlayer getVendor(); OfflinePlayer getVendor();
/** /**
* Gets the product this shop is buying or selling * Gets a copy of the product this shop is buying or selling
* *
* @return the product * @return the product
* @since 1.13 * @since 1.13
@ -72,9 +73,10 @@ public interface Shop {
* Gets the inventory of this shop's chest * Gets the inventory of this shop's chest
* *
* @return the inventory * @return the inventory
* @throws ChestNotFoundException when there is no chest at the shop's location
* @since 1.13 * @since 1.13
*/ */
Inventory getInventory(); Inventory getInventory() throws ChestNotFoundException;
/** /**
* Gets whether this shop is an admin shop * Gets whether this shop is an admin shop

6
api/src/main/java/de/epiceric/shopchest/api/shop/ShopProduct.java
View File

@ -10,7 +10,7 @@ import org.bukkit.inventory.ItemStack;
public interface ShopProduct { public interface ShopProduct {
/** /**
* Gets the {@link ItemStack} with an amount of one * Gets a copy of this product's {@link ItemStack} with an amount of one
* *
* @return the item * @return the item
* @since 1.13 * @since 1.13
@ -18,9 +18,9 @@ public interface ShopProduct {
ItemStack getItemStack(); ItemStack getItemStack();
/** /**
* Sets the {@link ItemStack} * Sets this product's {@link ItemStack}
* <p> * <p>
* The passed item stack will be cloned and its amount set to one. * The passed item stack will be copied and its amount set to one.
* *
* @param itemStack the item * @param itemStack the item
* @since 1.13 * @since 1.13