org.kitteh.irc.client.library.defaults.feature

Class SimpleDefaultMessageMap

java.lang.Object

org.kitteh.irc.client.library.defaults.feature.SimpleDefaultMessageMap

All Implemented Interfaces:

DefaultMessageMap

public class SimpleDefaultMessageMap
extends Object
implements DefaultMessageMap

Provides a way to set default messages.

See Also:

DefaultMessageType

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<DefaultMessageType,String>	defaults Defaults stored.

Constructor Summary

Constructors

Constructor and Description
SimpleDefaultMessageMap() Creates a default message map.
SimpleDefaultMessageMap(@Nullable String defaultString) Creates a default message map and sets all messages to a single value.

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<String>	getDefault(DefaultMessageType key) Retrieves the default string value for the specified default message type, using DefaultMessageType.getFallback() if not set in this map.
@NonNull Optional<String>	getDefault(@NonNull DefaultMessageType key, @Nullable String defaultValue) Retrieves the default string value for the specified default message type, using a provided default value if not set in this map.
@NonNull Map<DefaultMessageType,String>	getDefaults() Retrieves the full list of all DefaultMessageType to String mappings.
@NonNull SimpleDefaultMessageMap	setDefault(@NonNull DefaultMessageType key, @Nullable String defaultString) Sets a new default value for a given default message type.

Methods inherited from class java.lang.Object

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

Field Detail

defaults

protected final Map<DefaultMessageType,String> defaults

Defaults stored.

Constructor Detail

SimpleDefaultMessageMap

public SimpleDefaultMessageMap(@Nullable String defaultString)

Creates a default message map and sets all messages to a single value.

Parameters:

defaultString - value to be set for all strings

SimpleDefaultMessageMap

public SimpleDefaultMessageMap()

Creates a default message map.

Method Detail

setDefault

public @NonNull SimpleDefaultMessageMap setDefault(@NonNull DefaultMessageType key,
                                                   @Nullable String defaultString)

Description copied from interface: DefaultMessageMap

Sets a new default value for a given default message type.

Specified by:

setDefault in interface DefaultMessageMap

Parameters:

key - message type

defaultString - default value

Returns:

self to permit chaining

getDefault

public @NonNull Optional<String> getDefault(DefaultMessageType key)

Description copied from interface: DefaultMessageMap

Retrieves the default string value for the specified default message type, using DefaultMessageType.getFallback() if not set in this map.

Specified by:

getDefault in interface DefaultMessageMap

Parameters:

key - message type

Returns:

default message

getDefault

public @NonNull Optional<String> getDefault(@NonNull DefaultMessageType key,
                                            @Nullable String defaultValue)

Description copied from interface: DefaultMessageMap

Retrieves the default string value for the specified default message type, using a provided default value if not set in this map.

Specified by:

getDefault in interface DefaultMessageMap

Parameters:

key - message type

defaultValue - a fallback value for if no default is set

Returns:

default message

getDefaults

public @NonNull Map<DefaultMessageType,String> getDefaults()

Description copied from interface: DefaultMessageMap

Retrieves the full list of all DefaultMessageType to String mappings.

Specified by:

getDefaults in interface DefaultMessageMap

Returns:

an immutable copy of the map