XSFloat (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.builder.types.XSType
- - org.exolab.castor.builder.types.XSPatternBase
  - - org.exolab.castor.builder.types.XSFloat

```
public final class XSFloat
extends XSPatternBase
```
The XML Schema Float type

Version:

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

Author:

Keith Visco

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) java.lang.Float`	`maxExclusive`
`(package private) java.lang.Float`	`maxInclusive`
`(package private) java.lang.Float`	`minExclusive`
`(package private) java.lang.Float`	`minInclusive`

Fields inherited from class org.exolab.castor.builder.types.XSType
ANYURI_NAME, ANYURI_TYPE, BASE64BINARY_NAME, BASE64BINARY_TYPE, BOOLEAN_NAME, BOOLEAN_TYPE, BYTE_NAME, BYTE_TYPE, CLASS, COLLECTION, DATE_NAME, DATE_TYPE, DATETIME_NAME, DATETIME_TYPE, DECIMAL_NAME, DECIMAL_TYPE, DOUBLE_NAME, DOUBLE_TYPE, DURATION_NAME, DURATION_TYPE, ENTITIES, ENTITY, FLOAT_NAME, FLOAT_TYPE, GDAY_NAME, GDAY_TYPE, GMONTH_NAME, GMONTH_TYPE, GMONTHDAY_NAME, GMONTHDAY_TYPE, GYEAR_NAME, GYEAR_TYPE, GYEARMONTH_NAME, GYEARMONTH_TYPE, HEXBINARY_NAME, HEXBINARY_TYPE, ID_NAME, ID_TYPE, IDREF_NAME, IDREF_TYPE, IDREFS_NAME, IDREFS_TYPE, INT_NAME, INT_TYPE, INTEGER_NAME, INTEGER_TYPE, LANGUAGE_NAME, LANGUAGE_TYPE, LONG_NAME, LONG_TYPE, NAME_NAME, NAME_TYPE, NCNAME_NAME, NCNAME_TYPE, NEGATIVE_INTEGER_NAME, NEGATIVE_INTEGER_TYPE, NMTOKEN_NAME, NMTOKEN_TYPE, NMTOKENS_NAME, NMTOKENS_TYPE, NON_NEGATIVE_INTEGER_NAME, NON_NEGATIVE_INTEGER_TYPE, NON_POSITIVE_INTEGER_NAME, NON_POSITIVE_INTEGER_TYPE, NORMALIZEDSTRING_NAME, NORMALIZEDSTRING_TYPE, NOTATION_NAME, NOTATION_TYPE, NULL, POSITIVE_INTEGER_NAME, POSITIVE_INTEGER_TYPE, QNAME_NAME, QNAME_TYPE, SHORT_NAME, SHORT_TYPE, STRING_NAME, STRING_TYPE, TIME_NAME, TIME_TYPE, TOKEN_NAME, TOKEN_TYPE, UNSIGNED_LONG_NAME, UNSIGNED_LONG_TYPE

Constructor Summary

Constructors
Constructor and Description

XSFloat()

XSFloat(boolean asWrapper)

Constructors
Constructor and Description
`XSFloat()`
`XSFloat(boolean asWrapper)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`createFromJavaObjectCode(java.lang.String variableName)` Returns the String necessary to convert an Object to an instance of this XSType.
`java.lang.String`	`createToJavaObjectCode(java.lang.String variableName)` Returns the String necessary to convert an instance of this XSType to an Object.
`JType`	`getJType()` Returns the JType that this XSType represents
`java.lang.Float`	`getMaxExclusive()` Returns the maximum exclusive value that this XSFloat can hold.
`java.lang.Float`	`getMaxInclusive()` Returns the maximum inclusive value that this XSFloat can hold.
`java.lang.Float`	`getMinExclusive()` Returns the minimum exclusive value that this XSFloat can hold.
`java.lang.Float`	`getMinInclusive()` Returns the minimum inclusive value that this XSFloat can hold.
`boolean`	`hasMaximum()`
`boolean`	`hasMinimum()`
`void`	`setFacets(SimpleType simpleType)` Reads and sets the facets for XSFloat
`void`	`setMaxExclusive(float max)` Sets the maximum exclusive value that this XSFloat can hold.
`void`	`setMaxExclusive(java.lang.Float max)` Sets the maximum exclusive value that this XSFloat can hold.
`void`	`setMaxInclusive(float max)` Sets the maximum inclusive value that this XSFloat can hold.
`void`	`setMaxInclusive(java.lang.Float max)` Sets the maximum inclusive value that this XSFloat can hold.
`void`	`setMinExclusive(float min)` Sets the minimum exclusive value that this XSFloat can hold.
`void`	`setMinExclusive(java.lang.Float min)` Sets the minimum exclusive value that this XSFloat can hold.
`void`	`setMinInclusive(float min)` Sets the minimum inclusive value that this XSFloat can hold.
`void`	`setMinInclusive(java.lang.Float min)` Sets the minimum inclusive value that this XSFloat can hold.
`void`	`validationCode(JSourceCode jsc, java.lang.String fixedValue, java.lang.String fieldValidatorInstanceName)` Creates the validation code for an instance of this XSType.

