org.apache.commons.validator
Class Arg
java.lang.Object
org.apache.commons.validator.Arg
- Cloneable, Serializable
public class Arg
extends java.lang.Object
implements Cloneable, Serializable
A default argument or an argument for a
specific validator definition (ex: required)
can be stored to pass into a message as parameters. This can be used in a
pluggable validator for constructing locale
sensitive messages by using
java.text.MessageFormat
or an equivalent class. The resource field can be
used to determine if the value stored in the argument
is a value to be retrieved from a locale sensitive
message retrieval system like
java.util.PropertyResourceBundle
.
The resource field defaults to 'true'.
Instances of this class are configured with an <arg> xml element.
$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $protected String | bundle - The resource bundle name that this Arg's
key should be
resolved in (optional).
|
protected String | key - The key or value of the argument.
|
protected String | name - The name dependency that this argument goes with (optional).
|
protected int | position - This argument's position in the message.
|
protected boolean | resource - Whether or not the key is a message resource (optional).
|
Object | clone() - Creates and returns a copy of this object.
|
String | getBundle() - Returns the resource bundle name.
|
String | getKey() - Gets the key/value.
|
String | getName() - Gets the name of the dependency.
|
int | getPosition() - Argument's replacement position.
|
boolean | isResource() - Tests whether or not the key is a resource key or literal value.
|
void | setBundle(String bundle) - Sets the resource bundle name.
|
void | setKey(String key) - Sets the key/value.
|
void | setName(String name) - Sets the name of the dependency.
|
void | setPosition(int position) - Set this argument's replacement position.
|
void | setResource(boolean resource) - Sets whether or not the key is a resource.
|
String | toString() - Returns a string representation of the object.
|
bundle
protected String bundle
The resource bundle name that this Arg's key
should be
resolved in (optional).
key
protected String key
The key or value of the argument.
name
protected String name
The name dependency that this argument goes with (optional).
position
protected int position
This argument's position in the message. Set postion=0 to
make a replacement in this string: "some msg {0}".
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.
clone
public Object clone()
Creates and returns a copy of this object.
getBundle
public String getBundle()
Returns the resource bundle name.
getKey
public String getKey()
Gets the key/value.
getName
public String getName()
Gets the name of the dependency.
- the name of the dependency.
getPosition
public int getPosition()
Argument's replacement position.
- This argument's replacement position.
isResource
public boolean isResource()
Tests whether or not the key is a resource key or literal value.
true
if key is a resource key.
setBundle
public void setBundle(String bundle)
Sets the resource bundle name.
bundle
- The new bundle name.
setKey
public void setKey(String key)
Sets the key/value.
key
- They to access the argument.
setName
public void setName(String name)
Sets the name of the dependency.
name
- the name of the dependency.
setPosition
public void setPosition(int position)
Set this argument's replacement position.
position
- set this argument's replacement position.
setResource
public void setResource(boolean resource)
Sets whether or not the key is a resource.
resource
- If true indicates the key is a resource.
toString
public String toString()
Returns a string representation of the object.
- a string representation of the object.
Copyright (c) 2001-2004 Apache Software Foundation