merge: version 4.3.0-SNAPSHOT [DEPLOY-SKIP] (#99)

.github/workflows/deployment.yml

@@ -8,10 +8,11 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    if: "! contains(github.event.head_commit.message, '[DEPLOY-SKIP]')"
     steps:
       - uses: actions/[email protected]
       - name: Set up JDK 16
-        uses: actions/setup-java@v2.3.1
+        uses: actions/setup-java@v2.5.0
         with:
           distribution: 'temurin'
           java-version: '16'

.github/workflows/gradle.yml

@@ -7,7 +7,7 @@ jobs:
     steps:
       - uses: actions/[email protected]
       - name: Set up JDK 16
-        uses: actions/setup-java@v2.3.1
+        uses: actions/setup-java@v2.5.0
         with:
           distribution: 'temurin'
           java-version: '16'
@@ -32,7 +32,7 @@ jobs:
           mv features/gui/build staging/features/gui
           mv features/notifier/build staging/features/notifier
           mv features/stick/build staging/features/stick
-      - uses: actions/upload-artifact@v2.2.4
+      - uses: actions/upload-artifact@v2.3.1
         with:
           name: Package
           path: staging

README.md

@@ -1,4 +1,4 @@
-# Box v4.2.1
+# Box v4.3.0-SNAPSHOT
 
 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/okocraft/Box)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/okocraft/Box/Maven%20Build)
@@ -85,19 +85,19 @@ For snapshot version, use https://okocraft.github.io/Box/maven-snapshot/
 <dependency>
     <groupId>net.okocraft.box</groupId>
     <artifactId>api</artifactId>