Methods inherited from class org.exolab.castor.builder.types.XSPatternBase
getPattern, setPattern

Methods inherited from class org.exolab.castor.builder.types.XSType
escapePattern, getFacets, getName, getType, isDateTime, isEnumerated, isPrimitive, newInstanceCode, setAsEnumerated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - maxInclusive
```
java.lang.Float maxInclusive
```
  - maxExclusive
```
java.lang.Float maxExclusive
```
  - minInclusive
```
java.lang.Float minInclusive
```
  - minExclusive
```
java.lang.Float minExclusive
```
- Constructor Detail
  - XSFloat
```
public XSFloat()
```
  - XSFloat
```
public XSFloat(boolean asWrapper)
```
- Method Detail
  - getJType
```
public JType getJType()
```
    Returns the JType that this XSType represents
    
    Specified by:
    
    getJType in class XSType
    
    Returns:
    
    the JType that this XSType represents
  - getMaxExclusive
```
public java.lang.Float getMaxExclusive()
```
    Returns the maximum exclusive value that this XSFloat can hold.
    
    Returns:
    
    the maximum exclusive value that this XSFloat can hold. If no maximum exclusive value has been set, Null will be returned
    
    See Also:
    
    getMaxInclusive()
  - getMaxInclusive
```
public java.lang.Float getMaxInclusive()
```
    Returns the maximum inclusive value that this XSFloat can hold.
    
    Returns:
    
    the maximum inclusive value that this XSFloat can hold. If no maximum inclusive value has been set, Null will be returned
    
    See Also:
    
    getMaxExclusive()
  - getMinExclusive
```
public java.lang.Float getMinExclusive()
```
    Returns the minimum exclusive value that this XSFloat can hold.
    
    Returns:
    
    the minimum exclusive value that this XSFloat can hold. If no minimum exclusive value has been set, Null will be returned
    
    See Also:
    
    getMinInclusive(), setMaxInclusive(float)
  - getMinInclusive
```
public java.lang.Float getMinInclusive()
```
    Returns the minimum inclusive value that this XSFloat can hold.
    
    Returns:
    
    the minimum inclusive value that this XSFloat can hold. If no minimum inclusive value has been set, Null will be returned
    
    See Also:
    
    getMinExclusive()
  - hasMaximum
```
public boolean hasMaximum()
```
  - hasMinimum
```
public boolean hasMinimum()
```
  - setMaxExclusive
```
public void setMaxExclusive(float max)
```
    Sets the maximum exclusive value that this XSFloat can hold.
    
    Parameters:
    
    max - the maximum exclusive value this XSFloat can be
    
    See Also:
    
    setMaxInclusive(Float)
  - setMaxExclusive
```
public void setMaxExclusive(java.lang.Float max)
```
    Sets the maximum exclusive value that this XSFloat can hold.
    
    Parameters:
    
    max - the maximum exclusive value this XSFloat can be
    
    See Also:
    
    setMaxInclusive(float)
  - setMaxInclusive
