easel.config.samples

Enum SampleStringChoices

java.lang.Object

java.lang.Enum<SampleStringChoices>

easel.config.samples.SampleStringChoices

All Implemented Interfaces:

ConfigStringEnum, java.io.Serializable, java.lang.Comparable<SampleStringChoices>

public enum SampleStringChoices
extends java.lang.Enum<SampleStringChoices>
implements ConfigStringEnum

A sample implementation of the ConfigStringEnum interface. This includes two config options, a STRING_ONE and a STRING_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
STRING_ONE
STRING_TWO

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefault()
static SampleStringChoices	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SampleStringChoices[]	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

STRING_ONE

public static final SampleStringChoices STRING_ONE

STRING_TWO

public static final SampleStringChoices STRING_TWO

Method Detail

values

public static SampleStringChoices[] 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 (SampleStringChoices c : SampleStringChoices.values())
    System.out.println(c);

Returns:

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

valueOf

public static SampleStringChoices 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 java.lang.String getDefault()

Specified by:

getDefault in interface ConfigStringEnum