Namespaced
public final class NamespacedKey extends Object implements Namespaced
Keys may only contain lowercase alphanumeric characters, periods, underscores, hyphens, and forward slashes.
Modifier and Type | Field | Description |
---|---|---|
static String |
BUKKIT |
The namespace representing all keys generated by Bukkit for backwards
compatibility measures.
|
static String |
MINECRAFT |
The namespace representing all inbuilt keys.
|
Constructor | Description |
---|---|
NamespacedKey(@NotNull String namespace,
@NotNull String key) |
Deprecated.
should never be used by plugins, for internal use only!!
|
NamespacedKey(@NotNull Plugin plugin,
@NotNull String key) |
Create a key in the plugin's namespace.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals(Object obj) |
|
@NotNull String |
getKey() |
Gets the key corresponding to this resource
|
@NotNull String |
getNamespace() |
Gets the namespace this resource is a part of
|
int |
hashCode() |
|
static @NotNull NamespacedKey |
minecraft(@NotNull String key) |
Get a key in the Minecraft namespace.
|
static @NotNull NamespacedKey |
randomKey() |
Deprecated.
should never be used by plugins, for internal use only!!
|
String |
toString() |
public static final String MINECRAFT
public static final String BUKKIT
@Deprecated public NamespacedKey(@NotNull @NotNull String namespace, @NotNull @NotNull String key)
namespace
- namespacekey
- keypublic NamespacedKey(@NotNull @NotNull Plugin plugin, @NotNull @NotNull String 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.
plugin
- the plugin to use for the namespacekey
- the key to create@NotNull public @NotNull String getNamespace()
Namespaced
This is contractually obligated to only contain lowercase alphanumeric characters, periods, underscores, and hyphens.
getNamespace
in interface Namespaced
@NotNull public @NotNull String getKey()
Namespaced
This is contractually obligated to only contain lowercase alphanumeric characters, periods, underscores, hyphens, and forward slashes.
getKey
in interface Namespaced
@Deprecated @NotNull public static @NotNull NamespacedKey randomKey()
BUKKIT
namespace.@NotNull public static @NotNull NamespacedKey minecraft(@NotNull @NotNull String key)
key
- the key to useCopyright © 2020. All rights reserved.