```
public void setMaxInclusive(float max)
```
    Sets the maximum inclusive value that this XSFloat can hold.
    
    Parameters:
    
    max - the maximum inclusive value this XSFloat can be
    
    See Also:
    
    setMaxExclusive(Float)
  - setMaxInclusive
```
public void setMaxInclusive(java.lang.Float max)
```
    Sets the maximum inclusive value that this XSFloat can hold.
    
    Parameters:
    
    max - the maximum inclusive value this XSFloat can be
    
    See Also:
    
    setMaxExclusive(float)
  - setMinExclusive
```
public void setMinExclusive(float min)
```
    Sets the minimum exclusive value that this XSFloat can hold.
    
    Parameters:
    
    min - the minimum exclusive value this XSFloat can be
    
    See Also:
    
    setMinInclusive(Float)
  - setMinExclusive
```
public void setMinExclusive(java.lang.Float min)
```
    Sets the minimum exclusive value that this XSFloat can hold.
    
    Parameters:
    
    min - the minimum exclusive value this XSFloat can be
    
    See Also:
    
    setMinInclusive(float)
  - setMinInclusive
```
public void setMinInclusive(float min)
```
    Sets the minimum inclusive value that this XSFloat can hold.
    
    Parameters:
    
    min - the minimum inclusive value this XSFloat can be
    
    See Also:
    
    setMinExclusive(Float)
  - setMinInclusive
```
public void setMinInclusive(java.lang.Float min)
```
    Sets the minimum inclusive value that this XSFloat can hold.
    
    Parameters:
    
    min - the minimum inclusive value this XSFloat can be
    
    See Also:
    
    setMinExclusive(float)
  - setFacets
```
public void setFacets(SimpleType simpleType)
```
    Reads and sets the facets for XSFloat
    
    Specified by:
    
    setFacets in class XSType
    
    Parameters:
    
    simpleType - the SimpleType containing the facets
  - createToJavaObjectCode
```
public java.lang.String createToJavaObjectCode(java.lang.String variableName)
```
    Returns the String necessary to convert an instance of this XSType to an Object. This method is really only useful for primitive types
    
    Overrides:
    
    createToJavaObjectCode in class XSType
    
    Parameters:
    
    variableName - the name of the instance variable
    
    Returns:
    
    the String necessary to convert an instance of this XSType to an Object
  - createFromJavaObjectCode
```
public java.lang.String createFromJavaObjectCode(java.lang.String variableName)
```
    Returns the String necessary to convert an Object to an instance of this XSType. This method is really only useful for primitive types
    
    Overrides:
    
    createFromJavaObjectCode in class XSType
    
    Parameters:
    
    variableName - the name of the Object
    
    Returns:
    
    the String necessary to convert an Object to an instance of this XSType
  - validationCode
```
public void validationCode(JSourceCode jsc,
                           java.lang.String fixedValue,
                           java.lang.String fieldValidatorInstanceName)
```
    Creates the validation code for an instance of this XSType. The validation code should if necessary create a newly configured TypeValidator, that should then be added to a FieldValidator instance whose name is provided.
    
    Specified by:
    
    validationCode in class XSType
    
    Parameters:
    
    fixedValue - a fixed value to use if any
    
    jsc - the JSourceCode to fill in.
    
    fieldValidatorInstanceName - the name of the FieldValidator that the configured TypeValidator should be added to.

Class XSFloat

Field Summary

Fields inherited from class org.exolab.castor.builder.types.XSType

Constructor Summary

Method Summary

Methods inherited from class org.exolab.castor.builder.types.XSPatternBase

Methods inherited from class org.exolab.castor.builder.types.XSType

Methods inherited from class java.lang.Object

Field Detail

maxInclusive

maxExclusive

minInclusive

minExclusive

Constructor Detail

XSFloat

XSFloat

Method Detail

getJType

getMaxExclusive

getMaxInclusive

getMinExclusive

getMinInclusive

hasMaximum

hasMinimum

setMaxExclusive

setMaxExclusive

setMaxInclusive

setMaxInclusive

setMinExclusive

setMinExclusive

setMinInclusive

setMinInclusive

setFacets

createToJavaObjectCode

createFromJavaObjectCode

validationCode