Package dev.drawethree.xprison.api.gangs.enums

Enum Class GangNameCheckResult

java.lang.Object

java.lang.Enum<GangNameCheckResult>

dev.drawethree.xprison.api.gangs.enums.GangNameCheckResult

All Implemented Interfaces:

Serializable, Comparable<GangNameCheckResult>, Constable

public enum GangNameCheckResult
extends Enum<GangNameCheckResult>

Enum representing possible results of checking a gang name validity.

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
NAME_CONTAINS_COLORS	Gang name contains color codes, which are not allowed.
NAME_EMPTY	Gang name is empty or not provided.
NAME_RESTRICTED	Gang name is restricted and cannot be used.
NAME_TAKEN	Gang with such a name already exists.
NAME_TOO_LONG	Gang name is too long to be accepted.
SUCCESS	Gang name is available and meets all criteria.

Method Summary

Modifier and Type	Method	Description
static GangNameCheckResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GangNameCheckResult[]	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

Enum Constant Details

SUCCESS

public static final GangNameCheckResult SUCCESS

Gang name is available and meets all criteria.

NAME_RESTRICTED

public static final GangNameCheckResult NAME_RESTRICTED

Gang name is restricted and cannot be used.

NAME_TOO_LONG

public static final GangNameCheckResult NAME_TOO_LONG

Gang name is too long to be accepted.

NAME_CONTAINS_COLORS

public static final GangNameCheckResult NAME_CONTAINS_COLORS

Gang name contains color codes, which are not allowed.

NAME_TAKEN

public static final GangNameCheckResult NAME_TAKEN

Gang with such a name already exists.

NAME_EMPTY

public static final GangNameCheckResult NAME_EMPTY

Gang name is empty or not provided.

Method Details

values

public static GangNameCheckResult[] 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 GangNameCheckResult 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