org.apache.struts.action.ActionMessage Maven / Gradle / Ivy
Show all versions of ibis-struts Show documentation
/*
* $Id: ActionMessage.java 164530 2005-04-25 03:11:07Z niallp $
*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.struts.action;
import 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.
*
* @version $Rev: 164530 $ $Date: 2005-04-25 04:11:07 +0100 (Mon, 25 Apr 2005) $
* @since Struts 1.1
*/
public class ActionMessage implements Serializable {
// ----------------------------------------------------------- Constructors
/**
* Construct an action message with no replacement values.
*
* @param key Message key for this message
*/
public ActionMessage(String key) {
this(key, null);
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param value0 First replacement value
*/
public ActionMessage(String key, Object value0) {
this(key, new Object[] { value0 });
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param value0 First replacement value
* @param value1 Second replacement value
*/
public ActionMessage(String key, Object value0, Object value1) {
this(key, new Object[] { value0, value1 });
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param value0 First replacement value
* @param value1 Second replacement value
* @param value2 Third replacement value
*/
public ActionMessage(String key, Object value0, Object value1,
Object value2) {
this(key, new Object[] { value0, value1, value2 });
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param value0 First replacement value
* @param value1 Second replacement value
* @param value2 Third replacement value
* @param value3 Fourth replacement value
*/
public ActionMessage(String key, Object value0, Object value1,
Object value2, Object value3) {
this(key, new Object[] { value0, value1, value2, value3 });
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param values Array of replacement values
*/
public ActionMessage(String key, Object[] values) {
this.key = key;
this.values = values;
this.resource = true;
}
/**
* Construct an action message with the specified replacement values.
*
* @param key Message key for this message
* @param resource Indicates whether the key is a bundle key or literal value
*/
public ActionMessage(String key, boolean resource) {
this.key = key;
this.resource = resource;
}
// ----------------------------------------------------- Instance Variables
/**
* The message key for this message.
*/
protected String key = null;
/**
* The replacement values for this mesasge.
*/
protected Object values[] = null;
/**
* Indicates whether the key is taken to be as a bundle key [true] or literal value [false].
*/
protected boolean resource = true;
// --------------------------------------------------------- Public Methods
/**
* Get the message key for this message.
*/
public String getKey() {
return (this.key);
}
/**
* Get the replacement values for this message.
*/
public Object[] getValues() {
return (this.values);
}
/**
* Indicate whether the key is taken to be as a bundle key [true] or literal value [false].
*/
public boolean isResource() {
return (this.resource);
}
/**
* Returns a String in the format: key[value1, value2, etc].
*
* @see java.lang.Object#toString()
*/
public String toString() {
StringBuffer buff = new StringBuffer();
buff.append(this.key);
buff.append("[");
if (this.values != null) {
for (int i = 0; i < this.values.length; i++) {
buff.append(this.values[i]);
// don't append comma to last entry
if (i < this.values.length - 1) {
buff.append(", ");
}
}
}
buff.append("]");
return buff.toString();
}
}