Enum Class PunishmentType

java.lang.Object

java.lang.Enum<PunishmentType>

space.arim.libertybans.api.PunishmentType

All Implemented Interfaces:

Serializable, Comparable<PunishmentType>, Constable

public enum PunishmentType
extends Enum<PunishmentType>

The type of a punishment

Author:

A248

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAN
KICK
MUTE
WARN

Method Summary

Modifier and Type	Method	Description
boolean	isSingular()	If this punishment type is singular, i.e., whether there can only be 1 kind of it applying to a specific Victim.
String	toString()	Gets the type as a string.
static PunishmentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PunishmentType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BAN

public static final PunishmentType BAN

MUTE

public static final PunishmentType MUTE

WARN

public static final PunishmentType WARN

KICK

public static final PunishmentType KICK

Method Details

values

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

isSingular

public boolean isSingular()

If this punishment type is singular, i.e., whether there can only be 1 kind of it applying to a specific Victim. This is the case for bans and mutes. It is not the case for warns and kicks.

Returns:

true if the type is singular, false otherwise

toString

public String toString()

Gets the type as a string. Same as name().toLowerCase(Locale.ROOT)

Overrides:

toString in class Enum<PunishmentType>

Returns:

the name lowercased using the root locale