Package org.exolab.castor.xml.validators
Class ByteValidator
- java.lang.Object
-
- org.exolab.castor.xml.validators.PatternValidator
-
- org.exolab.castor.xml.validators.ByteValidator
-
- All Implemented Interfaces:
TypeValidator
public class ByteValidator extends PatternValidator implements TypeValidator
The Byte Validation class. This class handles validation for the primitivebyte
andjava.lang.Byte
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
Constructors Constructor Description ByteValidator()
Creates a new ByteValidator with no restrictions.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearFixed()
Clears the fixed value for this IntegerValidator.void
clearMax()
Clears the maximum value for this ByteValidator.void
clearMin()
Clears the minimum value for this ByteValidator.java.lang.Byte
getFixed()
Returns the configured fixed value for byte validation.java.lang.Byte
getMaxInclusive()
Returns the configured maximum value for byte validation.java.lang.Byte
getMinInclusive()
Returns the configured mainmum value for byte validation.java.lang.Integer
getTotalDigits()
Returns the configured maximum number of digits (inclusive) for byte validation.boolean
hasFixed()
Returns true if a fixed value to validate against has been set.void
setFixed(byte fixedValue)
Sets the fixed value for byte validation.void
setMaxExclusive(byte maxValue)
Sets the maximum (exclusive) value for byte validation.void
setMaxInclusive(byte maxValue)
Sets the maximum (inclusive) value for byte validation.void
setMinExclusive(byte minValue)
Sets the minimum (exclusive) value for byte validation.void
setMinInclusive(byte minValue)
Sets the minimum (inclusive) value for byte validation.void
setTotalDigits(int totalDig)
Sets the maximum number of digits for byte validation.void
validate(byte b, ValidationContext context)
Validates the given Object.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
addPattern, clearPatterns, getPatterns, hasPattern, isNillable, setNillable, validate
-
-
-
-
Method Detail
-
clearFixed
public void clearFixed()
Clears the fixed value for this IntegerValidator.
-
clearMax
public void clearMax()
Clears the maximum value for this ByteValidator.
-
clearMin
public void clearMin()
Clears the minimum value for this ByteValidator.
-
getFixed
public java.lang.Byte getFixed()
Returns the configured fixed value for byte validation. Returns null if no fixed value has been configured.- Returns:
- the fixed value to validate against.
-
getMaxInclusive
public java.lang.Byte getMaxInclusive()
Returns the configured maximum value for byte validation. Returns null if no maximum has been configured.- Returns:
- the maximum (inclusive) value to validate against.
-
getMinInclusive
public java.lang.Byte getMinInclusive()
Returns the configured mainmum value for byte validation. Returns null if no minimum has been configured.- Returns:
- the minimum (inclusive) value to validate against.
-
getTotalDigits
public java.lang.Integer getTotalDigits()
Returns the configured maximum number of digits (inclusive) for byte 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(byte fixedValue)
Sets the fixed value for byte validation.NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no byte will pass validation. This is as according to the XML Schema spec.
- Parameters:
fixedValue
- the fixed value that a byte validated with this validator must be equal to.
-
setMinExclusive
public void setMinExclusive(byte minValue)
Sets the minimum (exclusive) value for byte validation. To pass validation, a byte must be greater than this value.- Parameters:
minValue
- the minimum (exclusive) value for byte validation.
-
setMinInclusive
public void setMinInclusive(byte minValue)
Sets the minimum (inclusive) value for byte validation. To pass validation, a byte must be greater than or equal to this value.- Parameters:
minValue
- the minimum (inclusive) value for byte validation.
-
setMaxExclusive
public void setMaxExclusive(byte maxValue)
Sets the maximum (exclusive) value for byte validation. To pass validation, a byte must be less than this value.- Parameters:
maxValue
- the maximum (exclusive) value for byte validation.
-
setMaxInclusive
public void setMaxInclusive(byte maxValue)
Sets the maximum (inclusive) value for byte validation. To pass validation, a byte must be less than or equal to this value.- Parameters:
maxValue
- the maximum (inclusive) value for byte validation.
-
setTotalDigits
public void setTotalDigits(int totalDig)
Sets the maximum number of digits for byte validation. To pass validation, a byte must have this many digits or fewer. Leading zeros are not counted.- Parameters:
totalDig
- the maximum (inclusive) number of digits for byte validation. (must be > 0)
-
validate
public void validate(byte b, ValidationContext context) throws ValidationException
Validates the given Object.- Parameters:
b
- the byte to validatecontext
- the ValidationContext- Throws:
ValidationException
- if the object fails validation.
-
validate
public void validate(java.lang.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(java.lang.Object object, ValidationContext context) throws ValidationException
Validates the given Object.- Specified by:
validate
in interfaceTypeValidator
- Overrides:
validate
in classPatternValidator
- Parameters:
object
- the Object to validatecontext
- the ValidationContext- Throws:
ValidationException
- if the object fails validation.
-
-