Package xaero.pac.common.server.player.config.api

Enum Class IPlayerConfigAPI.SetResult

java.lang.Object

java.lang.Enum<IPlayerConfigAPI.SetResult>

xaero.pac.common.server.player.config.api.IPlayerConfigAPI.SetResult

All Implemented Interfaces:

Serializable, Comparable<IPlayerConfigAPI.SetResult>, Constable

Enclosing interface:

IPlayerConfigAPI

public static enum IPlayerConfigAPI.SetResult
extends Enum<IPlayerConfigAPI.SetResult>

All possible result types when trying to set an option value

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
DEFAULTED	The option value was reset to the default config's value
ILLEGAL_OPTION	The option is not allowed in this config
INVALID	The value is not valid for the option
SUCCESS	The value was successully set

Method Summary

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

INVALID

public static final IPlayerConfigAPI.SetResult INVALID

The value is not valid for the option

ILLEGAL_OPTION

public static final IPlayerConfigAPI.SetResult ILLEGAL_OPTION

The option is not allowed in this config

DEFAULTED

public static final IPlayerConfigAPI.SetResult DEFAULTED

The option value was reset to the default config's value

SUCCESS

public static final IPlayerConfigAPI.SetResult SUCCESS

The value was successully set

Method Details

values

public static IPlayerConfigAPI.SetResult[] 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 IPlayerConfigAPI.SetResult 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