Class StringValidator
java.lang.Object
org.apache.fulcrum.intake.validator.DefaultValidator<String>
org.apache.fulcrum.intake.validator.StringValidator
- All Implemented Interfaces:
org.apache.avalon.framework.logger.LogEnabled,InitableByConstraintMap,Validator<String>
A validator that will compare a testValue against the following
constraints:
This validator can serve as the base class for more specific validators
| Name | Valid Values | Default Value |
|---|---|---|
| required | true|false | false |
| mask | regexp | |
| minLength | integer | 0 |
| maxLength | integer |
- Version:
- $Id$
- Author:
- John McNally, Quinton McCombs, Colin Chalmers, Jürgen Hoffmann, Thomas Vandahl
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe message to report if the mask constraint is not satisfiedprotected PatternThe compiled Regular Expressionprotected StringThe matching mask String as supplied by the XML inputFields inherited from class org.apache.fulcrum.intake.validator.DefaultValidator
errorMessage, log, maxLength, maxLengthMessage, minLength, minLengthMessage, required, requiredMessageFields inherited from interface org.apache.fulcrum.intake.validator.Validator
FLEXIBLE_RULE_NAME, FORMAT_RULE_NAME, INVALID_NUMBER_RULE_NAME, MASK_RULE_NAME, MAX_LENGTH_RULE_NAME, MAX_VALUE_RULE_NAME, MIN_LENGTH_RULE_NAME, MIN_VALUE_RULE_NAME, REQUIRED_RULE_NAME -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidassertValidity(String testValue) Determine whether a testValue meets the criteria specified in the constraints defined for this validatorgetMask()Get the value of mask.Get the value of maskMessage.voidinit(Map<String, ? extends Constraint> paramMap) Extract the relevant parameters from the constraints listed in <rule> tags within the intake.xml file.voidSet the value of mask.voidsetMaskMessage(String message) Set the value of maskMessage.Methods inherited from class org.apache.fulcrum.intake.validator.DefaultValidator
assertValidity, enableLogging, getMaxLength, getMaxLengthMessage, getMessage, getMinLength, getMinLengthMessage, getRequiredMessage, isRequired, isValid, isValid, setMaxLength, setMaxLengthMessage, setMinLength, setMinLengthMessage, setRequired, setRequiredMessage
-
Field Details
-
maskString
The matching mask String as supplied by the XML input -
maskPattern
The compiled Regular Expression -
maskMessage
The message to report if the mask constraint is not satisfied
-
-
Constructor Details
-
StringValidator
public StringValidator()Default constructor
-
-
Method Details
-
init
Extract the relevant parameters from the constraints listed in <rule> tags within the intake.xml file.- Specified by:
initin interfaceInitableByConstraintMap- Overrides:
initin classDefaultValidator<String>- Parameters:
paramMap- aMapofRule's containing constraints on the input.- Throws:
InvalidMaskException- An invalid mask was specified for one of the rules
-
assertValidity
Determine whether a testValue meets the criteria specified in the constraints defined for this validator- Specified by:
assertValidityin interfaceValidator<String>- Overrides:
assertValidityin classDefaultValidator<String>- Parameters:
testValue- aStringto be tested- Throws:
ValidationException- containing an error message if the testValue did not pass the validation tests.
-
getMask
Get the value of mask.- Returns:
- value of mask.
-
setMask
Set the value of mask.- Parameters:
mask- Value to assign to mask.- Throws:
InvalidMaskException- the mask could not be compiled.
-
getMaskMessage
Get the value of maskMessage.- Returns:
- value of maskMessage.
-
setMaskMessage
Set the value of maskMessage.- Parameters:
message- Value to assign to maskMessage.
-