com.levigo.util.swing.messaging
Interface MessageFactory

All Known Implementing Classes:

DefaultMessageFactory, MessageFactoryHolder

public interface MessageFactory

A factory interface that makes Message Objects availiable.

Author:

Carolin Koehler

Method Summary

boolean	containsKey(String key) Returns whether given key has a value in one of the registered resources.
Message	createMessage(String messageKey) Create a Message specified by given key.
Message	createMessage(String messageKey, Object[] parameters, Throwable e) Create a Message specified by given key and additionally parameters.
Collection	getSuppressableMessages() Returns a Collection of Message identifiers of messages that are allowed to be suppressed by the user.

Method Detail

createMessage

Message createMessage(String messageKey)

Create a Message specified by given key.

Returns:

Message

createMessage

Message createMessage(String messageKey,
                      Object[] parameters,
                      Throwable e)

Create a Message specified by given key and additionally parameters.

Parameters:

messageKey - identifier key

parameters - replacing the placeholders {0}, {1}... in the body text.

e - an Exception belonging to the message

Returns:

Message

containsKey

boolean containsKey(String key)

Returns whether given key has a value in one of the registered resources.

Parameters:

key - the key to look up in the resource bundle

Returns:

true if key has a valid value in one or more resources, false otherwise

getSuppressableMessages

Collection getSuppressableMessages()

Returns a Collection of Message identifiers of messages that are allowed to be suppressed by the user.