me.lucko.helper.setting

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

java.lang.Object

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

Type Parameters:

S - the setting type

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

Represents a map of states of a given realm of settings.

Method Summary

Modifier and Type	Method and Description
byte[]	encode() Encodes the state of each of the settings in this map to a byte array.
String	encodeToString() Encodes the state of each of the settings in this map to a string.
boolean	equals(Object o)
Map<S,V>	exportToMap() Exports this SettingMap as a Map.
V	get(S setting) Gets the state of a given setting.
int	hashCode()
boolean	isDifferentFromDefault() Returns if this map has any settings with states differing from the defaults.
V	set(S setting, V state) Sets the state of a given setting.
String	toString() Returns a readable string representation of the map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

get

public V get(S setting)

Gets the state of a given setting.

Parameters:

setting - the setting

Returns:

the state

set

public V set(S setting,
             V state)

Sets the state of a given setting.

Parameters:

setting - the setting

state - the state to set

Returns:

the previous state of the setting

exportToMap

public Map<S,V> exportToMap()

Exports this SettingMap as a Map.

Returns:

a map

isDifferentFromDefault

public boolean isDifferentFromDefault()

Returns if this map has any settings with states differing from the defaults.

Returns:

if this map differs from the defaults

encode

public byte[] encode()

Encodes the state of each of the settings in this map to a byte array.

Returns:

the bytes

encodeToString

public String encodeToString()

Encodes the state of each of the settings in this map to a string.

Returns:

the string

toString

public String toString()

Returns a readable string representation of the map.

Overrides:

toString in class Object

Returns:

a readable string representation of the map

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object