org.exolab.castor.xml.validators

Class IntegerValidator

java.lang.Object

org.exolab.castor.xml.validators.PatternValidator

org.exolab.castor.xml.validators.IntegerValidator

All Implemented Interfaces:

TypeValidator

public class IntegerValidator
extends PatternValidator
implements TypeValidator

The Integer Validation class. This class handles validation for the integer type as well as all integer derived types such as positive-integer and negative-integer

Version:

$Revision: 5951 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Keith Visco

Nested Class Summary

Nested classes/interfaces inherited from class org.exolab.castor.xml.validators.PatternValidator

PatternValidator.DefaultRegExpEvaluator

Constructor Summary

Constructors

Constructor and Description
IntegerValidator() Creates a new IntegerValidator with no restrictions

Method Summary

Modifier and Type	Method and Description
void	clearFixed() Clears the fixed value for this IntegerValidator
void	clearMax() Clears the maximum value for this IntegerValidator
void	clearMin() Clears the minimum value for this IntegerValidator
java.lang.Integer	getFixed() Returns the fixed value that integers validated with this validator must be equal to.
java.lang.Integer	getMaxInclusive() Returns the maximum value that integers validated with this validator must be equal to or less than.
java.lang.Integer	getMinInclusive() Returns the minimum value that integers validated with this validator must be equal to or greater than.
java.lang.Integer	getTotalDigits() Returns the total number of digits that integers validated with this validator must have.
boolean	hasFixed() Returns true if a fixed value, to validate against, has been set.
void	setFixed(int fixedValue) Sets the fixed value that integers validated with this validated must be equal to
void	setFixed(java.lang.Integer fixedValue)
void	setMaxExclusive(int maxValue) Sets the maximum value that integers validated with this validator must be less than
void	setMaxInclusive(int maxValue) Sets the maximum value that integers validated with this validator are allowed to be
void	setMinExclusive(int minValue) Sets the minimum value that integers validated with this validator must be greater than
void	setMinInclusive(int minValue) Sets the minimum value that integers validated with this validator are allowed to be
void	setTotalDigits(int totalDig) Sets the totalDigits facet for this Integer type.
void	validate(int i, ValidationContext context)
void	validate(java.lang.Object object) Validates the given Object
void	validate(java.lang.Object object, ValidationContext context) Validates the given Object

Methods inherited from class org.exolab.castor.xml.validators.PatternValidator

getPattern, hasPattern, isNillable, setNillable, setPattern, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntegerValidator

public IntegerValidator()

Creates a new IntegerValidator with no restrictions

Method Detail

clearFixed

public void clearFixed()

Clears the fixed value for this IntegerValidator

clearMax

public void clearMax()

Clears the maximum value for this IntegerValidator

clearMin

public void clearMin()

Clears the minimum value for this IntegerValidator

getFixed

public java.lang.Integer getFixed()

Returns the fixed value that integers validated with this validator must be equal to. A null value is returned if no fixed value has been specified.

Returns:

the fixed value to validate against.

getMaxInclusive

public java.lang.Integer getMaxInclusive()

Returns the maximum value that integers validated with this validator must be equal to or less than. A null value is returned if no maximum value has been specified.

Returns:

the maximum inclusive value to validate against.

getMinInclusive

public java.lang.Integer getMinInclusive()

Returns the minimum value that integers validated with this validator must be equal to or greater than. A null value is returned if no minimum value has been specified.

Returns:

the minimum inclusive value to validate against.

getTotalDigits

public java.lang.Integer getTotalDigits()

Returns the total number of digits that integers validated with this validator must have. A null value is returned if no total number of digits has been specified.

Returns:

the total number of digits

hasFixed

public boolean hasFixed()

Returns true if a fixed value, to validate against, has been set.

Returns:

true if a fixed value has been set.

setFixed

public void setFixed(int fixedValue)

Sets the fixed value that integers validated with this validated must be equal to

Parameters:

fixedValue - the fixed value an integer validated with this validator must be equal to.
NOTE: Using Fixed values takes preceedence over using max and mins, and is really the same as setting both max-inclusive and min-inclusive to the same value

setFixed

public void setFixed(java.lang.Integer fixedValue)

setMinExclusive

public void setMinExclusive(int minValue)

Sets the minimum value that integers validated with this validator must be greater than

Parameters:

minValue - the minimum value an integer validated with this validator must be greater than

setMinInclusive

public void setMinInclusive(int minValue)

Sets the minimum value that integers validated with this validator are allowed to be

Parameters:

minValue - the minimum value an integer validated with this validator may be

setMaxExclusive

public void setMaxExclusive(int maxValue)

Sets the maximum value that integers validated with this validator must be less than

Parameters:

maxValue - the maximum value an integer validated with this validator must be less than

setMaxInclusive

public void setMaxInclusive(int maxValue)

Sets the maximum value that integers validated with this validator are allowed to be

Parameters:

maxValue - the maximum value an integer validated with this validator may be

setTotalDigits

public void setTotalDigits(int totalDig)

Sets the totalDigits facet for this Integer type.

Parameters:

totalDig - the value of totalDigits (must be >0)

validate

public void validate(int i,
                     ValidationContext context)
              throws ValidationException

Throws:

ValidationException

validate

public void validate(java.lang.Object object)
              throws ValidationException

Validates the given Object

Parameters:

object - the Object to validate

Throws:

ValidationException

validate

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

Validates the given Object

Specified by:

validate in interface TypeValidator

Overrides:

validate in class PatternValidator

Parameters:

object - the Object to validate

context - the ValidationContext

Throws:

ValidationException