Package org.eclipse.wst.xml.xpath2.processor.internal.types


org.eclipse.wst.xml.xpath2.processor.internal.types
Class XSFloat



public class XSFloat
extends org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType
A representation of the Float datatype

Constructor Summary

XSFloat(float x)
XSFloat()
XSFloat(java.lang.String init)

Method Summary

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTypeabs()
     Absolutes the number stored
public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTypeceiling()
     Returns the smallest integer greater than the number stored
public org.eclipse.wst.xml.xpath2.api.ResultSequenceconstructor(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Creates a new ResultSequence consisting of the retrievable float in the supplied ResultSequence
protected org.eclipse.wst.xml.xpath2.api.ItemconvertArg(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg)
    
public org.eclipse.wst.xml.xpath2.api.ResultSequencediv(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical division operator between this XSFloat and the supplied ResultSequence.
public booleaneq(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType aa , org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)
     Equality comparison between this number and the supplied representation.
public floatfloat_value()
     Retrieves the actual float value stored
public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTypefloor()
     Returns the largest integer smaller than the number stored
public java.lang.ObjectgetNativeValue()
    
public java.lang.StringgetStringValue()
     Retrieves a String representation of the stored number
public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinitiongetTypeDefinition()
    
public booleangt(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg , org.eclipse.wst.xml.xpath2.api.DynamicContext context)
     Comparison between this number and the supplied representation.
public org.eclipse.wst.xml.xpath2.api.ResultSequenceidiv(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical integer division operator between this XSFloat and the supplied ResultSequence.
public booleaninfinite()
     Check for whether this datatype represents negative or positive infinity
public booleanlt(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg , org.eclipse.wst.xml.xpath2.api.DynamicContext context)
     Comparison between this number and the supplied representation.
public org.eclipse.wst.xml.xpath2.api.ResultSequenceminus(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical subtraction operator between this XSFloat and the supplied ResultSequence.
public org.eclipse.wst.xml.xpath2.api.ResultSequencemod(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical modulus operator between this XSFloat and the supplied ResultSequence. Due to no numeric type promotion or conversion, the ResultSequence must be of type XSFloat.
public booleannan()
     Check for whether this datatype represents NaN
public booleannegativeZero()
    
public org.eclipse.wst.xml.xpath2.api.ResultSequenceplus(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical addition operator between this XSFloat and the supplied ResultSequence.
public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTyperound()
     Returns the closest integer of the number stored.
public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTyperound_half_to_even()
     Returns the closest integer of the number stored.
public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericTyperound_half_to_even(int precision)
     Returns the closest integer of the number stored with the specified precision.
public java.lang.Stringstring_type()
     Retrieves the datatype's full pathname
public org.eclipse.wst.xml.xpath2.api.ResultSequencetimes(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)
     Mathematical multiplication operator between this XSFloat and the supplied ResultSequence.
public java.lang.Stringtype_name()
     Retrieves the datatype's name
public org.eclipse.wst.xml.xpath2.api.ResultSequenceunary_minus()
     Negates the number stored
public booleanzero()
     Check for whether this datatype represents 0

Constructor Detail

XSFloat

public XSFloat(float x)

Initiates a representation of the supplied number


XSFloat

public XSFloat()

Initiates a representation of 0


XSFloat

public XSFloat(java.lang.String init)

Initialises using a String represented number


Methods Detail

abs

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType abs()

Absolutes the number stored

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the absolute value of the number stored


ceiling

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType ceiling()

Returns the smallest integer greater than the number stored

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the smallest integer greater than the number stored


constructor

public org.eclipse.wst.xml.xpath2.api.ResultSequence constructor(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Creates a new ResultSequence consisting of the retrievable float in the supplied ResultSequence

Parameters

arg - The ResultSequence from which to extract the float

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - New ResultSequence consisting of the float supplied

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


convertArg

protected org.eclipse.wst.xml.xpath2.api.Item convertArg(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg)

Parameters

arg

Returns

org.eclipse.wst.xml.xpath2.api.Item

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


div

public org.eclipse.wst.xml.xpath2.api.ResultSequence div(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical division operator between this XSFloat and the supplied ResultSequence.

Parameters

arg - The ResultSequence to perform a division with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat consisting of the result of the mathematical division.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


eq

public boolean eq(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType aa , org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)

Equality comparison between this number and the supplied representation.

Parameters

aa - The datatype to compare with

dynamicContext

Returns

boolean - True if the two representations are of the same number. False otherwise

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


float_value

public float float_value()

Retrieves the actual float value stored

Returns

float - The actual float value stored


floor

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType floor()

Returns the largest integer smaller than the number stored

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the largest integer smaller than the number stored


getNativeValue

public java.lang.Object getNativeValue()

Returns

java.lang.Object


getStringValue

public java.lang.String getStringValue()

Retrieves a String representation of the stored number

Returns

java.lang.String - String representation of the stored number


getTypeDefinition

public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition getTypeDefinition()

Returns

org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition


gt

public boolean gt(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg , org.eclipse.wst.xml.xpath2.api.DynamicContext context)

Comparison between this number and the supplied representation.

Parameters

arg - The datatype to compare with

context

Returns

boolean - True if the supplied representation is a smaller number than the one stored. False otherwise

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


idiv

public org.eclipse.wst.xml.xpath2.api.ResultSequence idiv(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical integer division operator between this XSFloat and the supplied ResultSequence.

Parameters

arg - The ResultSequence to perform an integer division with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSInteger consisting of the result of the mathematical integer division.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


infinite

public boolean infinite()

Check for whether this datatype represents negative or positive infinity

Returns

boolean - True is this datatype represents infinity. False otherwise


lt

public boolean lt(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg , org.eclipse.wst.xml.xpath2.api.DynamicContext context)

Comparison between this number and the supplied representation.

Parameters

arg - The datatype to compare with

context

Returns

boolean - True if the supplied representation is a greater number than the one stored. False otherwise

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


minus

public org.eclipse.wst.xml.xpath2.api.ResultSequence minus(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical subtraction operator between this XSFloat and the supplied ResultSequence.

Parameters

arg - The ResultSequence to perform a subtraction with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat consisting of the result of the mathematical subtraction.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


mod

public org.eclipse.wst.xml.xpath2.api.ResultSequence mod(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical modulus operator between this XSFloat and the supplied ResultSequence. Due to no numeric type promotion or conversion, the ResultSequence must be of type XSFloat.

Parameters

arg - The ResultSequence to perform a modulus with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat consisting of the result of the mathematical modulus.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


nan

public boolean nan()

Check for whether this datatype represents NaN

Returns

boolean - True is this datatype represents NaN. False otherwise


negativeZero

public boolean negativeZero()

Returns

boolean


plus

public org.eclipse.wst.xml.xpath2.api.ResultSequence plus(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical addition operator between this XSFloat and the supplied ResultSequence.

Parameters

arg - The ResultSequence to perform an addition with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat consisting of the result of the mathematical addition.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


round

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType round()

Returns the closest integer of the number stored.

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the closest long of the number stored.


round_half_to_even

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType round_half_to_even()

Returns the closest integer of the number stored.

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the closest long of the number stored.


round_half_to_even

public org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType round_half_to_even(int precision)

Returns the closest integer of the number stored with the specified precision.

Parameters

precision - An integer precision

Returns

org.eclipse.wst.xml.xpath2.processor.internal.types.NumericType - A XSFloat representing the closest long of the number stored.


string_type

public java.lang.String string_type()

Retrieves the datatype's full pathname

Returns

java.lang.String - "xs:float" which is the datatype's full pathname


times

public org.eclipse.wst.xml.xpath2.api.ResultSequence times(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)

Mathematical multiplication operator between this XSFloat and the supplied ResultSequence.

Parameters

arg - The ResultSequence to perform a multiplication with

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat consisting of the result of the mathematical multiplication.

Throws:

org.eclipse.wst.xml.xpath2.processor.DynamicError


type_name

public java.lang.String type_name()

Retrieves the datatype's name

Returns

java.lang.String - "float" which is the datatype's name


unary_minus

public org.eclipse.wst.xml.xpath2.api.ResultSequence unary_minus()

Negates the number stored

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A XSFloat representing the negation of the number stored


zero

public boolean zero()

Check for whether this datatype represents 0

Returns

boolean - True if this datatype represents 0. False otherwise