Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.validator.Validator
public class Validator
extends java.lang.Object
implements Serializable
ValidatorResources
is used to define the validators
(validation methods) and the validation rules for a JavaBean.
Field Summary | |
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
protected ClassLoader |
|
protected String | |
protected HashMap |
|
protected static Log |
|
protected boolean |
|
protected int |
|
protected Map |
|
protected ValidatorResources | |
protected boolean |
|
Constructor Summary | |
| |
|
Method Summary | |
void |
|
void |
|
ClassLoader |
|
String |
|
boolean |
|
int |
|
Object |
|
Object |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
ValidatorResults |
|
public static final String BEAN_KEY
Deprecated. Use BEAN_PARAM instead.
Resources key the JavaBean is stored to perform validation on.
public static final String BEAN_PARAM
Resources key the JavaBean is stored to perform validation on.
public static final String FIELD_KEY
Deprecated. Use FIELD_PARAM instead.
Resources key theField
is stored under. This will be automatically passed into a validation method with the currentField
if it is specified in the method signature.
public static final String FIELD_PARAM
Resources key theField
is stored under. This will be automatically passed into a validation method with the currentField
if it is specified in the method signature.
public static final String LOCALE_KEY
Deprecated. Use LOCALE_PARAM instead.
Resources key theLocale
is stored. This will be used to retrieve the appropriateFormSet
andForm
to be processed.
public static final String LOCALE_PARAM
Resources key theLocale
is stored. This will be used to retrieve the appropriateFormSet
andForm
to be processed.
public static final String VALIDATOR_ACTION_KEY
Deprecated. Use VALIDATOR_ACTION_PARAM instead.
Resources key theValidatorAction
is stored under. This will be automatically passed into a validation method with the currentValidatorAction
if it is specified in the method signature.
public static final String VALIDATOR_ACTION_PARAM
Resources key theValidatorAction
is stored under. This will be automatically passed into a validation method with the currentValidatorAction
if it is specified in the method signature.
public static final String VALIDATOR_KEY
Deprecated. Use VALIDATOR_PARAM instead.
Resources key theValidator
is stored under. This will be automatically passed into a validation method with the currentValidator
if it is specified in the method signature.
public static final String VALIDATOR_PARAM
Resources key theValidator
is stored under. This will be automatically passed into a validation method with the currentValidator
if it is specified in the method signature.
protected ClassLoader classLoader
The class loader to use for instantiating application objects. If not specified, the context class loader, or the class loader used to load Digester itself, is used, based on the value of theuseContextClassLoader
variable.
protected String formName
protected HashMap hResources
Deprecated. Use parameters instead.
protected static Log log
Deprecated. Subclasses should use their own logging instance.
Logger.
protected boolean onlyReturnErrors
Set this to true to not return Fields that pass validation. Only return failures.
protected int page
The current page number to validate.
protected Map parameters
Maps validation method parameter class names to the objects to be passed into the method.
protected boolean useContextClassLoader
Whether or not to use the Context ClassLoader when loading classes for instantiating new objects. Default isfalse
.
public Validator(ValidatorResources resources)
Construct aValidator
that will use theValidatorResources
passed in to retrieve pluggable validators the different sets of validation rules.
- Parameters:
resources
-ValidatorResources
to use during validation.
public Validator(ValidatorResources resources, String formName)
Construct aValidator
that will use theValidatorResources
passed in to retrieve pluggable validators the different sets of validation rules.
- Parameters:
resources
-ValidatorResources
to use during validation.formName
- Key used for retrieving the set of validation rules.
public void addResource(String parameterClassName, Object parameterValue)
Deprecated. Use setParameter(String, Object) instead.
Add a resource to be used during the processing of validations.
- Parameters:
parameterClassName
- The full class name of the parameter of the validation method that corresponds to the value/instance passed in with it.parameterValue
- The instance that will be passed into the validation method.
public void clear()
Clears the form name, resources that were added, and the page that was set (if any). This can be called to reinitialize the Validator instance so it can be reused. The form name (key to set of validation rules) and any resources needed, like the JavaBean being validated, will need to set and/or added to this instance again. TheValidatorResources
will not be removed since it can be used again and is thread safe.
public ClassLoader getClassLoader()
Return the class loader to be used for instantiating application objects when required. This is determined based upon the following rules:
- The class loader set by
setClassLoader()
, if any- The thread context class loader, if it exists and the
useContextClassLoader
property is set to true- The class loader used to load the Digester class itself.
public String getFormName()
Gets the form name which is the key to a set of validation rules.
public boolean getOnlyReturnErrors()
Returns true if the Validator is only returning Fields that fail validation.
public int getPage()
Gets the page. This in conjunction with the page property of aField
can control the processing of fields. If the field's page is less than or equal to this page value, it will be processed.
public Object getParameterValue(String parameterClassName)
Returns the value of the specified parameter that will be used during the processing of validations.
- Parameters:
parameterClassName
- The full class name of the parameter of the validation method that corresponds to the value/instance passed in with it.
public Object getResource(String parameterClassName)
Deprecated. Use getParameterValue(String) instead.
Get a resource to be used during the processing of validations.
- Parameters:
parameterClassName
- The full class name of the parameter of the validation method that corresponds to the value/instance passed in with it.
public boolean getUseContextClassLoader()
Return the boolean as to whether the context classloader should be used.
public void setClassLoader(ClassLoader classLoader)
Set the class loader to be used for instantiating application objects when required.
- Parameters:
classLoader
- The new class loader to use, ornull
to revert to the standard rules
public void setFormName(String formName)
Sets the form name which is the key to a set of validation rules.
public void setOnlyReturnErrors(boolean onlyReturnErrors)
Configures which Fields the Validator returns from the validate() method. Set this to true to only return Fields that failed validation. By default, validate() returns all fields.
public void setPage(int page)
Sets the page. This in conjunction with the page property of aField
can control the processing of fields. If the field's page is less than or equal to this page value, it will be processed.
public void setParameter(String parameterClassName, Object parameterValue)
Set a parameter of a pluggable validation method.
- Parameters:
parameterClassName
- The full class name of the parameter of the validation method that corresponds to the value/instance passed in with it.parameterValue
- The instance that will be passed into the validation method.
public void setUseContextClassLoader(boolean use)
Determine whether to use the Context ClassLoader (the one found by callingThread.currentThread().getContextClassLoader()
) to resolve/load classes that are defined in various rules. If not using Context ClassLoader, then the class-loading defaults to using the calling-class' ClassLoader.
- Parameters:
use
- determines whether to use Context ClassLoader.
public ValidatorResults validate() throws ValidatorException
Performs validations based on the configured resources.
- Returns:
- The
Map
returned uses the property of theField
for the key and the value is the number of error the field had.