Enum Class EnforcementOptions.Broadcasting

java.lang.Object

java.lang.Enum<EnforcementOptions.Broadcasting>

space.arim.libertybans.api.punish.EnforcementOptions.Broadcasting

All Implemented Interfaces:

Serializable, Comparable<EnforcementOptions.Broadcasting>, Constable

Enclosing interface:

EnforcementOptions

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

How, and whether, broadcast messages should be sent relating to enaction or undoing of the punishment.

Please note that the scope of any available broadcasts are limited by the EnforcementOptions.Enforcement option. For example, if EnforcementOptions.Enforcement.SINGLE_SERVER_ONLY is used, broadcasts will only be sent on the current server. If EnforcementOptions.Enforcement.NONE is used, no broadcasts will be sent, and it will be as if NONE was specified.

The default value if NONE

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Sends no broadcast messages.
NORMAL	Broadcasting behavior commonly used with plugin functionality.
SILENT	Sends broadcast messages as if the punishment has been made "silently", and only to users with the relevant permissions to see silent broadcast messages.

Method Summary

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

NORMAL

public static final EnforcementOptions.Broadcasting NORMAL

Broadcasting behavior commonly used with plugin functionality. Sends broadcast messages to users with the relevant permission.

SILENT

public static final EnforcementOptions.Broadcasting SILENT

Sends broadcast messages as if the punishment has been made "silently", and only to users with the relevant permissions to see silent broadcast messages.

NONE

public static final EnforcementOptions.Broadcasting NONE

Sends no broadcast messages. This is the default for API calls

Method Details

values

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