org.apache.commons.validator

Class Msg

Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class Msg
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

An alternative message can be associated with a Field and a pluggable validator instead of using the default message stored in the ValidatorAction (aka pluggable validator). Instances of this class are configured with a <msg> xml element.

See Also:
Serialized Form

Nested Class Summary

Field Summary

protected java.lang.String
bundle
The resource bundle name that this Msg's key should be resolved in (optional).
protected java.lang.String
key
The key or value of the argument.
protected java.lang.String
name
The name dependency that this argument goes with (optional).
protected boolean
resource
Whether or not the key is a message resource (optional).

Method Summary

java.lang.Object
clone()
Creates and returns a copy of this object.
java.lang.String
getBundle()
Returns the resource bundle name.
java.lang.String
getKey()
Gets the key/value.
java.lang.String
getName()
Gets the name of the dependency.
boolean
isResource()
Tests whether or not the key is a resource key or literal value.
void
setBundle(java.lang.String bundle)
Sets the resource bundle name.
void
setKey(java.lang.String key)
Sets the key/value.
void
setName(java.lang.String name)
Sets the name of the dependency.
void
setResource(boolean resource)
Sets whether or not the key is a resource.
java.lang.String
toString()
Returns a string representation of the object.

Field Details

bundle

protected java.lang.String bundle
The resource bundle name that this Msg's key should be resolved in (optional).

Since:
Validator 1.1


key

protected java.lang.String key
The key or value of the argument.


name

protected java.lang.String name
The name dependency that this argument goes with (optional).


resource

protected boolean resource
Whether or not the key is a message resource (optional). Defaults to true. If it is 'true', the value will try to be resolved as a message resource.

Since:
Validator 1.1.4

Method Details

clone

public java.lang.Object clone()
Creates and returns a copy of this object.


getBundle

public java.lang.String getBundle()
Returns the resource bundle name.

Since:
Validator 1.1


getKey

public java.lang.String getKey()
Gets the key/value.


getName

public java.lang.String getName()
Gets the name of the dependency.


isResource

public boolean isResource()
Tests whether or not the key is a resource key or literal value.

Returns:
true if key is a resource key.

Since:
Validator 1.1.4


setBundle

public void setBundle(java.lang.String bundle)
Sets the resource bundle name.

Parameters:
bundle - The new bundle name.

Since:
Validator 1.1


setKey

public void setKey(java.lang.String key)
Sets the key/value.


setName

public void setName(java.lang.String name)
Sets the name of the dependency.


setResource

public void setResource(boolean resource)
Sets whether or not the key is a resource.

Parameters:
resource - If true indicates the key is a resource.

Since:
Validator 1.1.4


toString

public java.lang.String toString()
Returns a string representation of the object.


Copyright (c) 2001-2004 Apache Software Foundation