Package net.buildtheearth.terraminusminus.substitutes

Class Identifier

java.lang.Object

net.buildtheearth.terraminusminus.substitutes.Identifier

All Implemented Interfaces:

Comparable<Identifier>

public final class Identifier
extends Object
implements Comparable<Identifier>

A unique identifier for a namespaced game resource. Also known as a resource location or namespaced key.

An identifier is made of two parts:

1. a namespace, identifying whatever owns the object (e.g. "minecraft", "myplugin", "custommod", ...)
2. a path, identifying the object itself (e.g. "my_block_name", "textures/my/custom/texture.png", "my_biome", ...)

A valid namespace matches the following regular expression: [a-z0-9_.-]+. A valid path matches the following regular expression: [a-z0-9_./-]+.

Identifier as represented as text in the following format: namespace:path.

This class is immutable and thread safe.
This implementation of the resource location concept is more restrictive than vanilla Minecraft's with the values it accepts for the namespace and path.

See Also:

• Minecraft wiki page on resource locations

Field Summary

Fields

Modifier and Type	Field	Description
final @NonNull String	namespace	The namespace of this identifier.
final @NonNull String	path	The path of this identifier.

Constructor Summary

Constructors

Constructor	Description
Identifier(@NonNull String path)	Creates a new Identifier with the given path in the namespace minecraft.
Identifier(@NonNull String namespace, @NonNull String path)	Creates a new Identifier with the given namespace and path.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Identifier other)
boolean	equals(Object other)
int	hashCode()
@NonNull String	namespace()	The namespace of this identifier.
static @NotNull Identifier	parse(@NonNull String identifier)
@NonNull String	path()	The path of this identifier.
String	toString()
Identifier	withNamespace(@NonNull String namespace)	The namespace of this identifier.
Identifier	withPath(@NonNull String path)	The path of this identifier.

Methods inherited from class java.lang.Object

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

Field Details

namespace

@NonNull
public final @NonNull String namespace

The namespace of this identifier. Is never null and always matches [a-z0-9_.-]+.

path

@NonNull
public final @NonNull String path

The path of this identifier. Is never null and always matches [a-z0-9_./-]+.

Constructor Details

Identifier

public Identifier(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull String path)

Creates a new Identifier with the given namespace and path.

Parameters:

namespace - the namespace for the new Identifier (must match [a-z0-9_.-]+)

path - the path for the new Identifier (must match [a-z0-9_./-]+)

Throws:

NullPointerException - if either the namespace or path are null

IllegalArgumentException - if either the namespace or path are not valid

Identifier

public Identifier(@NonNull
 @NonNull String path)

Creates a new Identifier with the given path in the namespace minecraft.

Parameters:

path - the path for the new Identifier

Throws:

NullPointerException - if path is null

IllegalArgumentException - if the path is not valid

Method Details

parse

@NotNull
public static @NotNull Identifier parse(@NonNull
 @NonNull String identifier)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Identifier other)

Specified by:

compareTo in interface Comparable<Identifier>

namespace

@NonNull
public @NonNull String namespace()

The namespace of this identifier. Is never null and always matches [a-z0-9_.-]+.

path

@NonNull
public @NonNull String path()

The path of this identifier. Is never null and always matches [a-z0-9_./-]+.

withNamespace

public Identifier withNamespace(@NonNull
 @NonNull String namespace)

The namespace of this identifier. Is never null and always matches [a-z0-9_.-]+.

Returns:

this.

withPath

public Identifier withPath(@NonNull
 @NonNull String path)

The path of this identifier. Is never null and always matches [a-z0-9_./-]+.

Returns:

this.