Some additional cleanup

Author: TheBusyBiscuit

CHANGELOG.md

@@ -72,6 +72,7 @@ This RC brings a lot of breaking changes to the API. For more info on why we did
 * Fixed #3225
 * Fixed #3206
 * Fixed androids not respecting Worldborders
+* Fixed Ender Lumps showing an incorrect recipe in the guide
 
 ## Release Candidate 26 (20 Jul 2021)
 https://thebusybiscuit.github.io/builds/TheBusyBiscuit/Slimefun4/stable/#26

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/ItemGroup.java

@@ -27,7 +27,8 @@
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 
 /**
- * Represents a category, which structure multiple {@link SlimefunItem} in the {@link SlimefunGuide}.
+ * Represents an item group, which structure
+ * multiple {@link SlimefunItem} in the {@link SlimefunGuide}.
  * 
  * @author TheBusyBiscuit
  *
@@ -74,8 +75,8 @@ public ItemGroup(NamespacedKey key, ItemStack item) {
      */
     @ParametersAreNonnullByDefault
     public ItemGroup(NamespacedKey key, ItemStack item, int tier) {
-        Validate.notNull(key, "A Category's NamespacedKey must not be null!");
-        Validate.notNull(item, "A Category's ItemStack must not be null!");
+        Validate.notNull(key, "An item group's NamespacedKey must not be null!");
+        Validate.notNull(item, "An item group's ItemStack must not be null!");
 
         this.item = item;
         this.key = key;
@@ -95,9 +96,10 @@ public final NamespacedKey getKey() {
     }
 
     /**
-     * Registers this category.
+     * Registers this {@link ItemGroup}.
      * <p>
-     * By default, a category is automatically registered when a {@link SlimefunItem} was added to it.
+     * By default, an {@link ItemGroup} is automatically registered when
+     * a {@link SlimefunItem} was added to it.
      * 
      * @param addon
      *            The {@link SlimefunAddon} that wants to register this {@link ItemGroup}
@@ -106,7 +108,7 @@ public void register(@Nonnull SlimefunAddon addon) {
         Validate.notNull(addon, "The Addon cannot be null");
 
         if (isRegistered()) {
-            throw new UnsupportedOperationException("This Category has already been registered!");
+            throw new UnsupportedOperationException("This ItemGroup has already been registered!");
         }
 
         this.addon = addon;
@@ -135,7 +137,7 @@ public int getTier() {
     public void setTier(int tier) {
         this.tier = tier;
 
-        // Refresh Category order if already registered.
+        // Refresh ItemGroup order if already registered.
         if (isRegistered()) {
             sortCategoriesByTier();
         }
@@ -167,7 +169,7 @@ public final SlimefunAddon getAddon() {
      *            the {@link SlimefunItem} that should be added to this {@link ItemGroup}
      */
     public void add(@Nonnull SlimefunItem item) {
-        Validate.notNull(item, "Cannot add null Items to a Category!");
+        Validate.notNull(item, "Cannot add null Items to an ItemGroup!");
 
         if (items.contains(item)) {
             // Ignore duplicate entries
@@ -184,7 +186,7 @@ public void add(@Nonnull SlimefunItem item) {
      *            the {@link SlimefunItem} that should be removed from this {@link ItemGroup}
      */
     public void remove(@Nonnull SlimefunItem item) {
-        Validate.notNull(item, "Cannot remove null from a Category!");
+        Validate.notNull(item, "Cannot remove null from an ItemGroup!");
         items.remove(item);
     }
 
@@ -250,7 +252,7 @@ public String getDisplayName(@Nonnull Player p) {
     /**
      * Returns all instances of {@link SlimefunItem} bound to this {@link ItemGroup}.
      * 
-     * @return the list of SlimefunItems bound to this category
+     * @return the list of SlimefunItems bound to this {@link ItemGroup}
      */
     @Nonnull
     public List<SlimefunItem> getItems() {

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/LockedItemGroup.java

@@ -21,7 +21,7 @@
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 
 /**
- * Represents a {@link ItemGroup} that cannot be opened until the parent category/categories
+ * Represents a {@link ItemGroup} that cannot be opened until the parent group(s)
  * are fully unlocked.
  * <p>
  * See {@link ItemGroup} for the complete documentation.
@@ -38,15 +38,15 @@ public class LockedItemGroup extends ItemGroup {
     private final Set<ItemGroup> parents = new HashSet<>();
 
     /**
-     * The basic constructor for a LockedCategory.
+     * The basic constructor for a LockedItemGroup.
      * Like {@link ItemGroup}, the default tier is automatically set to 3.
      * 
      * @param key
-     *            A unique identifier for this category
+     *            A unique identifier for this group
      * @param item
-     *            The display item for this category
+     *            The display item for this group
      * @param parents
-     *            The parent categories for this category
+     *            The parent categories for this group
      * 
      */
     @ParametersAreNonnullByDefault
@@ -55,22 +55,22 @@ public LockedItemGroup(NamespacedKey key, ItemStack item, NamespacedKey... paren
     }
 
     /**
-     * The constructor for a LockedCategory.
+     * The constructor for a LockedItemGroup.
      * 
      * @param key
-     *            A unique identifier for this category
+     *            A unique identifier for this group
      * @param item
-     *            The display item for this category
+     *            The display item for this group
      * @param tier
-     *            The tier of this category
+     *            The tier of this group
      * @param parents
-     *            The parent categories for this category
+     *            The parent categories for this group
      * 
      */
     @ParametersAreNonnullByDefault
     public LockedItemGroup(NamespacedKey key, ItemStack item, int tier, NamespacedKey... parents) {
         super(key, item, tier);
-        Validate.noNullElements(parents, "A LockedCategory must not have any 'null' parents!");
+        Validate.noNullElements(parents, "A LockedItemGroup must not have any 'null' parents!");
 
         this.keys = parents;
     }
@@ -94,51 +94,50 @@ public void register(@Nonnull SlimefunAddon addon) {
         }
 
         for (NamespacedKey key : namespacedKeys) {
-            Slimefun.logger().log(Level.INFO, "Parent \"{0}\" for Category \"{1}\" was not found, probably just disabled.", new Object[] { key, getKey() });
+            Slimefun.logger().log(Level.INFO, "Parent \"{0}\" for LockedItemGroup \"{1}\" was not found, probably just disabled.", new Object[] { key, getKey() });
         }
     }
 
     /**
-     * Gets the list of parent categories for this {@link LockedItemGroup}.
+     * Gets the list of parent item groups for this {@link LockedItemGroup}.
      * 
-     * @return the list of parent categories
+     * @return the list of parent item groups
      * 
      * @see #addParent(ItemGroup)
      * @see #removeParent(ItemGroup)
      */
-    @Nonnull
-    public Set<ItemGroup> getParents() {
+    public @Nonnull Set<ItemGroup> getParents() {
         return parents;
     }
 
     /**
      * Adds a parent {@link ItemGroup} to this {@link LockedItemGroup}.
      * 
-     * @param category
+     * @param group
      *            The {@link ItemGroup} to add as a parent
      *
      * @see #getParents()
      * @see #removeParent(ItemGroup)
      */
-    public void addParent(ItemGroup category) {
-        if (category == this || category == null) {
-            throw new IllegalArgumentException("Category '" + item.getItemMeta().getDisplayName() + "' cannot be a parent of itself or have a 'null' parent.");
+    public void addParent(ItemGroup group) {
+        if (group == this || group == null) {
+            throw new IllegalArgumentException("ItemGroup '" + item.getItemMeta().getDisplayName() + "' cannot be a parent of itself or have a 'null' parent.");
         }
 
-        parents.add(category);
+        parents.add(group);
     }
 
     /**
      * Removes a {@link ItemGroup} from the parents of this {@link LockedItemGroup}.
      * 
-     * @param category
+     * @param group
      *            The {@link ItemGroup} to remove from the parents of this {@link LockedItemGroup}
      * 
      * @see #getParents()
      * @see #addParent(ItemGroup)
      */
-    public void removeParent(@Nonnull ItemGroup category) {
-        parents.remove(category);
+    public void removeParent(@Nonnull ItemGroup group) {
+        parents.remove(group);
     }
 
     /**
@@ -155,8 +154,8 @@ public boolean hasUnlocked(@Nonnull Player p, @Nonnull PlayerProfile profile) {
         Validate.notNull(p, "The player cannot be null!");
         Validate.notNull(profile, "The Profile cannot be null!");
 
-        for (ItemGroup category : parents) {
-            for (SlimefunItem item : category.getItems()) {
+        for (ItemGroup parent : parents) {
+            for (SlimefunItem item : parent.getItems()) {
                 // Check if the Player has researched every item (if the item is enabled)
                 if (!item.isDisabledIn(p.getWorld()) && item.hasResearch() && !profile.hasUnlocked(item.getResearch())) {
                     return false;

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/NestedItemGroup.java

@@ -41,25 +41,25 @@ public NestedItemGroup(NamespacedKey key, ItemStack item, int tier) {
     /**
      * This will add the given {@link SubItemGroup} to this {@link NestedItemGroup}.
      * 
-     * @param category
+     * @param group
      *            The {@link SubItemGroup} to add.
      */
-    public void addSubGroup(@Nonnull SubItemGroup category) {
-        Validate.notNull(category, "The sub item group cannot be null!");
+    public void addSubGroup(@Nonnull SubItemGroup group) {
+        Validate.notNull(group, "The sub item group cannot be null!");
 
-        subGroups.add(category);
+        subGroups.add(group);
     }
 
     /**
      * This will remove the given {@link SubItemGroup} from this {@link NestedItemGroup} (if present).
      * 
-     * @param category
+     * @param group
      *            The {@link SubItemGroup} to remove.
      */
-    public void removeSubGroup(@Nonnull SubItemGroup category) {
-        Validate.notNull(category, "The sub item group cannot be null!");
+    public void removeSubGroup(@Nonnull SubItemGroup group) {
+        Validate.notNull(group, "The sub item group cannot be null!");
 
-        subGroups.remove(category);
+        subGroups.remove(group);
     }
 
     @Override

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/SeasonalItemGroup.java

@@ -32,11 +32,11 @@ public class SeasonalItemGroup extends ItemGroup {
      * @param key
      *            The {@link NamespacedKey} that is used to identify this {@link ItemGroup}
      * @param month
-     *            The month when the category should be displayed (from 1 = January ; to 12 = December)
+     *            The month when the {@link ItemGroup} should be displayed (from 1 = January ; to 12 = December)
      * @param tier
-     *            The tier of this category
+     *            The tier of this {@link ItemGroup}
      * @param item
-     *            The display item for this category
+     *            The display item for this {@link ItemGroup}
      */
     @ParametersAreNonnullByDefault
     public SeasonalItemGroup(NamespacedKey key, Month month, int tier, ItemStack item) {
@@ -51,8 +51,7 @@ public SeasonalItemGroup(NamespacedKey key, Month month, int tier, ItemStack ite
      * 
      * @return the {@link Month} in which this {@link SeasonalItemGroup} appears
      */
-    @Nonnull
-    public Month getMonth() {
+    public @Nonnull Month getMonth() {
         return month;
     }
 

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/SubItemGroup.java

@@ -22,7 +22,7 @@
  */
 public class SubItemGroup extends ItemGroup {
 
-    private final NestedItemGroup multiCategory;
+    private final NestedItemGroup parentItemGroup;
 
     @ParametersAreNonnullByDefault
     public SubItemGroup(NamespacedKey key, NestedItemGroup parent, ItemStack item) {
@@ -33,9 +33,9 @@ public SubItemGroup(NamespacedKey key, NestedItemGroup parent, ItemStack item) {
     public SubItemGroup(NamespacedKey key, NestedItemGroup parent, ItemStack item, int tier) {
         super(key, item, tier);
 
-        Validate.notNull(parent, "The parent category cannot be null");
+        Validate.notNull(parent, "The parent group cannot be null");
 
-        multiCategory = parent;
+        parentItemGroup = parent;
         parent.addSubGroup(this);
     }
 
@@ -48,17 +48,16 @@ public final boolean isHidden(@Nonnull Player p) {
         return true;
     }
 
-    @Nonnull
-    public final NestedItemGroup getParent() {
-        return multiCategory;
+    public final @Nonnull NestedItemGroup getParent() {
+        return parentItemGroup;
     }
 
     @Override
     public final void register(@Nonnull SlimefunAddon addon) {
         super.register(addon);
 
-        if (!multiCategory.isRegistered()) {
-            multiCategory.register(addon);
+        if (!parentItemGroup.isRegistered()) {
+            parentItemGroup.register(addon);
         }
     }
 

src/main/java/io/github/thebusybiscuit/slimefun4/api/researches/Research.java

@@ -76,7 +76,7 @@ public Research(@Nonnull NamespacedKey key, int id, @Nonnull String defaultName,
     }
 
     @Override
-    public NamespacedKey getKey() {
+    public @Nonnull NamespacedKey getKey() {
         return key;
     }
 
@@ -114,8 +114,7 @@ public int getID() {
      * 
      * @return The localized Name of this {@link Research}.
      */
-    @Nonnull
-    public String getName(@Nonnull Player p) {
+    public @Nonnull String getName(@Nonnull Player p) {
         String localized = Slimefun.getLocalization().getResearchName(p, key);
         return localized != null ? localized : name;
     }

src/main/java/io/github/thebusybiscuit/slimefun4/api/researches/package-info.java

@@ -2,4 +2,4 @@
  * This package holds everything connected to the {@link io.github.thebusybiscuit.slimefun4.core.researching.Research}
  * class.
  */
-package io.github.thebusybiscuit.slimefun4.core.researching;
+package io.github.thebusybiscuit.slimefun4.api.researches;