Apache Struts API Documentation: Class ActionErrors

org.apache.struts.action Class ActionErrors

java.lang.Object
  |
  +--org.apache.struts.action.ActionMessages
        |
        +--org.apache.struts.action.ActionErrors

All Implemented Interfaces:

java.io.Serializable

public class ActionErrors

extends ActionMessages

implements java.io.Serializable

A class that encapsulates the error messages being reported by the validate() method of an ActionForm. Validation errors are either global to the entire ActionForm bean they are associated with, or they are specific to a particular bean property (and, therefore, a particular input field on the corresponding form).

Each individual error 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: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

See Also:

Serialized Form

GLOBAL_ERROR

public static final java.lang.String GLOBAL_ERROR

Deprecated. Use ActionMessages.GLOBAL_MESSAGE instead. This will be removed after Struts 1.2.

The "property name" marker to use for global errors, as opposed to those related to a specific property.

ActionErrors

public ActionErrors()

Create an empty ActionErrors object.

ActionErrors

public ActionErrors(ActionErrors messages)

Create an ActionErrors object initialized with the given messages.

Parameters:

messages - The messages to be initially added to this object. This parameter can be null.

Since:

Struts 1.1

add

public void add(java.lang.String property,
                ActionError error)

Deprecated. Use add(String, ActionMessage) instead. This will be removed after Struts 1.2.

Add an error message to the set of errors for the specified property.

Parameters:

property - Property name (or ActionErrors.GLOBAL_ERROR)

error - The error message to be added