IntValidator (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.xml.validators.PatternValidator
- - org.exolab.castor.xml.validators.IntValidator

All Implemented Interfaces:

TypeValidator
```
public class IntValidator
extends PatternValidator
implements TypeValidator
```
The Int Validation class. This class handles validation for the primitive int and java.lang.Integer types as well as all derived types such as unsigned-short.

Version:

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

Author:

Werner Guttmann

Field Summary
- Fields inherited from class org.exolab.castor.xml.validators.PatternValidator
  resourceBundle

Constructor Summary

Constructors
Constructor Description

IntValidator()
Creates a new IntValidator with no restrictions.

Constructors
Constructor	Description
`IntValidator()`	Creates a new IntValidator with no restrictions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearFixed()`	Clears the fixed value for this IntValidator.
`void`	`clearMax()`	Clears the maximum value for this IntValidator.
`void`	`clearMin()`	Clears the minimum value for this IntValidator.
`java.lang.Integer`	`getFixed()`	Returns the configured fixed value for int validation.
`java.lang.Integer`	`getMaxInclusive()`	Returns the configured maximum value for int validation.
`java.lang.Integer`	`getMinInclusive()`	Returns the configured minimum value for int validation.
`java.lang.Integer`	`getTotalDigits()`	Returns the configured maximum number of digits (inclusive) for int validation.
`boolean`	`hasFixed()`	Returns true if a fixed value to validate against has been set.
`void`	`setFixed(int fixedValue)`	Sets the fixed value for int validation.
`void`	`setFixed(java.lang.Integer fixedValue)`	Sets the fixed value for int validation.
`void`	`setMaxExclusive(int maxValue)`	Sets the maximum (exclusive) value for int validation.
`void`	`setMaxInclusive(int maxValue)`	Sets the maximum (inclusive) value for int validation.
`void`	`setMinExclusive(int minValue)`	Sets the minimum (exclusive) value for int validation.
`void`	`setMinInclusive(int minValue)`	Sets the minimum (inclusive) value for int validation.
`void`	`setTotalDigits(int totalDig)`	Sets the maximum number of digits for int validation.
`void`	`validate(int i, 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.exolab.castor.xml.validators.PatternValidator
addPattern, clearPatterns, getPatterns, hasPattern, isNillable, setNillable, validate

- Constructor Detail
  - IntValidator
```
public IntValidator()
```
    Creates a new IntValidator with no restrictions.
- Method Detail
  - clearFixed
```
public void clearFixed()
```
    Clears the fixed value for this IntValidator.
  - clearMax
```
public void clearMax()
```
    Clears the maximum value for this IntValidator.
  - clearMin
```
public void clearMin()
```
    Clears the minimum value for this IntValidator.
  - getFixed
```
public java.lang.Integer getFixed()
```
    Returns the configured fixed value for int validation. Returns null if no fixed value has been configured.
    
    Returns:
    
    the fixed value to validate against.
  - getMaxInclusive
```
public java.lang.Integer getMaxInclusive()
```
    Returns the configured maximum value for int validation. Returns null if no maximum has been configured.
    
    Returns:
    
    the maximum (inclusive) value to validate against.
  - getMinInclusive
```
public java.lang.Integer getMinInclusive()
```
    Returns the configured minimum value for int 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 int 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(int fixedValue)
```
    Sets the fixed value for int validation.
    NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no int will pass validation. This is as according to the XML Schema spec.
    
    Parameters:
    
    fixedValue - the fixed value that a int validated with this validator must be equal to.
  - setFixed
```
public void setFixed(java.lang.Integer fixedValue)
```
    Sets the fixed value for int validation.
    NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no int will pass validation. This is as according to the XML Schema spec.
    
    Parameters:
    
    fixedValue - the fixed value that a int validated with this validator must be equal to.
  - setMinExclusive
```
public void setMinExclusive(int minValue)
```
    Sets the minimum (exclusive) value for int validation. To pass validation, a int must be greater than this value.
    
    Parameters:
    
    minValue - the minimum (exclusive) value for int validation.
  - setMinInclusive
```
public void setMinInclusive(int minValue)
```
    Sets the minimum (inclusive) value for int validation. To pass validation, a int must be greater than or equal to this value.
    
    Parameters:
    
    minValue - the minimum (inclusive) value for int validation.
  - setMaxExclusive
```
public void setMaxExclusive(int maxValue)
```
    Sets the maximum (exclusive) value for int validation. To pass validation, a int must be less than this value.
    
    Parameters:
    
    maxValue - the maximum (exclusive) value for int validation.
  - setMaxInclusive
```
public void setMaxInclusive(int maxValue)
```
    Sets the maximum (inclusive) value for int validation. To pass validation, a int must be less than or equal to this value.
    
    Parameters:
    
    maxValue - the maximum (inclusive) value for int validation.
  - setTotalDigits
```
public void setTotalDigits(int totalDig)
```
    Sets the maximum number of digits for int validation. To pass validation, a int must have this many digits or fewer. Leading zeros are not counted.
    
    Parameters:
    
    totalDig - the maximum (inclusive) number of digits for int validation. (must be > 0)
  - validate
```
public void validate(int i,
                     ValidationContext context)
              throws ValidationException
```
    Validates the given Object.
    
    Parameters:
    
    i - the long to validate
    
    context - 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 interface TypeValidator
    
    Overrides:
    
    validate in class PatternValidator
    
    Parameters:
    
    object - the Object to validate
    
    context - the ValidationContext
    
    Throws:
    
    ValidationException - if the object fails validation.

Class IntValidator

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

IntValidator

Method Detail

clearFixed

clearMax

clearMin

getFixed

getMaxInclusive

getMinInclusive

getTotalDigits

hasFixed

setFixed

setFixed

setMinExclusive

setMinInclusive

setMaxExclusive

setMaxInclusive

setTotalDigits

validate

validate

validate