public final class FloatValue extends NumericValue
Modifier and Type | Field and Description |
---|---|
static FloatValue |
NaN |
static FloatValue |
NEGATIVE_ZERO |
static FloatValue |
ONE |
static FloatValue |
ZERO |
typeLabel
INDETERMINATE_ORDERING
EMPTY_VALUE_ARRAY
Constructor and Description |
---|
FloatValue(float value)
Constructor supplying a float
|
FloatValue(float value,
AtomicType type)
Constructor supplying a float and an AtomicType, for creating
a value that belongs to a user-defined subtype of xs:float.
|
Modifier and Type | Method and Description |
---|---|
NumericValue |
abs()
Get the absolute value as defined by the XPath abs() function
|
NumericValue |
ceiling()
Implement the XPath ceiling() function
|
int |
compareTo(long other)
Compare the value to a long
|
int |
compareTo(Object other)
Compare the value to another numeric value
|
ConversionResult |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
ConversionRules rules)
Convert to target data type
|
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
|
boolean |
effectiveBooleanValue()
Get the effective boolean value
|
(package private) static CharSequence |
floatToString(float value)
Internal method used for conversion of a float to a string
|
NumericValue |
floor()
Implement the XPath floor() function
|
CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
|
double |
getDoubleValue()
Get the numeric value as a double
|
float |
getFloatValue()
Get the value
|
CharSequence |
getPrimitiveStringValue()
Get the value as a String
|
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value.
|
Comparable |
getSchemaComparable()
Get an object that implements XML Schema comparison semantics
|
int |
hashCode()
Get the hashCode.
|
boolean |
isIdentical(Value v)
Determine whether two atomic values are identical, as determined by XML Schema rules.
|
boolean |
isNaN()
Test whether the value is the double/float value NaN
|
boolean |
isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares
equal to some integer
|
NumericValue |
negate()
Negate the value
|
NumericValue |
round(int scale)
Implement the XPath round() function
|
NumericValue |
roundHalfToEven(int scale)
Implement the XPath round-to-half-even() function
|
double |
signum()
Determine whether the value is negative, zero, or positive
|
equals, getDecimalValue, getXPathComparable, isInteger, longValue, parseNumber, toString
asAtomic, checkPermittedContents, convert, convert, convert, getCardinality, getComponent, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, itemAt, iterate, process, setTypeLabel, subsequence
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, reduce
public static final FloatValue ZERO
public static final FloatValue NEGATIVE_ZERO
public static final FloatValue ONE
public static final FloatValue NaN
public FloatValue(float value)
value
- the value of the floatpublic FloatValue(float value, AtomicType type)
value
- the value of the NumericValuetype
- the type of the value. This must be a subtype of xs:float, and the
value must conform to this type. The method does not check these conditions.public AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType
in class AtomicValue
typeLabel
- the type label of the new copy. The caller is responsible for checking that
the value actually conforms to this type.public BuiltInAtomicType getPrimitiveType()
getPrimitiveType
in class AtomicValue
public float getFloatValue()
getFloatValue
in class NumericValue
public double getDoubleValue()
NumericValue
getDoubleValue
in class NumericValue
public int hashCode()
hashCode
in class NumericValue
NumericValue.hashCode()
public boolean isNaN()
isNaN
in class AtomicValue
public boolean effectiveBooleanValue()
effectiveBooleanValue
in class AtomicValue
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, ConversionRules rules)
convertPrimitive
in class AtomicValue
requiredType
- an integer identifying the required atomic typerules
- validate
- true if validation is required. If set to false, the caller guarantees that
the value is valid for the target data type, and that further validation
is therefore not required.
Note that a validation failure may be reported even if validation was not requested.public CharSequence getPrimitiveStringValue()
getPrimitiveStringValue
in class AtomicValue
public CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in class Value
static CharSequence floatToString(float value)
value
- the actual valuepublic NumericValue negate()
negate
in class NumericValue
public NumericValue floor()
floor
in class NumericValue
public NumericValue ceiling()
ceiling
in class NumericValue
public NumericValue round(int scale)
round
in class NumericValue
public NumericValue roundHalfToEven(int scale)
roundHalfToEven
in class NumericValue
scale
- the decimal position for rounding: e.g. 2 rounds to a
multiple of 0.01, while -2 rounds to a multiple of 100public double signum()
signum
in class NumericValue
public boolean isWholeNumber()
isWholeNumber
in class NumericValue
public NumericValue abs()
abs
in class NumericValue
public int compareTo(Object other)
NumericValue
compareTo
in interface Comparable
compareTo
in class NumericValue
other
- The other numeric valuepublic int compareTo(long other)
compareTo
in class NumericValue
other
- the value to be compared withpublic Comparable getSchemaComparable()
getSchemaComparable
in class AtomicValue
public boolean isIdentical(Value v)
Note that even this check ignores the type annotation of the value. The integer 3 and the short 3 are considered identical, even though they are not fully interchangeable. "Identical" means the same point in the value space, regardless of type annotation.
NaN is identical to itself.
isIdentical
in class AtomicValue
v
- the other value to be compared with this one