me.lucko.helper.setting

Class SettingMapFactory<S extends Setting<V>,V extends Setting.State>

java.lang.Object

me.lucko.helper.setting.SettingMapFactory<S,V>

Type Parameters:

S - the setting type

public final class SettingMapFactory<S extends Setting<V>,V extends Setting.State>
extends Object

Creates and decodes SettingMaps for a given realm of settings and states.

It is safe to introduce additional settings and states, so long as the ordinal values of existing ones are not affected.

Method Summary

Modifier and Type	Method and Description
static <S extends Enum<S> & Setting<V>,V extends Enum<V> & Setting.State> SettingMapFactory<S,V>	create(Class<S> settingsEnum, Class<V> statesEnum) Creates a new SettingMapFactory for the given Setting and Setting.State enums.
static <S extends Setting<V>,V extends Setting.State> SettingMapFactory<S,V>	create(S[] settings, V[] states) Creates a new SettingMapFactory for the given Settings and Setting.States.
SettingMap<S,V>	decode(byte[] buf) Decodes the given byte array to a SettingMap.
SettingMap<S,V>	decode(String encodedString) Decodes the given string to a SettingMap.
S[]	getSettings() Gets the Setting instances.
V[]	getStates() Gets the Setting.State instances.
SettingMap<S,V>	newMap() Creates a new SettingMap, with the default states set for each of the settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static <S extends Enum<S> & Setting<V>,V extends Enum<V> & Setting.State> SettingMapFactory<S,V> create(Class<S> settingsEnum,
                                                                                                               Class<V> statesEnum)

Creates a new SettingMapFactory for the given Setting and Setting.State enums.

Factories should ideally be cached (stored in a static field) in the setting enum and reused.

Type Parameters:

S - the class type

Parameters:

settingsEnum - the setting enum

statesEnum - the states enum

Returns:

a new factory

create

public static <S extends Setting<V>,V extends Setting.State> SettingMapFactory<S,V> create(S[] settings,
                                                                                           V[] states)

Creates a new SettingMapFactory for the given Settings and Setting.States.

Factories should ideally be cached (stored in a static field) in the setting class.

Type Parameters:

S - the class type

Parameters:

settings - the settings

Returns:

a new factory

getSettings

public S[] getSettings()

Gets the Setting instances.

Returns:

the setting instances

getStates

public V[] getStates()

Gets the Setting.State instances.

Returns:

the state instances

newMap

public SettingMap<S,V> newMap()

Creates a new SettingMap, with the default states set for each of the settings.

Returns:

the new map

decode

public SettingMap<S,V> decode(byte[] buf)

Decodes the given byte array to a SettingMap.

Operates on the reverse of SettingMap.encode().

Parameters:

buf - the byte array

Returns:

the decoded map

decode

public SettingMap<S,V> decode(String encodedString)

Decodes the given string to a SettingMap.

Operates on the reverse of SettingMap.encodeToString().

Parameters:

encodedString - the string

Returns:

the decoded map