java.lang.Object

com.fren_gor.ultimateAdvancementAPI.util.AdvancementKey

All Implemented Interfaces:: Comparable<AdvancementKey>

public final class AdvancementKey extends Object implements Comparable<AdvancementKey>

The AdvancementKey class represents a valid advancement namespaced key.

The namespaced keys represented by this class match the following pattern: [a-z0-9_.-]{1,127}:[a-z0-9_.-/]{1,127}.

Field Summary

Fields

Modifier and Type

Field

Description

static final Pattern

VALID_ADVANCEMENT_KEY

Pattern every valid advancement key should match.

static final Pattern

VALID_KEY

Pattern every valid key should match.

static final Pattern

VALID_NAMESPACE

Pattern every valid namespace should match.
Constructor Summary

Constructors

Constructor

Description

AdvancementKey(@NotNull MinecraftKeyWrapper key)

Creates a new AdvancementKey from the specified NMS MinecraftKey.

AdvancementKey(@NotNull String namespace, @NotNull String key)

Creates a new AdvancementKey with the provided namespace and key.

AdvancementKey(@NotNull NamespacedKey key)

Creates a new AdvancementKey from the specified NamespacedKey.

AdvancementKey(@NotNull Plugin plugin, @NotNull String key)

Creates a new AdvancementKey with the provided plugin's (lowercased) name as namespace and the specified key.
Method Summary

Modifier and Type

Method

Description

static void

checkKey(String key)

Checks whether the provided key is not null, not empty, and it's length is less or equals to 127.

static void

checkNamespace(String namespace)

Checks whether the provided namespace is not null, not empty, and it's length is less or equals to 127.

int

compareTo(@NotNull AdvancementKey key)

Compares this AdvancementKey to the provided one.

boolean

equals(Object o)

static AdvancementKey

fromString(@NotNull String string)

Creates an AdvancementKey from the provided string.

@NotNull String

getKey()

Gets the key of this namespaced key.

@NotNull String

getNamespace()

Gets the namespace of this namespaced key.

@NotNull MinecraftKeyWrapper

getNMSWrapper()

Gets the NMS wrapper of this AdvancementKey with the same namespace and key of this namespaced key.

int

hashCode()

@NotNull NamespacedKey

toNamespacedKey()

Gets a NamespacedKey with the same namespace and key of this namespaced key.

String

toString()

Returns a string representation of this namespaced key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- VALID_ADVANCEMENT_KEY
  
  public static final Pattern VALID_ADVANCEMENT_KEY
  
  Pattern every valid advancement key should match.
- VALID_NAMESPACE
  
  public static final Pattern VALID_NAMESPACE
  
  Pattern every valid namespace should match.
- VALID_KEY
  
  public static final Pattern VALID_KEY
  
  Pattern every valid key should match.
Constructor Details
- AdvancementKey
  
  public AdvancementKey(@NotNull @NotNull Plugin plugin, @NotNull @NotNull String key)
  
  Creates a new AdvancementKey with the provided plugin's (lowercased) name as namespace and the specified key.
  
  Parameters:
  
  plugin - The plugin.
  
  key - The key. Must match the following pattern: [[a-z0-9_.-/]{1,127}.
- AdvancementKey
  
  public AdvancementKey(@NotNull @NotNull String namespace, @NotNull @NotNull String key) throws IllegalKeyException
  
  Creates a new AdvancementKey with the provided namespace and key.
  
  Parameters:
  
  namespace - The namespace. Must match the following pattern: [[a-z0-9_.-]{1,127}.
  
  key - The key. Must match the following pattern: [[a-z0-9_.-/]{1,127}.
  
  Throws:
  
  IllegalKeyException - If the namespace or the key is not valid.
- AdvancementKey
  
  public AdvancementKey(@NotNull @NotNull NamespacedKey key)
  
  Creates a new AdvancementKey from the specified NamespacedKey.
  
  Parameters:
  
  key - The NamespacedKey.
- AdvancementKey
  
  public AdvancementKey(@NotNull @NotNull MinecraftKeyWrapper key) throws IllegalKeyException
  
  Creates a new AdvancementKey from the specified NMS MinecraftKey.
  
  Parameters:
  
  key - The MinecraftKey.
  
  Throws:
  
  IllegalKeyException - If the namespace or the key is not valid. See AdvancementKey(String, String).
Method Details
- getNamespace
  
  @NotNull public @NotNull String getNamespace()
  
  Gets the namespace of this namespaced key.
  
  Returns:
  
  The namespace of this namespaced key.
- getKey
  
  @NotNull public @NotNull String getKey()
  
  Gets the key of this namespaced key.
  
  Returns:
  
  The key of this namespaced key.
- getNMSWrapper
  
  @NotNull public @NotNull MinecraftKeyWrapper getNMSWrapper()
  
  Gets the NMS wrapper of this AdvancementKey with the same namespace and key of this namespaced key.
  
  Returns:
  
  The NMS wrapper of this AdvancementKey
- toNamespacedKey
  
  @NotNull public @NotNull NamespacedKey toNamespacedKey()
  
  Gets a NamespacedKey with the same namespace and key of this namespaced key.
  
  Returns:
  
  This namespaced key as a NamespacedKey.
- fromString
  
  public static AdvancementKey fromString(@NotNull @NotNull String string) throws IllegalKeyException
  
  Creates an AdvancementKey from the provided string.
  The provided string must be a valid namespace key, or an IllegalKeyException is thrown.
  
  Parameters:
  
  string - The string.
  
  Returns:
  
  An AdvancementKey from the string.
  
  Throws:
  
  IllegalKeyException - If provided string is not a valid namespace key.
- checkNamespace
  
  public static void checkNamespace(String namespace) throws IllegalArgumentException, IllegalKeyException
  
  Checks whether the provided namespace is not null, not empty, and it's length is less or equals to 127.
  
  Parameters:
  
  namespace - The string to validate.
  
  Throws:
  
  IllegalArgumentException - If the provided string is null or empty.
  
  IllegalKeyException - If the provided string is longer than 127 characters.
- checkKey
  
  public static void checkKey(String key) throws IllegalArgumentException, IllegalKeyException
  
  Checks whether the provided key is not null, not empty, and it's length is less or equals to 127.
  
  Parameters:
  
  key - The string to validate.
  
  Throws:
  
  IllegalArgumentException - If the provided string is null or empty.
  
  IllegalKeyException - If the provided string is longer than 127 characters.
- compareTo
  
  public int compareTo(@NotNull @NotNull AdvancementKey key)
  
  Compares this AdvancementKey to the provided one.
  
  Specified by:
  
  compareTo in interface Comparable<AdvancementKey>
  
  Parameters:
  
  key - The other AdvancementKey.
  
  Returns:
  
  A negative integer, zero, or a positive integer as this key is less than, equal to, or greater than the specified one.
  
  Throws:
  
  NullPointerException - If the specified key is null
- toString
  
  public String toString()
  
  Returns a string representation of this namespaced key.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  This namespaced key in the format "namespace:key".
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class AdvancementKey

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

VALID_ADVANCEMENT_KEY

VALID_NAMESPACE

VALID_KEY

Constructor Details

AdvancementKey

AdvancementKey

AdvancementKey

AdvancementKey

Method Details

getNamespace

getKey

getNMSWrapper

toNamespacedKey

fromString

checkNamespace

checkKey

compareTo

toString

equals

hashCode