Package org.bukkit

Class NamespacedKey

java.lang.Object
org.bukkit.NamespacedKey

public final class NamespacedKey
extends Object
Represents a String based key which consists of two components - a namespace and a key. Namespaces may only contain lowercase alphanumeric characters, periods, underscores, and hyphens.

Keys may only contain lowercase alphanumeric characters, periods, underscores, hyphens, and forward slashes.

  • Field Details

  • Constructor Details

    • NamespacedKey

      @Deprecated public NamespacedKey​(@NotNull String namespace, @NotNull String key)
      Deprecated.
      should never be used by plugins, for internal use only!!
      Create a key in a specific namespace.
      Parameters:
      namespace - namespace
      key - key
    • NamespacedKey

      public NamespacedKey​(@NotNull Plugin plugin, @NotNull String key)
      Create a key in the plugin's namespace.

      Namespaces may only contain lowercase alphanumeric characters, periods, underscores, and hyphens.

      Keys may only contain lowercase alphanumeric characters, periods, underscores, hyphens, and forward slashes.

      Parameters:
      plugin - the plugin to use for the namespace
      key - the key to create
  • Method Details

    • getNamespace

      @NotNull public String getNamespace()
    • getKey

      @NotNull public String getKey()
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • randomKey

      @Deprecated @NotNull public static NamespacedKey randomKey()
      Deprecated.
      should never be used by plugins, for internal use only!!
      Return a new random key in the BUKKIT namespace.
      Returns:
      new key
    • minecraft

      @NotNull public static NamespacedKey minecraft​(@NotNull String key)
      Get a key in the Minecraft namespace.
      Parameters:
      key - the key to use
      Returns:
      new key in the Minecraft namespace
    • fromString

      @Nullable public static NamespacedKey fromString​(@NotNull String string, @Nullable Plugin defaultNamespace)
      Get a NamespacedKey from the supplied string with a default namespace if a namespace is not defined. This is a utility method meant to fetch a NamespacedKey from user input. Please note that casing does matter and any instance of uppercase characters will be considered invalid. The input contract is as follows:
       fromString("foo", plugin) -> "plugin:foo"
       fromString("foo:bar", plugin) -> "foo:bar"
       fromString(":foo", null) -> "minecraft:foo"
       fromString("foo", null) -> "minecraft:foo"
       fromString("Foo", plugin) -> null
       fromString(":Foo", plugin) -> null
       fromString("foo:bar:bazz", plugin) -> null
       fromString("", plugin) -> null
       
      Parameters:
      string - the string to convert to a NamespacedKey
      defaultNamespace - the default namespace to use if none was supplied. If null, the minecraft namespace (minecraft(String)) will be used
      Returns:
      the created NamespacedKey. null if invalid key
      See Also:
      fromString(String)
    • fromString

      @Nullable public static NamespacedKey fromString​(@NotNull String key)
      Get a NamespacedKey from the supplied string. The default namespace will be Minecraft's (i.e. minecraft(String)).
      Parameters:
      key - the key to convert to a NamespacedKey
      Returns:
      the created NamespacedKey. null if invalid
      See Also:
      fromString(String, Plugin)