org.kitteh.irc.client.library.feature.defaultmessage

Interface DefaultMessageMap

All Known Implementing Classes:

SimpleDefaultMessageMap

public interface DefaultMessageMap

A mapping of default message types to their corresponding default message.

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(DefaultMessageType key, 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 DefaultMessageMap	setDefault(DefaultMessageType key, @Nullable String defaultString) Sets a new default value for a given default message type.

Method Detail

setDefault

@NonNull DefaultMessageMap setDefault(DefaultMessageType key,
                                      @Nullable String defaultString)

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

Parameters:

key - message type

defaultString - default value

Returns:

self to permit chaining

getDefault

@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.

Parameters:

key - message type

Returns:

default message

getDefault

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

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

Parameters:

key - message type

defaultValue - a fallback value for if no default is set

Returns:

default message

getDefaults

@NonNull Map<DefaultMessageType,String> getDefaults()

Retrieves the full list of all DefaultMessageType to String mappings.

Returns:

an immutable copy of the map