| java.lang.Object
 org.apache.struts.action.ActionMessages
All known Subclasses: org.apache.struts.action.ActionErrors,
| ActionMessages | | public class ActionMessages implements Serializable(Code) | | A class that encapsulates messages. Messages can be either global or
they are specific to a particular bean property.
Each individual message is described by an ActionMessage
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.
version:
$Rev: 471754 $ $Date: 2005-08-26 21:58:39 -0400 (Fri, 26 Aug 2005)
version:
$
since:
Struts 1.1 |
| Inner Class :protected class ActionMessageItem implements Serializable | |
| Constructor Summary | |
| public | ActionMessages()
| | public | ActionMessages(ActionMessages messages)
Create an ActionMessages object initialized with the
given messages.
Parameters:
messages - The messages to be initially added to this object. |
| Method Summary | |
| public void | add(String property, ActionMessage message)
Add a message to the set of messages for the specified property. | | public void | add(ActionMessages actionMessages)
Adds the messages from the given ActionMessages object
to this set of messages. | | public void | clear()
| | public Iterator | get()
Return the set of all recorded messages, without distinction by
which property the messages are associated with. | | public Iterator | get(String property)
Return the set of messages related to a specific property. | | public boolean | isAccessed()
| | public boolean | isEmpty()
| | public Iterator | properties()
Return the set of property names for which at least one message has
been recorded. | | public int | size()
Return the number of messages recorded for all properties (including
global messages). | | public int | size(String property)
Return the number of messages associated with the specified
property. | | public String | toString()
|
| GLOBAL_MESSAGE | | final public static String GLOBAL_MESSAGE(Code) | | The "property name" marker to use for global messages, as opposed to
those related to a specific property.
|
| accessed | | protected boolean accessed(Code) | | Have the messages been retrieved from this object?
The controller uses this property to determine if session-scoped
messages can be removed.
since:
Struts 1.2 |
| iCount | | protected int iCount(Code) | | The current number of the property/key being added. This is used to
maintain the order messages are added.
|
| messages | | protected HashMap messages(Code) | | The accumulated set of ActionMessage objects
(represented as an ArrayList) for each property, keyed by property
name.
|
| ActionMessages | | public ActionMessages()(Code) | | Create an empty ActionMessages object.
|
| ActionMessages | | public ActionMessages(ActionMessages messages)(Code) | | Create an ActionMessages object initialized with the
given messages.
Parameters:
messages - The messages to be initially added to this object. Thisparameter can be null.
since:
Struts 1.1 |
| add | | public void add(String property, ActionMessage message)(Code) | | 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 ActionMessages.GLOBAL_MESSAGE)
Parameters:
message - The message to be added |
| add | | public void add(ActionMessages actionMessages)(Code) | | Adds the messages from the given ActionMessages 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 ActionMessages 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:
actionMessages - The ActionMessages object to beadded. This parameter can be null.
since:
Struts 1.1 |
| clear | | public void clear()(Code) | | Clear all messages recorded by this object.
|
| get | | public Iterator get()(Code) | | 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.
An iterator over the messages for all properties. |
| get | | public Iterator get(String property)(Code) | | 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 (or ActionMessages.GLOBAL_MESSAGE) An iterator over the messages for the specified property. |
| isAccessed | | public boolean isAccessed()(Code) | | Returns true if the get() or
get(String) methods are called.
true if the messages have been accessed one ormore times.
since:
Struts 1.2 |
| isEmpty | | public boolean isEmpty()(Code) | | Return true if there are no messages recorded in this
collection, or false otherwise.
true if there are no messages recorded in thiscollection; false otherwise.
since:
Struts 1.1 |
| properties | | public Iterator properties()(Code) | | 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 ActionMessages.GLOBAL_MESSAGE
will be one of the returned property names.
An iterator over the property names for which messages exist. |
| size | | public int size()(Code) | | 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.
The number of messages associated with all properties. |
| size | | public int size(String property)(Code) | | Return the number of messages associated with the specified
property.
Parameters:
property - Property name (or ActionMessages.GLOBAL_MESSAGE) The number of messages associated with the property. |
| toString | | public String toString()(Code) | | Returns a String representation of this ActionMessages' property
name=message list mapping.
String representation of the messages
See Also: Object.toString |
|
|