javadoc

Author: Ghost-chu

src/main/java/org/maxgamer/quickshop/api/QuickShopAPI.java

@@ -10,30 +10,78 @@
 
 import java.util.Map;
 
+/**
+ * The unique entry point to allow you to access most features of QuickShop
+ */
 public interface QuickShopAPI {
-
+    /**
+     * Getting Compatibility Manager (usually used for anti-chest)
+     * @return Compatibility Manager
+     */
     CompatibilityManager getCompatibilityManager();
 
+    /**
+     * Getting Shop Manager which managing most of shops
+     * @return Shop manager
+     */
     ShopManager getShopManager();
 
+    /**
+     * Getting QuickShop current stacking item support status
+     * @return Stacking Item support enabled
+     */
     boolean isAllowStack();
 
+    /**
+     * Getting QuickShop current display item support status
+     * @return Display item enabled
+     */
     boolean isDisplayEnabled();
-
+    /**
+     * Getting QuickShop current permission based shop amount limit status
+     * @return Limit enabled
+     */
     boolean isLimit();
+    /**
+     * Getting QuickShop current permission based shop amount limits
+     * @return Permissions 2 Shop Amounts mapping
+     */
+    Map<String, Integer> getLimits();
 
+    /**
+     * Getting the helper to directly access the database
+     * @return The database helper
+     */
     DatabaseHelper getDatabaseHelper();
 
+    /**
+     * Getting text manager that allow addon to create a user language locale based message
+     * @return The text maanger
+     */
     TextManager getTextManager();
 
+    /**
+     * Getting current using ItemMatcher impl
+     * @return The item matcher
+     */
     ItemMatcher getItemMatcher();
 
+    /**
+     * Getting the status that fee requires if user performing price change
+     * @return requires fee
+     */
     boolean isPriceChangeRequiresFee();
 
+    /**
+     * Getting command manager that allow addon direct access QuickShop sub-command system
+     * @return The command manager
+     */
     CommandManager getCommandManager();
 
-    Map<String, Integer> getLimits();
-
+    /**
+     * Getting this server game version
+     * @return Game version
+     */
     GameVersion getGameVersion();
 
 }

src/main/java/org/maxgamer/quickshop/api/chat/QuickChat.java

