org.apache.commons.validator
Class Arg

java.lang.Object
  |
  +--org.apache.commons.validator.Arg
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

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

An default argument or an argument for a specific validator definition (ex: required) can be stored to pass into a message as 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'.

Version:
$Revision: 1.4 $ $Date: 2002/03/30 04:33:17 $
Author:
David Winterfeldt
See Also:
Serialized Form

Field Summary
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).
 
Constructor Summary
Arg()
           
 
Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 java.lang.String getKey()
          Gets the key/value.
 java.lang.String getName()
          Gets the name of the dependency.
 boolean getResource()
          Gets whether or not the key is a resource.
 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.
 
Methods inherited from class java.lang.Object
, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

name

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

key

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

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.
Constructor Detail

Arg

public Arg()
Method Detail

getName

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

setName

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

getKey

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

setKey

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

getResource

public boolean getResource()
Gets whether or not the key is a resource.

setResource

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

clone

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

toString

public java.lang.String toString()
Returns a string representation of the object.
Overrides:
toString in class java.lang.Object


Copyright (c) 2001-2002 - Apache Software Foundation