easel.config.samples

Enum SampleBooleanChoices

java.lang.Object

java.lang.Enum<SampleBooleanChoices>

easel.config.samples.SampleBooleanChoices

All Implemented Interfaces:

ConfigBooleanEnum, java.io.Serializable, java.lang.Comparable<SampleBooleanChoices>

public enum SampleBooleanChoices
extends java.lang.Enum<SampleBooleanChoices>
implements ConfigBooleanEnum

A sample implementation of the ConfigBooleanEnum interface. This includes two config options, a BOOL_ONE and a BOOL_TWO. Adding new options should only be APPENDED to the end of the options (not added into the middle) once you publicly release your mod (or deserialization will load the improper values and potentially cause confusion). See EaselConfigHelper for further details.

See Also:

EaselConfigHelper

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOL_ONE
BOOL_TWO

Method Summary

Modifier and Type	Method and Description
boolean	getDefault()
static SampleBooleanChoices	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SampleBooleanChoices[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOL_ONE

public static final SampleBooleanChoices BOOL_ONE

BOOL_TWO

public static final SampleBooleanChoices BOOL_TWO

Method Detail

values

public static SampleBooleanChoices[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SampleBooleanChoices c : SampleBooleanChoices.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SampleBooleanChoices valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefault

public boolean getDefault()

Specified by:

getDefault in interface ConfigBooleanEnum