ActionMessage (Apache Struts API Documentation)
Keywords: org.apache.struts.action.ActionMessage,ActionMessage class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.action
Class ActionMessage

    java.lang.Object
      |
      +--org.apache.struts.action.ActionMessage

All Implemented Interfaces:
  java.io.Serializable

Direct Known Subclasses:
  ActionError

public class ActionMessage
extends java.lang.Object
implements java.io.Serializable

An encapsulation of an individual message returned by the `validate()` method of an `ActionForm`, consisting of a message key (to be used to look up message text in an appropriate message resources database) plus up to four placeholder objects that can be used for parametric replacement in the message text.

Since:
  Struts 1.1
Version:
  $Revision: 1.1 $ $Date: 2003-08-22 09:14:33 +0100 (Fri, 22 Aug 2003) $
Author:
  Craig R. McClanahan, David Winterfeldt
See Also:
  Serialized Form

Field Summary
`protected java.lang.String` | `key` The message key for this message.
`protected java.lang.Object[]` | `values` The replacement values for this mesasge.

Constructor Summary
`ActionMessage(java.lang.String key)` Construct an action message with no replacement values.
`ActionMessage(java.lang.String key, java.lang.Object value0)` Construct an action message with the specified replacement values.
`ActionMessage(java.lang.String key, java.lang.Object[] values)` Construct an action message with the specified replacement values.
`ActionMessage(java.lang.String key, java.lang.Object value0, java.lang.Object value1)` Construct an action message with the specified replacement values.
`ActionMessage(java.lang.String key, java.lang.Object value0, java.lang.Object value1, java.lang.Object value2)` Construct an action message with the specified replacement values.
`ActionMessage(java.lang.String key, java.lang.Object value0, java.lang.Object value1, java.lang.Object value2, java.lang.Object value3)` Construct an action message with the specified replacement values.

Method Summary
`java.lang.String` | `getKey()` Get the message key for this message.
`java.lang.Object[]` | `getValues()` Get the replacement values for this message.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### key

    protected java.lang.String key

  The message key for this message.

### values

    protected java.lang.Object[] values

  The replacement values for this mesasge.

Constructor Detail

### ActionMessage

    public ActionMessage(java.lang.String key)

  Construct an action message with no replacement values.

Parameters:
  `key` - Message key for this message

### ActionMessage

    public ActionMessage(java.lang.String key,
                         java.lang.Object value0)

  Construct an action message with the specified replacement values.

Parameters:
  `key` - Message key for this message
  `value0` - First replacement value

### ActionMessage

    public ActionMessage(java.lang.String key,
                         java.lang.Object value0,
                         java.lang.Object value1)

  Construct an action message with the specified replacement values.

Parameters:
  `key` - Message key for this message
  `value0` - First replacement value
  `value1` - Second replacement value

### ActionMessage

    public ActionMessage(java.lang.String key,
                         java.lang.Object value0,
                         java.lang.Object value1,
                         java.lang.Object value2)

  Construct an action message with the specified replacement values.

Parameters:
  `key` - Message key for this message
  `value0` - First replacement value
  `value1` - Second replacement value
  `value2` - Third replacement value

### ActionMessage

    public ActionMessage(java.lang.String key,
                         java.lang.Object value0,
                         java.lang.Object value1,
                         java.lang.Object value2,
                         java.lang.Object value3)

  Construct an action message with the specified replacement values.

Parameters:
  `key` - Message key for this message
  `value0` - First replacement value
  `value1` - Second replacement value
  `value2` - Third replacement value
  `value3` - Fourth replacement value

### ActionMessage

    public ActionMessage(java.lang.String key,
                         java.lang.Object[] values)

  Construct an action message with the specified replacement values.

Parameters:
  `key` - Message key for this message
  `values` - Array of replacement values

Method Detail

### getKey

    public java.lang.String getKey()

  Get the message key for this message.

### getValues

    public java.lang.Object[] getValues()

  Get the replacement values for this message.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2003 - Apache Software Foundation