Enum Class EnforcementOptions.Enforcement

java.lang.Object

java.lang.Enum<EnforcementOptions.Enforcement>

space.arim.libertybans.api.punish.EnforcementOptions.Enforcement

All Implemented Interfaces:

Serializable, Comparable<EnforcementOptions.Enforcement>, Constable

Enclosing interface:

EnforcementOptions

public static enum EnforcementOptions.Enforcement
extends Enum<EnforcementOptions.Enforcement>

How the punishment can be enforced.

With regards to enacting punishments, enforcement means the kicking of players and the sending of messages to them. If a punishment is not enforced, no players are kicked and no messages are sent to them.

With regards to undoing punishments, unenforcement means the purging of any relevant caches related to punishments (such as a mute cache).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	The punishment is enforced on the entire network of servers (if applicable) or single server.
NONE	No enforcement is performed
SINGLE_SERVER_ONLY	The punishment is enforced only on the current server.

Method Summary

Modifier and Type	Method	Description
boolean	isGlobal()	Convenience method to check whether this is GLOBAL
static EnforcementOptions.Enforcement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnforcementOptions.Enforcement[]	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, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GLOBAL

public static final EnforcementOptions.Enforcement GLOBAL

The punishment is enforced on the entire network of servers (if applicable) or single server. As necessary, the punishment is sent to other instances.

This is the normal mode of punishment enforcement

SINGLE_SERVER_ONLY

public static final EnforcementOptions.Enforcement SINGLE_SERVER_ONLY

The punishment is enforced only on the current server. It is not sent to other instances.

NONE

public static final EnforcementOptions.Enforcement NONE

No enforcement is performed

Method Details

values

public static EnforcementOptions.Enforcement[] 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 EnforcementOptions.Enforcement 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

isGlobal

public boolean isGlobal()

Convenience method to check whether this is GLOBAL

Returns:

true if this is the global option