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| 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
|
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
|
boolean |
effectiveBooleanValue()
Get the effective boolean value
|
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.
|
BigDecimal |
getDecimalValue()
Get the numeric value converted to a decimal
|
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(AtomicValue 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
|
long |
longValue()
Return the numeric value as a Java long.
|
static FloatValue |
makeFloatValue(float value)
Static factory method (for convenience in compiled bytecode)
|
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
|
int |
signum()
Determine whether the value is negative, zero, or positive
|
equals, getXPathComparable, isInteger, parseNumber, toStringasAtomic, checkPermittedContents, getCardinality, getComponent, getItemType, getStringValue, getStringValueCS, head, isIdentical, itemAt, iterate, process, setTypeLabelgetLength, reduce, subsequenceclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetLengthreduce, subsequencepublic 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 static FloatValue makeFloatValue(float value)
value - the value of the floatpublic AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType in class AtomicValuetypeLabel - 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 AtomicValuepublic float getFloatValue()
getFloatValue in class NumericValuepublic double getDoubleValue()
NumericValuegetDoubleValue in class NumericValuepublic BigDecimal getDecimalValue() throws XPathException
getDecimalValue in class NumericValueXPathException - if the value cannot be converted, for example if it is NaN or infinitepublic long longValue()
throws XPathException
longValue in class NumericValueXPathException - if the value cannot be convertedpublic int hashCode()
hashCode in class NumericValueNumericValue.hashCode()public boolean isNaN()
isNaN in class AtomicValuepublic boolean effectiveBooleanValue()
effectiveBooleanValue in interface GroundedValueeffectiveBooleanValue in class AtomicValuepublic CharSequence getPrimitiveStringValue()
getPrimitiveStringValue in class AtomicValuepublic CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation in interface AtomicSequencegetCanonicalLexicalRepresentation in class AtomicValuepublic static CharSequence floatToString(float value)
value - the actual valuepublic NumericValue negate()
negate in class NumericValuepublic NumericValue floor()
floor in class NumericValuepublic NumericValue ceiling()
ceiling in class NumericValuepublic NumericValue round(int scale)
round in class NumericValuepublic NumericValue roundHalfToEven(int scale)
roundHalfToEven in class NumericValuescale - the decimal position for rounding: e.g. 2 rounds to a
multiple of 0.01, while -2 rounds to a multiple of 100public int signum()
signum in class NumericValuepublic boolean isWholeNumber()
isWholeNumber in class NumericValuepublic NumericValue abs()
abs in class NumericValuepublic int compareTo(Object other)
NumericValuecompareTo in interface ComparablecompareTo in class NumericValueother - The other numeric valuepublic int compareTo(long other)
compareTo in class NumericValueother - the value to be compared withpublic Comparable getSchemaComparable()
getSchemaComparable in interface AtomicSequencegetSchemaComparable in class AtomicValuepublic boolean isIdentical(AtomicValue 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 AtomicValuev - the other value to be compared with this oneCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.