FloatValidator (Castor JavaDoc)

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

All Implemented Interfaces:

TypeValidator
```
public class FloatValidator
extends PatternValidator
implements TypeValidator
```
The Float Validation class. This class handles validation for the primitive float and java.lang.Float types.

Version:

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

Author:

Arnaud Blandin

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

Constructor Summary

Constructors
Constructor Description

FloatValidator()
Creates a new FloatValidator with no restrictions.

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

Method Summary

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

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

FloatValidator

Method Detail

clearFixed

clearMax

clearMin

getFixed

getMaxInclusive

getMaxExclusive

getMinInclusive

getMinExclusive

hasFixed

setFixed

setMinExclusive

setMinInclusive

setMaxExclusive

setMaxInclusive

validate

validate

validate