Class NamespacedKey

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.api.NamespacedKey

public final class NamespacedKey
extends Object

Represents a key that exists in a namespace.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PATTERN	The regex rule that the namespace and key must match.

Constructor Summary

Constructors

Constructor	Description
NamespacedKey(String namespace, String name)	Creates a new NamespacedKey with the given namespace and name.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
String	getFullKey()	The fully qualified name of this NamespacedKey.
String	getKey()	The key of this NamespacedKey.
String	getNamespace()	The namespace of this NamespacedKey.
int	hashCode()
static NamespacedKey	of(String input)	Creates a new NamespacedKey from the provided input.
String	toString()

Methods inherited from class Object

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

Field Details

PATTERN

public static final Pattern PATTERN

The regex rule that the namespace and key must match.

Constructor Details

NamespacedKey

public NamespacedKey(String namespace,
 String name)

Creates a new NamespacedKey with the given namespace and name.

Each String can only contain letters, numbers, and underscores.

Parameters:

namespace - The namespace of the key.

name - The name of the key.

Throws:

InvalidNameSpacedKeyException - If either the namespace or name is null or does not match the regex rule.

Method Details

of

public static NamespacedKey of(String input)

Creates a new NamespacedKey from the provided input.

If the input is of the form namespace:key, the namespace and key are extracted.

If the input is of the form key, the namespace is set to Constants.PLUGIN_NAME.

Parameters:

input - The input to create the NamespacedKey from.

Returns:

The created NamespacedKey.

Throws:

InvalidNameSpacedKeyException - If either the namespace or name is null or does not match the regex rule.

toString

public String toString()

Overrides:

toString in class Object

getNamespace

public String getNamespace()

The namespace of this NamespacedKey.

Returns:

The namespace of this NamespacedKey.

getKey

public String getKey()

The key of this NamespacedKey.

Returns:

The key of this NamespacedKey.

getFullKey

public String getFullKey()

The fully qualified name of this NamespacedKey.

This is formatted as namespace:key.

Returns:

The fully qualified name of this NamespacedKey.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object