java.io.Serializable
, PullEvent
, SequenceIterable
, GroundedValue
, Item
, ValueRepresentation
, ConversionResult
public final class FloatValue extends NumericValue
Modifier and Type | Field | Description |
---|---|---|
static FloatValue |
NaN |
|
static FloatValue |
NEGATIVE_ZERO |
|
static FloatValue |
ONE |
|
static FloatValue |
ZERO |
typeLabel
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
EMPTY_VALUE_ARRAY
Constructor | 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.
|
FloatValue(java.lang.CharSequence val) |
Constructor supplying a string
|
Modifier and Type | Method | Description |
---|---|---|
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
|
ConversionResult |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context) |
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
|
NumericValue |
floor() |
Implement the XPath floor() function
|
java.lang.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
|
BuiltInAtomicType |
getPrimitiveType() |
Determine the primitive type of the value.
|
java.lang.Comparable |
getSchemaComparable() |
Get an object that implements XML Schema comparison semantics
|
java.lang.String |
getStringValue() |
Get the value as a String
|
java.lang.CharSequence |
getStringValueCS() |
Get the value as a String
|
int |
hashCode() |
Get the hashCode.
|
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() |
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
|
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getTypedValue, getTypeLabel, itemAt, iterate, process, setTypeLabel, subsequence
equals, getDecimalValue, getXPathComparable, isInteger, longValue, parseNumber, promote, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, makeQNameValue, reduce, stringToNumber
public static final FloatValue ZERO
public static final FloatValue NEGATIVE_ZERO
public static final FloatValue ONE
public static final FloatValue NaN
public FloatValue(java.lang.CharSequence val) throws ValidationException
ValidationException
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, XPathContext context)
convertPrimitive
in class AtomicValue
requiredType
- an integer identifying the required atomic typecontext
- XPath dynamic context. Not used when converting from floatvalidate
- 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 java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface ValueRepresentation
getStringValue
in class AtomicValue
Item.getStringValueCS()
public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
getStringValueCS
in interface ValueRepresentation
getStringValueCS
in class AtomicValue
Item.getStringValue()
public java.lang.CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in class Value
public NumericValue negate()
negate
in class NumericValue
public NumericValue floor()
floor
in class NumericValue
public NumericValue ceiling()
ceiling
in class NumericValue
public NumericValue round()
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 int compareTo(java.lang.Object other)
NumericValue
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 class AtomicValue