org.apache.commons.validator
public class Validator extends Object implements Serializable
ValidatorResources
is used to define the validators
(validation methods) and the validation rules for a JavaBean.
Field Summary | |
---|---|
static String | BEAN_KEY
Resources key the JavaBean is stored to perform validation on. |
static String | BEAN_PARAM
Resources key the JavaBean is stored to perform validation on. |
protected ClassLoader | classLoader
The class loader to use for instantiating application objects.
|
protected String | formName |
static String | FIELD_KEY
Resources key the Field is stored under.
|
static String | FIELD_PARAM
Resources key the Field is stored under.
|
protected HashMap | hResources |
protected static Log | log
Logger. |
static String | LOCALE_KEY
Resources key the Locale is stored.
|
static String | LOCALE_PARAM
Resources key the Locale is stored.
|
protected boolean | onlyReturnErrors
Set this to true to not return Fields that pass validation. |
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 ValidatorResources | resources |
protected boolean | useContextClassLoader
Whether or not to use the Context ClassLoader when loading classes
for instantiating new objects. |
static String | VALIDATOR_ACTION_KEY
Resources key the ValidatorAction is stored under.
|
static String | VALIDATOR_ACTION_PARAM
Resources key the ValidatorAction is stored under.
|
static String | VALIDATOR_KEY
Resources key the Validator is stored under.
|
static String | VALIDATOR_PARAM
Resources key the Validator is stored under.
|
Constructor Summary | |
---|---|
Validator(ValidatorResources resources)
Construct a Validator that will
use the ValidatorResources
passed in to retrieve pluggable validators
the different sets of validation rules.
| |
Validator(ValidatorResources resources, String formName)
Construct a Validator that will
use the ValidatorResources
passed in to retrieve pluggable validators
the different sets of validation rules.
|
Method Summary | |
---|---|
void | addResource(String parameterClassName, Object parameterValue)
Add a resource to be used during the processing
of validations.
|
void | clear()
Clears the form name, resources that were added, and the page that was
set (if any). |
ClassLoader | getClassLoader()
Return the class loader to be used for instantiating application objects
when required. |
String | getFormName()
Gets the form name which is the key to a set of validation rules. |
boolean | getOnlyReturnErrors()
Returns true if the Validator is only returning Fields that fail validation. |
int | getPage()
Gets the page. |
Object | getParameterValue(String parameterClassName)
Returns the value of the specified parameter that will be used during the
processing of validations.
|
Object | getResource(String parameterClassName)
Get a resource to be used during the processing of validations.
|
boolean | getUseContextClassLoader()
Return the boolean as to whether the context classloader should be used. |
void | setClassLoader(ClassLoader classLoader)
Set the class loader to be used for instantiating application objects
when required.
|
void | setFormName(String formName)
Sets the form name which is the key to a set of validation rules. |
void | setOnlyReturnErrors(boolean onlyReturnErrors)
Configures which Fields the Validator returns from the validate() method. |
void | setPage(int page)
Sets the page. |
void | setParameter(String parameterClassName, Object parameterValue)
Set a parameter of a pluggable validation method.
|
void | setUseContextClassLoader(boolean use)
Determine whether to use the Context ClassLoader (the one found by
calling Thread.currentThread().getContextClassLoader() )
to resolve/load classes that are defined in various rules. |
ValidatorResults | validate()
Performs validations based on the configured resources.
|
Deprecated: Use BEAN_PARAM instead.
Resources key the JavaBean is stored to perform validation on.useContextClassLoader
variable.Deprecated: Use FIELD_PARAM instead.
Resources key theField
is stored under.
This will be automatically passed into a validation method
with the current Field
if it is
specified in the method signature.Field
is stored under.
This will be automatically passed into a validation method
with the current Field
if it is
specified in the method signature.Deprecated: Use parameters instead.
Deprecated: Subclasses should use their own logging instance.
Logger.Deprecated: Use LOCALE_PARAM instead.
Resources key theLocale
is stored.
This will be used to retrieve the appropriate
FormSet
and Form
to be
processed.Locale
is stored.
This will be used to retrieve the appropriate
FormSet
and Form
to be
processed.false
.Deprecated: Use VALIDATOR_ACTION_PARAM instead.
Resources key theValidatorAction
is stored under.
This will be automatically passed into a validation method
with the current ValidatorAction
if it is
specified in the method signature.ValidatorAction
is stored under.
This will be automatically passed into a validation method
with the current ValidatorAction
if it is
specified in the method signature.Deprecated: Use VALIDATOR_PARAM instead.
Resources key theValidator
is stored under.
This will be automatically passed into a validation method
with the current Validator
if it is
specified in the method signature.Validator
is stored under.
This will be automatically passed into a validation method
with the current Validator
if it is
specified in the method signature.Validator
that will
use the ValidatorResources
passed in to retrieve pluggable validators
the different sets of validation rules.
Parameters: resources ValidatorResources
to use during validation.
Validator
that will
use the ValidatorResources
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.
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.
ValidatorResources
will not be removed since it can be used
again and is thread safe.setClassLoader()
, if anyuseContextClassLoader
property is set to trueField can control the processing of fields. If the field's
page is less than or equal to this page value, it will be processed.
Parameters: parameterClassName The full class name of the parameter of the validation method that corresponds to the value/instance passed in with it.
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.
Parameters: classLoader The new class loader to use, or null
to revert to the standard rules
Field can control the processing of fields. If the field's page
is less than or equal to this page value, it will be processed.
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.
Thread.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.
Returns: The Map
returned uses the property of the
Field
for the key and the value is the number of error the
field had.