org.exolab.castor.xml.validators
Class ShortValidator

java.lang.Object
  org.exolab.castor.xml.validators.PatternValidator
      org.exolab.castor.xml.validators.ShortValidator

All Implemented Interfaces:

TypeValidator

public class ShortValidator
extends PatternValidator
implements TypeValidator

The Short Validation class. This class handles validation for the primitive short and the java.lang.Short types.

Version:

$Revision: 6587 $ $Date: 2003-03-03 02:57:21 -0700 (Mon, 03 Mar 2003) $

Author:

Keith Visco, Arnaud Blandin

Field Summary

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

resourceBundle

Constructor Summary

ShortValidator()
Creates a new ShortValidator with no restrictions.

Method Summary

void	clearFixed() Clears the fixed value for this ShortValidator.
void	clearMax() Clears the maximum value for this ShortValidator.
void	clearMin() Clears the minimum value for this ShortValidator.
Short	getFixed() Returns the configured fixed value for short validation.
Short	getMaxInclusive() Returns the configured maximum value for short validation.
Short	getMinInclusive() Returns the configured minimum value for short validation.
Integer	getTotalDigits() Returns the configured maximum number of digits (inclusive) for short validation.
boolean	hasFixed() Returns true if a fixed value to validate against has been set.
void	setFixed(short fixedValue) Sets the fixed value for short validation.
void	setMaxExclusive(short maxValue) Sets the maximum (exclusive) value for short validation.
void	setMaxInclusive(short maxValue) Sets the maximum (inclusive) value for short validation.
void	setMinExclusive(short minValue) Sets the minimum (exclusive) value for short validation.
void	setMinInclusive(short minValue) Sets the minimum (inclusive) value for short validation.
void	setTotalDigits(int totalDig) Sets the maximum number of digits for short validation.
void	validate(Object object) Validates the given Object.
void	validate(Object object, ValidationContext context) Validates the given Object.
void	validate(short s, ValidationContext context) Validates the given Object.

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

addPattern, clearPatterns, getPatterns, hasPattern, isNillable, setNillable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortValidator

public ShortValidator()

Creates a new ShortValidator with no restrictions.

Method Detail

clearFixed

public void clearFixed()

Clears the fixed value for this ShortValidator.

clearMax

public void clearMax()

Clears the maximum value for this ShortValidator.

clearMin

public void clearMin()

Clears the minimum value for this ShortValidator.

getFixed

public Short getFixed()

Returns the configured fixed value for short validation. Returns null if no fixed value has been configured.

Returns:

the fixed value to validate against.

getMaxInclusive

public Short getMaxInclusive()

Returns the configured maximum value for short validation. Returns null if no maximum has been configured.

Returns:

the maximum (inclusive) value to validate against.

getMinInclusive

public Short getMinInclusive()

Returns the configured minimum value for short validation. Returns null if no minimum has been configured.

Returns:

the minimum (inclusive) value to validate against.

getTotalDigits

public Integer getTotalDigits()

Returns the configured maximum number of digits (inclusive) for short validation. Returns null if no maximum number of digits has been configured.

Returns:

the maximum number of digits to validate against.

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(short fixedValue)

Sets the fixed value for short validation.

NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no short will pass validation. This is as according to the XML Schema spec.

Parameters:

fixedValue - the fixed value that a short validated with this validator must be equal to.

setMinExclusive

public void setMinExclusive(short minValue)

Sets the minimum (exclusive) value for short validation. To pass validation, a short must be greater than this value.

Parameters:

minValue - the minimum (exclusive) value for short validation.

setMinInclusive

public void setMinInclusive(short minValue)

Sets the minimum (inclusive) value for short validation. To pass validation, a short must be greater than or equal to this value.

Parameters:

minValue - the minimum (inclusive) value for short validation.

setMaxExclusive

public void setMaxExclusive(short maxValue)

Sets the maximum (exclusive) value for short validation. To pass validation, a short must be less than this value.

Parameters:

maxValue - the maximum (exclusive) value for short validation.

setMaxInclusive

public void setMaxInclusive(short maxValue)

Sets the maximum (inclusive) value for short validation. To pass validation, a short must be less than or equal to this value.

Parameters:

maxValue - the maximum (inclusive) value for short validation.

setTotalDigits

public void setTotalDigits(int totalDig)

Sets the maximum number of digits for short validation. To pass validation, a short must have this many digits or fewer. Leading zeros are not counted.

Parameters:

totalDig - the maximum (inclusive) number of digits for short validation. (must be > 0)

validate

public void validate(short s,
                     ValidationContext context)
              throws ValidationException

Validates the given Object.

Parameters:

s - the short to validate

context - the ValidationContext

Throws:

ValidationException - if the object fails validation.

validate

public void validate(Object object)
              throws ValidationException

Validates the given Object.

Parameters:

object - the Object to validate

Throws:

ValidationException - if the object fails validation.

validate

public void validate(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 - if the object fails validation.