me.lucko.helper.setting

Class BooleanSettingMapFactory<S extends BooleanSetting>

java.lang.Object

me.lucko.helper.setting.BooleanSettingMapFactory<S>

Type Parameters:

S - the setting type

public final class BooleanSettingMapFactory<S extends BooleanSetting>
extends Object

Creates and decodes BooleanSettingMaps for a given realm of settings.

It is safe to introduce additional settings, 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> & BooleanSetting> BooleanSettingMapFactory<S>	create(Class<S> settingsEnum) Creates a new BooleanSettingMapFactory for the given BooleanSetting enum.
static <S extends BooleanSetting> BooleanSettingMapFactory<S>	create(S[] settings) Creates a new BooleanSettingMapFactory for the given BooleanSettings.
BooleanSettingMap<S>	decode(byte[] buf) Decodes the given byte array to a BooleanSettingMap.
BooleanSettingMap<S>	decode(String encodedString) Decodes the given string to a BooleanSettingMap.
S[]	getSettings() Gets the BooleanSetting instances.
BooleanSettingMap<S>	newMap() Creates a new BooleanSettingMap, 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> & BooleanSetting> BooleanSettingMapFactory<S> create(Class<S> settingsEnum)

Creates a new BooleanSettingMapFactory for the given BooleanSetting enum.

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 class

Returns:

a new factory

create

public static <S extends BooleanSetting> BooleanSettingMapFactory<S> create(S[] settings)

Creates a new BooleanSettingMapFactory for the given BooleanSettings.

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 BooleanSetting instances.

Returns:

the setting instances

newMap

public BooleanSettingMap<S> newMap()

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

Returns:

the new map

decode

public BooleanSettingMap<S> decode(byte[] buf)

Decodes the given byte array to a BooleanSettingMap.

Operates on the reverse of BooleanSettingMap.encode().

Parameters:

buf - the byte array

Returns:

the decoded map

decode

public BooleanSettingMap<S> decode(String encodedString)

Decodes the given string to a BooleanSettingMap.

Operates on the reverse of BooleanSettingMap.encodeToString().

Parameters:

encodedString - the string

Returns:

the decoded map