BigIntegerValidator (Castor JavaDoc)

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

All Implemented Interfaces:

TypeValidator
```
public class BigIntegerValidator
extends PatternValidator
implements TypeValidator
```
The BigInteger Validation class. Handles validation for the java.math.BigInteger type.

Version:

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

Author:

Werner Guttmann

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

Constructor Summary

Constructors
Constructor Description

BigIntegerValidator()
Creates a new BigIntegerValidator with no restrictions.

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

Method Summary

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

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

BigIntegerValidator

Method Detail

clearFixed

clearMax

clearMin

getFixed

getMaxInclusive

getMinInclusive

getTotalDigits

hasFixed

setFixed

setMinExclusive

setMinInclusive

setMaxExclusive

setMaxInclusive

setTotalDigits

validate

validate

validate