@@ -27,7 +27,7 @@
 import org.maxgamer.quickshop.api.shop.Shop;
 
 /**
- * QuickChat is a system to allow us to processing plain text and also MineDown
+ * QuickChat is a system to allow us to process complex messages
  */
 public interface QuickChat {
     /**

src/main/java/org/maxgamer/quickshop/api/command/CommandHandler.java

@@ -26,6 +26,10 @@
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * The command handler that processing sub commands under QS main command
+ * @param <T> The subtype of CommandSender you want received
+ */
 public interface CommandHandler<T extends CommandSender> {
     /**
      * Calling while command executed by specified sender

src/main/java/org/maxgamer/quickshop/api/command/CommandManager.java

@@ -7,6 +7,10 @@
 
 import java.util.List;
 
+/**
+ * The manager that managing all sub-commands that registered
+ * Also performing permission checks in there.
+ */
 public interface CommandManager {
     /**
      * This is a interface to allow addons to register the subcommand into quickshop command manager.

src/main/java/org/maxgamer/quickshop/api/compatibility/CompatibilityManager.java

@@ -3,9 +3,16 @@
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * Manager that managing all registered compatibility for anti-cheat modules
+ */
 public interface CompatibilityManager {
-
-    boolean isRegistered(String pluginName);
+    /**
+     * Check a module registered
+     * @param moduleName Module name
+     * @return Is registered
+     */
+    boolean isRegistered(String moduleName);
 
     /**
      * Switch the compatibility mode on or off, set false to disable all we known incompatiable plugin
@@ -16,15 +23,24 @@ public interface CompatibilityManager {
      */
     void toggleProtectionListeners(boolean status, @NotNull Player player);
 
+    /**
+     * Unregister all registered compatibility modules
+     */
     void unregisterAll();
 
+    /**
+     * Register compatibility module
+     * @param module Compatibility module
+     */
     void register(@NotNull CompatibilityModule module);
-
-    void register(@NotNull String moduleName);
-
-    void register(@NotNull Class<? extends CompatibilityModule> compatibilityModuleClass);
-
+    /**
+     * Unregister a registered compatibility modules
+     * @param moduleName Compatibility module name
+     */
     void unregister(@NotNull String moduleName);
-
+    /**
+     * Unregister a registered compatibility modules
+     * @param module Compatibility module
+     */
     void unregister(@NotNull CompatibilityModule module);
 }

src/main/java/org/maxgamer/quickshop/api/database/DatabaseHelper.java

@@ -11,34 +11,120 @@
 import java.util.function.Consumer;
 
 public interface DatabaseHelper {
+    /**
+     * Creates a column with specific name and data type
+     * @param tableName The table name
+     * @param columnName The column name
+     * @param type The data type
+     * @return Create result
+     */
     boolean createColumn(@NotNull String tableName, @NotNull String columnName, @NotNull DataType type);
 
+    /**
+     * Cleanup transaction messages that saved in database
+     * @param weekAgo How many weeks ago messages should we clean up
+     */
     void cleanMessage(long weekAgo);
 
+    /**
+     * Purge and clean all saved transaction message in data that should send to specific player
+     * @param player The player
+     */
     void cleanMessageForPlayer(@NotNull UUID player);
 
+    /**
+     * Create a shop data record sand save into database
+     * @param shop The shop object
+     * @param onSuccess Success callback
+     * @param onFailed Fails callback
+     */
     void createShop(@NotNull Shop shop, @Nullable Runnable onSuccess, @Nullable Consumer<SQLException> onFailed);
 
+    /**
+     * Remove a shop data record from database
+     * @param shop The shop
+     */
     void removeShop(Shop shop);
 
+    /**
+     * Remove a shop data record from database
+     * @param world Shop world
+     * @param x Shop X
+     * @param y Shop Y
+     * @param z Shop Z
+     */
     void removeShop(String world, int x, int y, int z);
 
+    /**
+     * Select all messages that saved in the database
+     * @return Query result set
+     * @throws SQLException Any errors related to SQL Errors
+     */
     WarpedResultSet selectAllMessages() throws SQLException;
-
+    /**
+     * Select specific table content
+     * @return Query result set
+     * @throws SQLException Any errors related to SQL Errors
+     */
     WarpedResultSet selectTable(String table) throws SQLException;
-
+    /**
+     * Select all shops that saved in the database
+     * @return Query result set
+     * @throws SQLException Any errors related to SQL Errors
+     */
     WarpedResultSet selectAllShops() throws SQLException;
 
+    /**
+     * Create a transaction message record and save into database
+     * @param player Target player
+     * @param message The message content
+     * @param time System time
+     */
     void sendMessage(@NotNull UUID player, @NotNull String message, long time);
 
+    /**
+     * Upgrade legacy name based data record to uniqueId based record
+     * @param ownerUUID The owner unique id
+     * @param x Shop X
+     * @param y Shop Y
+     * @param z Shop Z
+     * @param worldName Shop World
+     */
     void updateOwner2UUID(@NotNull String ownerUUID, int x, int y, int z, @NotNull String worldName);
 
+    /**
+     * Update external cache data
+     * (Used for Web UI or other something like that)
+     * @param shop The shop
+     * @param space The shop remaining space
+     * @param stock The shop remaining stock
+     */
     void updateExternalInventoryProfileCache(@NotNull Shop shop, int space, int stock);
 
+    /**
+     * Update a shop data into the database
+     * @param owner Shop owner
+     * @param item Shop item
+     * @param unlimited Shop unlimited
+     * @param shopType Shop type
+     * @param price Shop price
+     * @param x Shop x
+     * @param y Shop y
+     * @param z Shop z
+     * @param world Shop world
+     * @param extra Shop extra data
+     * @param currency Shop currency
+     * @param disableDisplay Shop display disabled status
+     * @param taxAccount Shop specific tax account
+     */
     void updateShop(@NotNull String owner, @NotNull ItemStack item, int unlimited, int shopType,
                     double price, int x, int y, int z, @NotNull String world, @NotNull String extra,
                     @NotNull String currency, boolean disableDisplay, @Nullable String taxAccount);
 
+    /**
+     * Insert a history record into logs table
+     * @param record Record object that can be serialized by Gson.
+     */
     void insertHistoryRecord(Object record);
 
 }

src/main/java/org/maxgamer/quickshop/api/economy/AbstractEconomy.java

@@ -31,25 +31,35 @@
 
 import java.util.UUID;
 
+/**
+ * Abstract Economy Core
+ */
 public abstract class AbstractEconomy implements EconomyCore, Reloadable {
 
-    private final QuickShop plugin;
-
-    public AbstractEconomy(@NotNull QuickShop plugin) {
-        this.plugin = plugin;
-
+    public AbstractEconomy() {
     }
 
+    /**
+     * Getting QuickShop now using type of Economy
+     * @return Economy type that QuickShop now using
+     */
     public static EconomyType getNowUsing() {
         return EconomyType.fromID(QuickShop.getInstance().getConfig().getInt("economy-type"));
     }
 
     @Override
     public abstract String toString();
-    //    return core.getClass().getName().split("_")[1];
-    //}
-
 
+    /**
+     * Transfer specific amount of currency from A to B
+     * (Developer: This is low layer of Economy System, use EconomyTransaction if possible)
+     * @param from     The player who is paying money
+     * @param to       The player who is receiving money
+     * @param amount   The amount to transfer
+     * @param world    The transaction world
+     * @param currency The currency name
+     * @return successed
+     */
     @Override
     public boolean transfer(@NotNull UUID from, @NotNull UUID to, double amount, @NotNull World world, @Nullable String currency) {
         if (!isValid()) {
@@ -129,9 +139,7 @@ public boolean transfer(@NotNull UUID from, @NotNull UUID to, double amount, @No
     }
 
     @Override
-    public @NotNull Plugin getPlugin() {
-        return plugin;
-    }
+    public abstract @NotNull Plugin getPlugin();
 
     /**
      * Callback for reloading

src/main/java/org/maxgamer/quickshop/api/integration/IntegrationManager.java

@@ -6,10 +6,21 @@
 import java.util.Map;
 
 public interface IntegrationManager {
+    /**
+     * Getting read-only mapping for all registered modules
+     * @return All registered modules
+     */
     Map<String, IntegratedPlugin> getIntegrationMap();
 
+    /**
+     * Getting all registered Integration modules
+     * @return All registered Integration
+     */
     List<IntegratedPlugin> getIntegrations();
 
+    /**
+     * Re-execute a search task to register available modules if possible
+     */
     void searchAndRegisterPlugins();
 
     /**
@@ -33,6 +44,11 @@ public interface IntegrationManager {
      */
     void register(@NotNull String integratedPluginName);
 
+    /**
+     * Check if a class is Integration module
+     * @param clazz The class
+     * @return Is Integration module
+     */
     @SuppressWarnings("BooleanMethodIsAlwaysInverted")
     static boolean isIntegrationClass(@NotNull Class<?> clazz) {
         return clazz.getDeclaredAnnotation(IntegrationStage.class) != null;
@@ -57,5 +73,10 @@ static boolean isIntegrationClass(@NotNull Class<?> clazz) {
      */
     void unregister(@NotNull IntegratedPlugin integratedPlugin);
 
+    /**
+     * Check if a integration has been registered
+     * @param integrationName The integration
+     * @return Registered
+     */
     boolean isRegistered(@NotNull String integrationName);
 }

src/main/java/org/maxgamer/quickshop/api/localization/text/TextManager.java

@@ -7,6 +7,9 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * The TextManager that allow create user's locale specified message.
+ */
 public interface TextManager {
     /**
      * Gets specific locale status