org.exolab.castor.xml.validators
Class PatternValidator

java.lang.Object
  extended by org.exolab.castor.xml.validators.PatternValidator
Direct Known Subclasses:
BigIntegerValidator, BooleanValidator, ByteValidator, DateTimeValidator, DecimalValidator, DoubleValidator, DurationValidator, FloatValidator, IntegerValidator, IntValidator, LongValidator, ShortValidator, StringValidator

public abstract class PatternValidator
extends java.lang.Object

A simple abstract class used for validating types which allow the pattern facet.

Version:
$Revision: 7273 $ $Date: 2004-12-11 02:13:52 -0700 (Sat, 11 Dec 2004) $
Author:
Keith Visco, Edward Kuns

Constructor Summary
PatternValidator()
          Creates a new PatternValidator with no initial regular expression.
PatternValidator(java.lang.String pattern)
          Creates a new PatternValidator with the given initial regular expression.
 
Method Summary
 void addPattern(java.lang.String pattern)
          Sets the regular expression to validate against.
 void clearPatterns()
          Clear all configured patterns.
 java.lang.String getPattern()
          Deprecated. since Castor 1.1, use getPatterns()
 java.util.List getPatterns()
          Returns the collection of regular expression patterns.
 boolean hasPattern()
          Returns true if a regular expression has been set for this PatternValidator.
 boolean isNillable()
          Returns whether or not objects validated by this Validator are nillable (are allowed to be null).
 void setNillable(boolean nillable)
          Sets whether or not objects validated by this Validator are allowed to be null (nillable).
 void setPattern(java.lang.String pattern)
          Deprecated. since Castor 1.1, use addPattern(String)
 void validate(java.lang.Object object, ValidationContext context)
          Validates the given Object.
 void validate(java.lang.String str, ValidationContext context)
          Validates the given String against the regular expression pattern of this PatternValidator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PatternValidator

public PatternValidator()
Creates a new PatternValidator with no initial regular expression.


PatternValidator

public PatternValidator(java.lang.String pattern)
Creates a new PatternValidator with the given initial regular expression.

Parameters:
pattern - the regular expression to validate against
Method Detail

getPattern

public java.lang.String getPattern()
Deprecated. since Castor 1.1, use getPatterns()

Returns the first regular expression pattern for this PatternValidator, or null if no pattern has been set.

Returns:
the regular expression pattern
See Also:
setPattern(java.lang.String)

getPatterns

public java.util.List getPatterns()
Returns the collection of regular expression patterns.

Returns:
the collection of regular expression patterns.
See Also:
setPattern(java.lang.String)

isNillable

public boolean isNillable()
Returns whether or not objects validated by this Validator are nillable (are allowed to be null).

Returns:
true if null is a valid value

hasPattern

public boolean hasPattern()
Returns true if a regular expression has been set for this PatternValidator.

Returns:
true if a regular expression has been set for this PatternValidator

setNillable

public void setNillable(boolean nillable)
Sets whether or not objects validated by this Validator are allowed to be null (nillable).

Parameters:
nillable - a boolean that when true indicates null values pass validation

setPattern

public void setPattern(java.lang.String pattern)
Deprecated. since Castor 1.1, use addPattern(String)

Sets the regular expression to validate against. Deprecated since Castor 1.1, supports only one pattern to preserve old behavior. Use addPattern(String).

Parameters:
pattern - the regular expression to use when validating

addPattern

public void addPattern(java.lang.String pattern)
Sets the regular expression to validate against.

Parameters:
pattern - the regular expression to use when validating

clearPatterns

public void clearPatterns()
Clear all configured patterns.


validate

public void validate(java.lang.String str,
                     ValidationContext context)
              throws ValidationException
Validates the given String against the regular expression pattern of this PatternValidator.

Parameters:
str - the string to validate
context - the validation context
Throws:
ValidationException - if the given String is not matched by the regular expression pattern
See Also:
setPattern(java.lang.String)

validate

public void validate(java.lang.Object object,
                     ValidationContext context)
              throws ValidationException
Validates the given Object.

Parameters:
object - the Object to validate
context - the ValidationContext
Throws:
ValidationException - if the given String is not matched by the regular expression pattern


Copyright © 2011. All Rights Reserved.