Package org.bukkit

Class NamespacedKey

java.lang.Object

org.bukkit.NamespacedKey

All Implemented Interfaces:

Namespaced

public final class NamespacedKey
extends Object
implements Namespaced

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 Summary

Fields

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 Summary

Constructors

Constructor	Description
NamespacedKey(String namespace, String key)	Deprecated. should never be used by plugins, for internal use only!!
NamespacedKey(Plugin plugin, String key)	Create a key in the plugin's namespace.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getKey()	Gets the key corresponding to this resource
String	getNamespace()	Gets the namespace this resource is a part of
int	hashCode()
static NamespacedKey	minecraft(String key)	Get a key in the Minecraft namespace.
static NamespacedKey	randomKey()	Deprecated. should never be used by plugins, for internal use only!!
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MINECRAFT

public static final String MINECRAFT

The namespace representing all inbuilt keys.

See Also:

Constant Field Values

BUKKIT

public static final String BUKKIT

The namespace representing all keys generated by Bukkit for backwards compatibility measures.

See Also:

Constant Field Values

Constructor Detail

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 - String representing a grouping of keys

key - Name for this specific 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 Detail

getNamespace

@NotNull
public String getNamespace()

Description copied from interface: Namespaced

Gets the namespace this resource is a part of

This is contractually obligated to only contain lowercase alphanumeric characters, periods, underscores, and hyphens.

Specified by:

getNamespace in interface Namespaced

Returns:

resource namespace

getKey

@NotNull
public String getKey()

Description copied from interface: Namespaced

Gets the key corresponding to this resource

This is contractually obligated to only contain lowercase alphanumeric characters, periods, underscores, hyphens, and forward slashes.

Specified by:

getKey in interface Namespaced

Returns:

resource key

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