org.apache.commons.resources
Interface MessageList

All Known Implementing Classes:

BasicMessageList

public interface MessageList

A class that encapsulates messages. MessageList can be either global or they are specific to a particular bean property.

Each individual message is described by an Message object, which contains a message key (to be looked up in an appropriate message resources database), and up to four placeholder arguments used for parametric substitution in the resulting message.

IMPLEMENTATION NOTE - It is assumed that these objects are created and manipulated only within the context of a single thread. Therefore, no synchronization is required for access to internal collections.

Orginally based on org.apache.struts.action.ActionMessages, Revision 49670.

Field Summary

static String

GLOBAL_MESSAGE_KEY A default key to represent "global" messages that do not pertain to a particular property.

Method Summary

void	add(Message message) Add a message to the set of messages for the "global" property.
void	add(MessageList messages) Adds the messages from the given MessageList object to this set of messages.
void	add(String property, Message message) Add a message to the set of messages for the specified property.
void	clear() Clear all messages recorded by this object.
Iterator	get() Return the set of all recorded messages, without distinction by which property the messages are associated with.
Iterator	get(String property) Return the set of messages related to a specific property.
String	getGlobalMessageKey()
boolean	isAccessed() Determines if the MessageList's messages have been accessed one or more times.
boolean	isEmpty()
Iterator	properties() Return the set of property names for which at least one message has been recorded.
void	setGlobalMessageKey(String globalMessageKey)
int	size() Return the number of messages recorded for all properties (including global messages).
int	size(String property) Return the number of messages associated with the specified property.

Field Detail

GLOBAL_MESSAGE_KEY

static final String GLOBAL_MESSAGE_KEY

A default key to represent "global" messages that do not pertain to a particular property.

See Also:

Constant Field Values

Method Detail

getGlobalMessageKey

String getGlobalMessageKey()

Returns:

The default global message key

setGlobalMessageKey

void setGlobalMessageKey(String globalMessageKey)

Parameters:

globalMessageKey - The new default global message key

add

void add(String property,
         Message message)

Add a message to the set of messages for the specified property. An order of the property/key is maintained based on the initial addition of the property/key.

Parameters:

property - Property name (or MessageList.GLOBAL_MESSAGE_KEY)

message - The message to be added

add

void add(Message message)

Add a message to the set of messages for the "global" property. An order of the property/key is maintained based on the initial addition of the property/key.

Parameters:

message - The message to be added

add

void add(MessageList messages)

Adds the messages from the given MessageList object to this set of messages. The messages are added in the order they are returned from the properties() method. If a message's property is already in the current MessageList object it is added to the end of the list for that property. If a message's property is not in the current list it is added to the end of the properties.

Parameters:

messages - The MessageList object to be added.

clear

void clear()

Clear all messages recorded by this object.

isAccessed

boolean isAccessed()

Determines if the MessageList's messages have been accessed one or more times. Returns true if the get() or get(String) methods are called.

Returns:

true if the messages have been accessed one or more times.

isEmpty

boolean isEmpty()

Returns:

Return true if there are no messages recorded in this collection, or false otherwise.

get

Iterator get()

Return the set of all recorded messages, without distinction by which property the messages are associated with. If there are no messages recorded, an empty enumeration is returned.

Returns:

All messages.

get

Iterator get(String property)

Return the set of messages related to a specific property. If there are no such messages, an empty enumeration is returned.

Parameters:

property - Property name

Returns:

Messages related to a specific property.

properties

Iterator properties()

Return the set of property names for which at least one message has been recorded. If there are no messages, an empty Iterator is returned. If you have recorded global messages, the String value of MessageList.GLOBAL_MESSAGE will be one of the returned property names.

Returns:

The property names.

size

int size()

Return the number of messages recorded for all properties (including global messages). NOTE - it is more efficient to call isEmpty() if all you care about is whether or not there are any messages at all.

Returns:

The number of messages.

size

int size(String property)

Return the number of messages associated with the specified property.

Parameters:

property - Property name (or MessageList.GLOBAL_MESSAGE_KEY

Returns:

The number of messages for a specific property.