Package me.gamercoder215.starcosmetics.api.cosmetics.structure

Enum Class StructureCompletion

java.lang.Object

java.lang.Enum<StructureCompletion>

me.gamercoder215.starcosmetics.api.cosmetics.structure.StructureCompletion

All Implemented Interfaces:

Serializable, Comparable<StructureCompletion>, Constable, Completion

public enum StructureCompletion
extends Enum<StructureCompletion>
implements Completion

Represents a Completion for unlocking a Structure.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMON	Represents the completion for unlocking Rarity.COMMON structures.
EPIC	Represents the completion for unlocking Rarity.EPIC structures.
LEGENDARY	Represents the completion for unlocking Rarity.LEGENDARY structures.
MYTHICAL	Represents the completion for unlocking Rarity.MYTHICAL structures.
OCCASIONAL	Represents the completion for unlocking Rarity.OCCASIONAL structures.
RARE	Represents the completion for unlocking Rarity.RARE structures.
SPECIAL	Represents the completion for unlocking Rarity.SPECIAL structures.
ULTRA	Represents the completion for unlocking Rarity.ULTRA structures.
UNCOMMON	Represents the completion for unlocking Rarity.UNCOMMON structures.

Method Summary

Modifier and Type	Method	Description
static @Nullable StructureCompletion	byRarity(@NotNull Rarity rarity)	Fetches the StructureCompletion for the specified Rarity.
CompletionCriteria	getCriteria()	Fetches the criteria for this Completion.
@NotNull String	getKey()	Fetches the key used in the config to fetch whether this Completion is done.
@NotNull String	getNamespace()	Fetches the namespace of this Completion.
@NotNull Rarity	getRarity()	Fetches the Rarity of this Completion.
static StructureCompletion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StructureCompletion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.gamercoder215.starcosmetics.api.Completion

getFullKey

Enum Constant Details

COMMON

public static final StructureCompletion COMMON

Represents the completion for unlocking Rarity.COMMON structures.

OCCASIONAL

public static final StructureCompletion OCCASIONAL

Represents the completion for unlocking Rarity.OCCASIONAL structures.

UNCOMMON

public static final StructureCompletion UNCOMMON

Represents the completion for unlocking Rarity.UNCOMMON structures.

RARE

public static final StructureCompletion RARE

Represents the completion for unlocking Rarity.RARE structures.

EPIC

public static final StructureCompletion EPIC

Represents the completion for unlocking Rarity.EPIC structures.

LEGENDARY

public static final StructureCompletion LEGENDARY

Represents the completion for unlocking Rarity.LEGENDARY structures.

MYTHICAL

public static final StructureCompletion MYTHICAL

Represents the completion for unlocking Rarity.MYTHICAL structures.

ULTRA

public static final StructureCompletion ULTRA

Represents the completion for unlocking Rarity.ULTRA structures.

SPECIAL

public static final StructureCompletion SPECIAL

Represents the completion for unlocking Rarity.SPECIAL structures.

Method Details

values

public static StructureCompletion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StructureCompletion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getKey

@NotNull
public @NotNull String getKey()

Description copied from interface: Completion

Fetches the key used in the config to fetch whether this Completion is done.

Specified by:

getKey in interface Completion

Returns:

Completion Configuration Key

getNamespace

@NotNull
public @NotNull String getNamespace()

Description copied from interface: Completion

Fetches the namespace of this Completion.

Specified by:

getNamespace in interface Completion

Returns:

Completion Namespace

byRarity

@Nullable
public static @Nullable StructureCompletion byRarity(@NotNull
 @NotNull Rarity rarity)

Fetches the StructureCompletion for the specified Rarity.

Parameters:

rarity - Rarity to fetch StructureCompletion for

Returns:

StructureCompletion for specified Rarity, or null if not found

getRarity

@NotNull
public @NotNull Rarity getRarity()

Description copied from interface: Completion

Fetches the Rarity of this Completion.

Specified by:

getRarity in interface Completion

Returns:

Completion Rarity

getCriteria

public CompletionCriteria getCriteria()

Description copied from interface: Completion

Fetches the criteria for this Completion.

Specified by:

getCriteria in interface Completion

Returns:

Completion Criteria