Merge pull request #2956 from Slimefun/fix/2942

Fixes #2942

Author: TheBusyBiscuit

CHANGELOG.md

@@ -71,6 +71,7 @@
 * Fixed Grappling Hook vanishing in creative mode
 * Fixed #2944
 * Fixed #2837
+* Fixed #2942
 
 ## Release Candidate 21 (14 Mar 2021)
 https://thebusybiscuit.github.io/builds/TheBusyBiscuit/Slimefun4/stable/#21

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/LocalizationService.java

@@ -150,7 +150,7 @@ public Language getDefaultLanguage() {
 
     @Override
     public Language getLanguage(@Nonnull Player p) {
-        Validate.notNull("Player cannot be null!");
+        Validate.notNull(p, "Player cannot be null!");
 
         PersistentDataContainer container = p.getPersistentDataContainer();
         String language = container.get(languageKey, PersistentDataType.STRING);
@@ -253,7 +253,7 @@ private Set<String> getTotalKeys(@Nonnull Language lang) {
     }
 
     @Nonnull
-    private Set<String> getKeys(FileConfiguration... files) {
+    private Set<String> getKeys(@Nonnull FileConfiguration... files) {
         Set<String> keys = new HashSet<>();
 
         for (FileConfiguration cfg : files) {

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/localization/Language.java

@@ -160,8 +160,7 @@ public ItemStack getItem() {
      */
     @Nonnull
     public String getName(@Nonnull Player p) {
-        String name = SlimefunPlugin.getLocalization().getMessage(p, "languages." + id);
-        return name != null ? name : toString();
+        return SlimefunPlugin.getLocalization().getMessage(p, "languages." + id);
     }
 
     /**

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/localization/SlimefunLocalization.java

@@ -1,13 +1,15 @@
 package io.github.thebusybiscuit.slimefun4.core.services.localization;
 
-import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.function.UnaryOperator;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import javax.annotation.ParametersAreNonnullByDefault;
 
+import org.apache.commons.lang.Validate;
 import org.bukkit.ChatColor;
 import org.bukkit.Keyed;
 import org.bukkit.NamespacedKey;
@@ -33,9 +35,9 @@
 /**
  * This is an abstract parent class of {@link LocalizationService}.
  * There is not really much more I can say besides that...
- * 
+ *
  * @author TheBusyBiscuit
- * 
+ *
  * @see LocalizationService
  *
  */
@@ -48,55 +50,57 @@ protected SlimefunLocalization(@Nonnull SlimefunPlugin plugin) {
     /**
      * This method attempts to return the {@link Language} with the given
      * language code.
-     * 
+     *
      * @param id
      *            The language code
-     * 
+     *
      * @return A {@link Language} with the given id or null
      */
     @Nullable
     public abstract Language getLanguage(@Nonnull String id);
 
     /**
      * This method returns the currently selected {@link Language} of a {@link Player}.
-     * 
+     *
      * @param p
      *            The {@link Player} to query
-     * 
+     *
      * @return The {@link Language} that was selected by the given {@link Player}
      */
+    @Nullable
     public abstract Language getLanguage(@Nonnull Player p);
 
     /**
      * This method returns the default {@link Language} of this {@link Server}
-     * 
+     *
      * @return The default {@link Language}
      */
+    @Nullable
     public abstract Language getDefaultLanguage();
 
     /**
      * This returns whether a {@link Language} with the given id exists within
      * the project resources.
-     * 
+     *
      * @param id
      *            The {@link Language} id
-     * 
+     *
      * @return Whether the project contains a {@link Language} with that id
      */
     protected abstract boolean hasLanguage(@Nonnull String id);
 
     /**
      * This method returns a full {@link Collection} of every {@link Language} that was
      * found.
-     * 
+     *
      * @return A {@link Collection} that contains every installed {@link Language}
      */
     @Nonnull
     public abstract Collection<Language> getLanguages();
 
     /**
      * This method adds a new {@link Language} with the given id and texture.
-     * 
+     *
      * @param id
      *            The {@link Language} id
      * @param texture
@@ -117,7 +121,28 @@ protected void loadEmbeddedLanguages() {
         }
     }
 
-    public String getMessage(Player p, String key) {
+    @Nonnull
+    @Override
+    public String getMessage(@Nonnull String key) {
+        Validate.notNull(key, "Message key cannot be null!");
+
+        Language language = getDefaultLanguage();
+
+        String message = language == null ? null : language.getMessagesFile().getString(key);
+
+        if (message == null) {
+            Language fallback = getLanguage(SupportedLanguage.ENGLISH.getLanguageId());
+            return fallback.getMessagesFile().getString(key);
+        }
+
+        return message;
+    }
+
+    @Nonnull
+    public String getMessage(@Nonnull Player p, @Nonnull String key) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+
         Language language = getLanguage(p);
 
         if (language == null) {
@@ -134,11 +159,15 @@ public String getMessage(Player p, String key) {
         return message;
     }
 
-    public List<String> getMessages(Player p, String key) {
+    @Nonnull
+    public List<String> getMessages(@Nonnull Player p, @Nonnull String key) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+
         Language language = getLanguage(p);
 
         if (language == null) {
-            return Arrays.asList("NO LANGUAGE FOUND");
+            return Collections.singletonList("NO LANGUAGE FOUND");
         }
 
         List<String> messages = language.getMessagesFile().getStringList(key);
@@ -151,37 +180,55 @@ public List<String> getMessages(Player p, String key) {
         return messages;
     }
 
+    @Nonnull
+    @ParametersAreNonnullByDefault
     public List<String> getMessages(Player p, String key, UnaryOperator<String> function) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+        Validate.notNull(function, "Function cannot be null!");
+
         List<String> messages = getMessages(p, key);
         messages.replaceAll(function);
 
         return messages;
     }
 
-    public String getResearchName(Player p, NamespacedKey key) {
+    @Nullable
+    public String getResearchName(@Nonnull Player p, @Nonnull NamespacedKey key) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "NamespacedKey cannot be null!");
+
         Language language = getLanguage(p);
 
-        if (language.getResearchesFile() == null) {
+        if (language == null || language.getResearchesFile() == null) {
             return null;
         }
 
-        return language.getResearchesFile().getString(key.getNamespace() + "." + key.getKey());
+        return language.getResearchesFile().getString(key.getNamespace() + '.' + key.getKey());
     }
 
-    public String getCategoryName(Player p, NamespacedKey key) {
+    @Nullable
+    public String getCategoryName(@Nonnull Player p, @Nonnull NamespacedKey key) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "NamespacedKey cannot be null!");
+
         Language language = getLanguage(p);
 
-        if (language.getCategoriesFile() == null) {
+        if (language == null || language.getCategoriesFile() == null) {
             return null;
         }
 
-        return language.getCategoriesFile().getString(key.getNamespace() + "." + key.getKey());
+        return language.getCategoriesFile().getString(key.getNamespace() + '.' + key.getKey());
     }
 
-    public String getResourceString(Player p, String key) {
+    @Nonnull
+    public String getResourceString(@Nonnull Player p, @Nonnull String key) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+
         Language language = getLanguage(p);
 
-        String value = language.getResourcesFile() != null ? language.getResourcesFile().getString(key) : null;
+        String value = language != null && language.getResourcesFile() != null ? language.getResourcesFile().getString(key) : null;
 
         if (value != null) {
             return value;
@@ -191,16 +238,20 @@ public String getResourceString(Player p, String key) {
         }
     }
 
-    public ItemStack getRecipeTypeItem(Player p, RecipeType recipeType) {
+    @Nonnull
+    public ItemStack getRecipeTypeItem(@Nonnull Player p, @Nonnull RecipeType recipeType) {
+        Validate.notNull(p, "Player cannot be null!");
+        Validate.notNull(recipeType, "Recipe type cannot be null!");
+
         Language language = getLanguage(p);
         ItemStack item = recipeType.toItem();
         NamespacedKey key = recipeType.getKey();
 
-        if (language.getRecipeTypesFile() == null || !language.getRecipeTypesFile().contains(key.getNamespace() + "." + key.getKey())) {
+        if (language == null || language.getRecipeTypesFile() == null || !language.getRecipeTypesFile().contains(key.getNamespace() + '.' + key.getKey())) {
             language = getLanguage("en");
         }
 
-        if (!language.getRecipeTypesFile().contains(key.getNamespace() + "." + key.getKey())) {
+        if (!language.getRecipeTypesFile().contains(key.getNamespace() + '.' + key.getKey())) {
             return item;
         }
 
@@ -218,7 +269,10 @@ public ItemStack getRecipeTypeItem(Player p, RecipeType recipeType) {
     }
 
     @Override
-    public void sendMessage(CommandSender recipient, String key, boolean addPrefix) {
+    public void sendMessage(@Nonnull CommandSender recipient, @Nonnull String key, boolean addPrefix) {
+        Validate.notNull(recipient, "Recipient cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+
         String prefix = addPrefix ? getPrefix() : "";
 
         if (recipient instanceof Player) {
@@ -229,6 +283,9 @@ public void sendMessage(CommandSender recipient, String key, boolean addPrefix)
     }
 
     public void sendActionbarMessage(@Nonnull Player player, @Nonnull String key, boolean addPrefix) {
+        Validate.notNull(player, "Player cannot be null!");
+        Validate.notNull(key, "Message key cannot be null!");
+
         String prefix = addPrefix ? getPrefix() : "";
         String message = ChatColors.color(prefix + getMessage(player, key));
 
@@ -237,15 +294,17 @@ public void sendActionbarMessage(@Nonnull Player player, @Nonnull String key, bo
     }
 
     @Override
-    public void sendMessage(CommandSender recipient, String key) {
+    public void sendMessage(@Nonnull CommandSender recipient, @Nonnull String key) {
         sendMessage(recipient, key, true);
     }
 
+    @ParametersAreNonnullByDefault
     public void sendMessage(CommandSender recipient, String key, UnaryOperator<String> function) {
         sendMessage(recipient, key, true, function);
     }
 
     @Override
+    @ParametersAreNonnullByDefault
     public void sendMessage(CommandSender recipient, String key, boolean addPrefix, UnaryOperator<String> function) {
         if (SlimefunPlugin.getMinecraftVersion() == MinecraftVersion.UNIT_TEST) {
             return;
@@ -261,7 +320,7 @@ public void sendMessage(CommandSender recipient, String key, boolean addPrefix,
     }
 
     @Override
-    public void sendMessages(CommandSender recipient, String key) {
+    public void sendMessages(@Nonnull CommandSender recipient, @Nonnull String key) {
         String prefix = getPrefix();
 
         if (recipient instanceof Player) {
@@ -278,6 +337,7 @@ public void sendMessages(CommandSender recipient, String key) {
     }
 
     @Override
+    @ParametersAreNonnullByDefault
     public void sendMessages(CommandSender recipient, String key, boolean addPrefix, UnaryOperator<String> function) {
         String prefix = addPrefix ? getPrefix() : "";
 
@@ -294,8 +354,8 @@ public void sendMessages(CommandSender recipient, String key, boolean addPrefix,
         }
     }
 
+    @ParametersAreNonnullByDefault
     public void sendMessages(CommandSender recipient, String key, UnaryOperator<String> function) {
         sendMessages(recipient, key, true, function);
     }
-
 }