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 |
NaN_MATCH_KEY, 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
|
AtomicMatchKey |
asMapKey()
Get a value whose equals() method follows the "same key" rules for comparing the keys of a map.
|
int |
asSubscript()
Test whether a number is a possible subscript into a sequence, that is,
a whole number greater than zero and less than 2^31
|
NumericValue |
ceiling()
Implement the XPath ceiling() function
|
int |
compareTo(long other)
Compare the value to a long
|
int |
compareTo(java.lang.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 java.lang.CharSequence |
floatToString(float value)
Internal method used for conversion of a float to a string
|
NumericValue |
floor()
Implement the XPath floor() function
|
java.lang.CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
|
java.math.BigDecimal |
getDecimalValue()
Get the numeric value converted to a decimal
|
double |
getDoubleValue()
Get the numeric value as a double
|
float |
getFloatValue()
Get the value
|
java.lang.CharSequence |
getPrimitiveStringValue()
Get the value as a String
|
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value.
|
java.lang.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 |
isNegativeZero()
Ask whether this value is negative zero
|
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, toString
asAtomic, atomize, checkPermittedContents, checkValidInJavascript, getCardinality, getComponent, getItemType, getStringValue, getStringValueCS, getUType, head, identityHashCode, isIdentical, itemAt, iterate, iterator, process, setTypeLabel
getLength, isStreamed, reduce, subsequence
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asAtomic
getLength
reduce, subsequence
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 static FloatValue makeFloatValue(float value)
value
- the value of the floatpublic 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 java.math.BigDecimal getDecimalValue() throws ValidationException
getDecimalValue
in class NumericValue
ValidationException
- if the value cannot be converted, for example if it is NaN or infinitepublic long longValue() throws XPathException
longValue
in class NumericValue
XPathException
- if the value cannot be convertedpublic int hashCode()
hashCode
in class NumericValue
NumericValue.hashCode()
public boolean isNaN()
isNaN
in class AtomicValue
public boolean effectiveBooleanValue()
effectiveBooleanValue
in interface GroundedValue
effectiveBooleanValue
in class AtomicValue
public java.lang.CharSequence getPrimitiveStringValue()
getPrimitiveStringValue
in class AtomicValue
public java.lang.CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in interface AtomicSequence
getCanonicalLexicalRepresentation
in class AtomicValue
public static java.lang.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
scale
- the number of decimal places required in the result (supply 0 for rounding to an integer)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 int signum()
signum
in class NumericValue
public boolean isNegativeZero()
isNegativeZero
in class NumericValue
public boolean isWholeNumber()
isWholeNumber
in class NumericValue
public int asSubscript()
asSubscript
in class NumericValue
public NumericValue abs()
abs
in class NumericValue
public int compareTo(java.lang.Object other)
NumericValue
compareTo
in interface java.lang.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 java.lang.Comparable getSchemaComparable()
getSchemaComparable
in interface AtomicSequence
getSchemaComparable
in class AtomicValue
public AtomicMatchKey asMapKey()
asMapKey
in class AtomicValue
public 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 AtomicValue
v
- the other value to be compared with this oneCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.