-    <version>4.2.1</version>
+    <version>4.3.0-SNAPSHOT</version>
     <scope>provided</scope>
 </dependency>
 ```
 
 ```gradle
 dependencies {
-    compileOnly 'net.okocraft.box:api:4.2.1'
+    compileOnly 'net.okocraft.box:api:4.3.0-SNAPSHOT'
 }
 ```
 
 ```kotlin
 dependencies {
-    compileOnly("net.okocraft.box:api:4.2.1")
+    compileOnly("net.okocraft.box:api:4.3.0-SNAPSHOT")
 }
 ```

api/src/main/java/net/okocraft/box/api/event/BoxEvent.java

@@ -1,9 +1,20 @@
 package net.okocraft.box.api.event;
 
 import com.github.siroshun09.event4j.event.Event;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * A superclass for all events fired by the Box.
  */
 public class BoxEvent extends Event {
+
+    /**
+     * Creates the debug log from this event.
+     *
+     * @return the debug log
+     */
+    public @NotNull String toDebugLog() {
+        return toString();
+    }
+
 }

api/src/main/java/net/okocraft/box/api/event/feature/FeatureEvent.java

@@ -43,6 +43,14 @@ public FeatureEvent(@NotNull BoxFeature feature, @NotNull Type type) {
         return type;
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "FeatureEvent{" +
+                "feature=" + feature.getName() +
+                ", type=" + type +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "FeatureEvent{" +

api/src/main/java/net/okocraft/box/api/event/general/AutoSaveStartEvent.java

@@ -1,9 +1,16 @@
 package net.okocraft.box.api.event.general;
 
 import net.okocraft.box.api.event.BoxEvent;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * An event called when the auto save task started.
  */
 public class AutoSaveStartEvent extends BoxEvent {
+
+    @Override
+    public @NotNull String toDebugLog() {
+        return getEventName();
+    }
+
 }

api/src/main/java/net/okocraft/box/api/event/item/ItemImportEvent.java

@@ -6,7 +6,7 @@
 import java.util.Objects;
 
 /**
- * A event called when the {@link BoxItem} is imported.
+ * An event called when the {@link BoxItem} is imported.
  * <p>
  * This event is for debugging only, and will only be called when the Box is starting.
  */

api/src/main/java/net/okocraft/box/api/event/player/PlayerLoadEvent.java

@@ -17,6 +17,14 @@ public PlayerLoadEvent(@NotNull BoxPlayer boxPlayer) {
         super(boxPlayer);
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "PlayerLoadEvent{" +
+                "uuid=" + getBoxPlayer().getUUID() +
+                ", name=" + getBoxPlayer().getName() +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "PlayerLoadEvent{" +

api/src/main/java/net/okocraft/box/api/event/player/PlayerStockHolderChangeEvent.java

@@ -18,7 +18,7 @@ public class PlayerStockHolderChangeEvent extends PlayerEvent implements AsyncEv
      * The constructor of a {@link PlayerStockHolderChangeEvent}.
      *
      * @param boxPlayer the player of this event
-     * @param previous the previous {@link StockHolder}
+     * @param previous  the previous {@link StockHolder}
      */
     public PlayerStockHolderChangeEvent(@NotNull BoxPlayer boxPlayer,
                                         @NotNull StockHolder previous) {
@@ -34,4 +34,26 @@ public PlayerStockHolderChangeEvent(@NotNull BoxPlayer boxPlayer,
     public @NotNull StockHolder getPreviousStockHolder() {
         return previous;
     }
+
+    @Override
+    public @NotNull String toDebugLog() {
+        return "PlayerStockHolderChangeEvent{" +
+                "uuid=" + getBoxPlayer().getUUID() +
+                ", name=" + getBoxPlayer().getName() +
+                ", previousStockholderUuid=" + previous.getUUID() +
+                ", previousStockHolderName=" + previous.getName() +
+                ", previousStockHolderClass=" + previous.getClass().getSimpleName() +
+                ", currentStockholderUuid=" + getBoxPlayer().getCurrentStockHolder().getUUID() +
+                ", currentStockHolderName=" + getBoxPlayer().getCurrentStockHolder().getName() +
+                ", currentStockHolderClass=" + getBoxPlayer().getCurrentStockHolder().getClass().getSimpleName() +
+                '}';
+    }
+
+    @Override
+    public String toString() {
+        return "PlayerStockHolderChangeEvent{" +
+                "boxPlayer=" + getBoxPlayer() +
+                ", previous=" + previous +
+                '}';
+    }
 }

api/src/main/java/net/okocraft/box/api/event/player/PlayerUnloadEvent.java

@@ -17,6 +17,14 @@ public PlayerUnloadEvent(@NotNull BoxPlayer boxPlayer) {
         super(boxPlayer);
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "PlayerUnloadEvent{" +
+                "uuid=" + getBoxPlayer().getUUID() +
+                ", name=" + getBoxPlayer().getName() +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "PlayerUnloadEvent{" +

api/src/main/java/net/okocraft/box/api/event/stock/StockDecreaseEvent.java

@@ -58,6 +58,18 @@ public int getAmount() {
         return amount;
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "StockDecreaseEvent{" +
+                "stockholderUuid=" + getStockHolder().getUUID() +
+                ", stockHolderName=" + getStockHolder().getName() +
+                ", stockHolderClass=" + getStockHolder().getClass().getSimpleName() +
+                ", item=" + item +
+                ", decrements=" + decrements +
+                ", amount=" + amount +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "StockDecreaseEvent{" +

api/src/main/java/net/okocraft/box/api/event/stock/StockIncreaseEvent.java

@@ -58,6 +58,18 @@ public int getAmount() {
         return amount;
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "StockIncreaseEvent{" +
+                "stockholderUuid=" + getStockHolder().getUUID() +
+                ", stockHolderName=" + getStockHolder().getName() +
+                ", stockHolderClass=" + getStockHolder().getClass().getSimpleName() +
+                ", item=" + item +
+                ", increments=" + increments +
+                ", amount=" + amount +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "StockIncreaseEvent{" +

api/src/main/java/net/okocraft/box/api/event/stock/StockSetEvent.java

@@ -55,11 +55,24 @@ public int getPreviousAmount() {
         return previousAmount;
     }
 
+    @Override
+    public @NotNull String toDebugLog() {
+        return "StockSetEvent{" +
+                "stockholderUuid=" + getStockHolder().getUUID() +
+                ", stockHolderName=" + getStockHolder().getName() +
+                ", stockHolderClass=" + getStockHolder().getClass().getSimpleName() +
+                ", item=" + item +
+                ", previousAmount=" + previousAmount +
+                ", amount=" + amount +
+                '}';
+    }
+
     @Override
     public String toString() {
         return "StockSetEvent{" +
                 "stockholder=" + getStockHolder() +
                 ", item=" + item +
+                ", previousAmount=" + previousAmount +
                 ", amount=" + amount +
                 '}';
     }

api/src/main/java/net/okocraft/box/api/event/stockholder/StockHolderEvent.java

@@ -58,4 +58,13 @@ public boolean isUserStockHolder() {
             throw new IllegalStateException("The StockHolder of this event is not UserStockHolder.");
         }
     }
+
+    @Override
+    public @NotNull String toDebugLog() {
+        return getEventName() + "{" +
+                "uuid=" + getStockHolder().getUUID() +
+                ", name=" + getStockHolder().getName() +
+                ", class=" + getStockHolder().getClass().getSimpleName() +
+                "}";
+    }
 }

api/src/main/java/net/okocraft/box/api/feature/BoxFeature.java

@@ -2,6 +2,10 @@
 
 import com.github.siroshun09.event4j.handlerlist.Key;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.util.Collections;
+import java.util.Set;
 
 /**
  * An interface that adds a box feature.
@@ -33,4 +37,13 @@ public interface BoxFeature {
      * This method will be called even if an exception is thrown while executing {@link #enable()}.
      */
     void disable();
+
+    /**
+     * Gets classes of the dependent {@link BoxFeature}.
+     *
+     * @return classes of the dependent {@link BoxFeature}
+     */
+   default @NotNull @Unmodifiable Set<Class<? extends BoxFeature>> getDependencies() {
+       return Collections.emptySet();
+   }
 }

api/src/main/java/net/okocraft/box/api/feature/Disableable.java

@@ -0,0 +1,7 @@
+package net.okocraft.box.api.feature;
+
+/**
+ * An interface to indicate that the {@link BoxFeature} can be disabled in config.yml.
+ */
+public interface Disableable {
+}