net.kyori.minecraft

Interface Key

All Superinterfaces:

java.lang.Comparable<Key>

public interface Key
extends java.lang.Comparable<Key>

A key.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Key.ParseException An exception thrown when there is an error parsing a key.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MINECRAFT_NAMESPACE The namespace for Minecraft.

Method Summary

Modifier and Type	Method and Description
@NonNull java.lang.String	asString() Returns the string representation of this key.
@NonNull java.lang.String	namespace() Gets the namespace.
static @NonNull Key	of(@NonNull java.lang.String string) Creates a key.
static @NonNull Key	of(@NonNull java.lang.String string, char character) Creates a key.
static @NonNull Key	of(@NonNull java.lang.String namespace, @NonNull java.lang.String value) Creates a key.
@NonNull java.lang.String	value() Gets the value.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MINECRAFT_NAMESPACE

static final java.lang.String MINECRAFT_NAMESPACE

The namespace for Minecraft.

See Also:

Constant Field Values

Method Detail

of

static @NonNull Key of(@NonNull java.lang.String string)

Creates a key.

Parameters:

string - the string

Returns:

the key

Throws:

Key.ParseException - if the namespace contains an invalid character

Key.ParseException - if the value contains an invalid character

of

static @NonNull Key of(@NonNull java.lang.String string,
                       char character)

Creates a key.

Parameters:

string - the string

character - the character

Returns:

the key

Throws:

Key.ParseException - if the namespace contains an invalid character

Key.ParseException - if the value contains an invalid character

of

static @NonNull Key of(@NonNull java.lang.String namespace,
                       @NonNull java.lang.String value)

Creates a key.

Parameters:

namespace - the namespace

value - the value

Returns:

the key

Throws:

Key.ParseException - if the namespace contains an invalid character

Key.ParseException - if the value contains an invalid character

namespace

@NonNull java.lang.String namespace()

Gets the namespace.

Returns:

the namespace

value

@NonNull java.lang.String value()

Gets the value.

Returns:

the value

asString

@NonNull java.lang.String asString()

Returns the string representation of this key.

Returns:

the string representation