Class Utils

java.lang.Object
ch.njol.skript.util.Utils
public abstract class Utils extends Object
Utility class.

  • Field Details

  • Method Details

    • join

      public static String join(Object[] objects)

    • join

      public static String join(Iterable<?> objects)

    • isEither

      public static <T> boolean isEither(@Nullable T compared, @Nullable T... types)

    • getAmount

      public static Pair<String,Integer> getAmount(String s)

    • getClasses

      @Deprecated(since="2.10.0", forRemoval=true) public static Class<?>[] getClasses(org.bukkit.plugin.Plugin plugin, String basePackage, String... subPackages) throws IOException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ClassLoader instead.
      Loads classes of the plugin by package. Useful for registering many syntax elements like Skript does it.
      Parameters:
      basePackage - The base package to add to all sub packages, e.g. "ch.njol.skript".
      subPackages - Which subpackages of the base package should be loaded, e.g. "expressions", "conditions", "effects". Subpackages of these packages will be loaded as well. Use an empty array to load all subpackages of the base package.
      Returns:
      This SkriptAddon
      Throws:
      IOException - If some error occurred attempting to read the plugin's jar file.

    • getFile

      @Nullable public static @Nullable File getFile(org.bukkit.plugin.Plugin plugin)
      The first invocation of this method uses reflection to invoke the protected method JavaPlugin.getFile() to get the plugin's jar file.
      Returns:
      The jar file of the plugin.

    • getEnglishPlural

      @Deprecated(forRemoval=true, since="2.14") public static NonNullPair<String,Boolean> getEnglishPlural(String word)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use isPlural(String) instead.

    • isPlural

      public static Utils.PluralResult isPlural(String word)
      Returns whether a word is plural. If it is, updated contains the single variant of the word. Otherwise, updated == word.
      Parameters:
      word - The word to check.
      Returns:
      A pair with the updated word and a boolean indicating whether it was plural.

    • addPluralOverride

      public static void addPluralOverride(String singular, String plural)
      Adds a singular/plural word override for the given words. This is inserted first in the list of words to be checked: it will always be matched and will override all other plurality rules. This will only match the word exactly, and will not apply to derivations of the word.
      Parameters:
      singular - The singular form of the word
      plural - The plural form of the word

    • toEnglishPlural

      public static String toEnglishPlural(String word)
      Gets the english plural of a word.
      Parameters:
      word -
      Returns:
      The english plural of the given word

    • toEnglishPlural

      public static String toEnglishPlural(String s, boolean p)
      Gets the plural of a word (or not if p is false)
      Parameters:
      s -
      p -
      Returns:
      The english plural of the given word, or the word itself if p is false.

    • a

      public static String a(String s)
      Adds 'a' or 'an' to the given string, depending on the first character of the string.
      Parameters:
      s - The string to add the article to
      Returns:
      The given string with an appended a/an and a space at the beginning
      See Also:

    • A

      public static String A(String s)
      Adds 'A' or 'An' to the given string, depending on the first character of the string.
      Parameters:
      s - The string to add the article to
      Returns:
      The given string with an appended A/An and a space at the beginning
      See Also:

    • a

      public static String a(String s, boolean capA)
      Adds 'a' or 'an' to the given string, depending on the first character of the string.
      Parameters:
      s - The string to add the article to
      capA - Whether to use a capital a or not
      Returns:
      The given string with an appended a/an (or A/An if capA is true) and a space at the beginning
      See Also:

    • getBlockHeight

      public static double getBlockHeight(int type, byte data)
      Gets the collision height of solid or partially-solid blocks at the center of the block. This is mostly for use in the teleport effect.

      This version operates on numeric ids, thus only working on Minecraft 1.12 or older.

      Parameters:
      type -
      Returns:
      The block's height at the center

    • sendPluginMessage

      public static CompletableFuture<com.google.common.io.ByteArrayDataInput> sendPluginMessage(String channel, String... data)
      Sends a plugin message using the first player from Bukkit.getOnlinePlayers().

      The next plugin message to be received through channel will be assumed to be the response.

      Parameters:
      channel - the channel for this plugin message
      data - the data to add to the outgoing message
      Returns:
      a completable future for the message of the responding plugin message, if there is one. this completable future will complete exceptionally if no players are online.

    • sendPluginMessage

      public static CompletableFuture<com.google.common.io.ByteArrayDataInput> sendPluginMessage(org.bukkit.entity.Player player, String channel, String... data)
      Sends a plugin message using the from player.

      The next plugin message to be received through channel will be assumed to be the response.

      Parameters:
      player - the player to send the plugin message through
      channel - the channel for this plugin message
      data - the data to add to the outgoing message
      Returns:
      a completable future for the message of the responding plugin message, if there is one. this completable future will complete exceptionally if no players are online.

    • sendPluginMessage

      public static CompletableFuture<com.google.common.io.ByteArrayDataInput> sendPluginMessage(String channel, Predicate<com.google.common.io.ByteArrayDataInput> messageVerifier, String... data) throws IllegalStateException
      Sends a plugin message using the first player from Bukkit.getOnlinePlayers().
      Parameters:
      channel - the channel for this plugin message
      messageVerifier - verifies that a plugin message is the response to the sent message
      data - the data to add to the outgoing message
      Returns:
      a completable future for the message of the responding plugin message, if there is one. this completable future will complete exceptionally if the player is null.
      Throws:
      IllegalStateException - when there are no players online

    • sendPluginMessage

      public static CompletableFuture<com.google.common.io.ByteArrayDataInput> sendPluginMessage(org.bukkit.entity.Player player, String channel, Predicate<com.google.common.io.ByteArrayDataInput> messageVerifier, String... data)
      Sends a plugin message.

      Example usage using the "GetServers" bungee plugin message channel via an overload: Utils.sendPluginMessage("BungeeCord", r -> "GetServers".equals(r.readUTF()), "GetServers") .thenAccept(response -> Bukkit.broadcastMessage(response.readUTF()) // comma delimited server broadcast .exceptionally(ex -> { Skript.warning("Failed to get servers because there are no players online"); return null; });

      Parameters:
      player - the player to send the plugin message through
      channel - the channel for this plugin message
      messageVerifier - verifies that a plugin message is the response to the sent message
      data - the data to add to the outgoing message
      Returns:
      a completable future for the message of the responding plugin message, if there is one. this completable future will complete exceptionally if the player is null.

    • getChatStyle

      @Deprecated(since="2.15", forRemoval=true) @Nullable public static @Nullable String getChatStyle(String s)
      Deprecated, for removal: This API element is subject to removal in a future version.
      See TextComponentParser.

    • replaceChatStyles

      @Deprecated(since="2.15", forRemoval=true) @NotNull public static @NotNull String replaceChatStyles(String message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      See TextComponentParser.

    • replaceEnglishChatStyles

      @Deprecated(since="2.15", forRemoval=true) @NotNull public static @NotNull String replaceEnglishChatStyles(String message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      See TextComponentParser.

    • parseUnicode

      @Deprecated(since="2.15", forRemoval=true) @Nullable public static @Nullable String parseUnicode(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      See TextComponentParser.

    • parseHexColor

      @Deprecated(since="2.15", forRemoval=true) @Nullable public static @Nullable net.md_5.bungee.api.ChatColor parseHexColor(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      See TextComponentParser.

    • random

      public static int random(int start, int end)
      Gets a random value between start (inclusive) and end (exclusive)
      Parameters:
      start -
      end -
      Returns:
      start + random.nextInt(end - start)

    • getSuperType

      public static Class<?> getSuperType(Class<?>... classes)
      See Also:

    • highestDenominator

      @SafeVarargs public static <Found, Type extends Found> Class<Found> highestDenominator(Class<? super Found> bestGuess, @NotNull @NotNull Class<? extends Type> @NotNull ... classes)
      Searches for the highest common denominator of the given types; in other words, the first supertype they all share.

      Arbitrary Selection

      Classes may have multiple highest common denominators: interfaces that they share which do not extend each other. This method selects a superclass first (where possible) but its selection of interfaces is quite random. For this reason, it is advised to specify a "best guess" class as the first parameter, which will be selected if it's appropriate. Note that if the "best guess" is not a real supertype, it can never be selected.
      Type Parameters:
      Found - The highest common denominator found
      Type - The input type spread
      Parameters:
      bestGuess - The fallback class to guess
      classes - The types to check
      Returns:
      The most appropriate common class of all provided

    • parseInt

      public static int parseInt(String s)
      Parses a number that was validated to be an integer but might still result in a NumberFormatException when parsed with Integer.parseInt(String) due to overflow. This method will return Integer.MIN_VALUE or Integer.MAX_VALUE respectively if that happens.
      Parameters:
      s -
      Returns:
      The parsed integer, Integer.MIN_VALUE or Integer.MAX_VALUE respectively

    • parseLong

      public static long parseLong(String s)
      Parses a number that was validated to be an integer but might still result in a NumberFormatException when parsed with Long.parseLong(String) due to overflow. This method will return Long.MIN_VALUE or Long.MAX_VALUE respectively if that happens.
      Parameters:
      s -
      Returns:
      The parsed long, Long.MIN_VALUE or Long.MAX_VALUE respectively

    • classForName

      public static Class<?> classForName(String name)
      Gets class for name. Throws RuntimeException instead of checked one. Use this only when absolutely necessary.
      Parameters:
      name - Class name.
      Returns:
      The class.

    • findLastIndex

      public static <T> int findLastIndex(List<T> list, Predicate<T> checker)
      Finds the index of the last in a List that matches the given Predicate.
      Parameters:
      list - the List to search.
      checker - the Predicate to match elements against.
      Returns:
      the index of the element found, or -1 if no matching element was found.

    • isInteger

      public static boolean isInteger(Number... numbers)

    • loadedRemovedClassWarning

      @Internal public static int loadedRemovedClassWarning(Class<?> source)
      Prints a warning about the loading/use of a class that has been deprecated or removed. This is a fairly-unsafe method and should only be used during class-loading.
      Parameters:
      source - The class about which to print the warning. This MUST be the class calling this method.
      Returns:
      0 (for use by interfaces)

    • isValidUUID

      public static boolean isValidUUID(String uuid)
      Checks if the provided string is a valid UUID.
      Parameters:
      uuid - the string
      Returns:
      whether the given string is a valid UUID

    • getComponentType

      public static Class<?> getComponentType(Class<?> cls)
      Parameters:
      cls - The class.
      Returns:
      The component of cls if cls is an array, otherwise cls.