Package org.ow2.authzforce.core.pdp.api.value

Class DoubleValue

java.lang.Object

org.ow2.authzforce.core.pdp.api.value.SimpleValue<V>

org.ow2.authzforce.core.pdp.api.value.StringParseableValue<N>

org.ow2.authzforce.core.pdp.api.value.NumericValue<Double,DoubleValue>

org.ow2.authzforce.core.pdp.api.value.DoubleValue

All Implemented Interfaces:

Comparable<DoubleValue>, AttributeValue, PrimitiveValue, Value

public final class DoubleValue
extends NumericValue<Double,DoubleValue>
implements Comparable<DoubleValue>

Representation of an xs:double value. This class supports parsing xs:double values. All objects of this class are immutable and all methods of the class are thread-safe. The choice of the Java type Double is based on JAXB schema-to-Java mapping spec: https://docs.oracle.com/javase/tutorial/jaxb/intro/bind.html

Version:

$Id: $

Nested Class Summary

Nested classes/interfaces inherited from class org.ow2.authzforce.core.pdp.api.value.StringParseableValue

StringParseableValue.Factory<AV extends AttributeValue>

Nested classes/interfaces inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

SimpleValue.BaseFactory<AV extends AttributeValue>

Field Summary

Fields

Modifier and Type	Field	Description
static DoubleValue	ZERO	Value zero

Fields inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

value

Constructor Summary

Constructors

Constructor	Description
DoubleValue(Double value)	Creates a new DoubleAttributeValue that represents the double value supplied.
DoubleValue(String val)	Creates instance from string according to xsd:double definition

Method Summary

Modifier and Type	Method	Description
DoubleValue	abs()	Returns the absolute value of this.
DoubleValue	add(Deque<? extends DoubleValue> others)	Adds numbers to this.
int	compareTo(DoubleValue o)
DoubleValue	divide(DoubleValue divisor)	Divide this by some other number.
DoubleValue	floor()	floor
long	longValue()	Converts this double value to a long, as specified by Double.longValue()
DoubleValue	multiply(Deque<? extends DoubleValue> others)	Multiply this by other numbers.
String	printXML()	Converts the internal value (accessible via SimpleValue.getUnderlyingValue() to a valid lexical representation for XML marshalling.
DoubleValue	roundIEEE754Default()	Rounds the double using default IEEE754 rounding mode .
DoubleValue	subtract(DoubleValue subtractedVal)	Subtract a number from this.

Methods inherited from class org.ow2.authzforce.core.pdp.api.value.StringParseableValue

getXmlAttributes

Methods inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

equals, getContent, getUnderlyingValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final DoubleValue ZERO

Value zero

Constructor Detail

DoubleValue

public DoubleValue(Double value)

Creates a new DoubleAttributeValue that represents the double value supplied.

Parameters:

value - the double value to be represented

DoubleValue

public DoubleValue(String val)
            throws NumberFormatException

Creates instance from string according to xsd:double definition

Parameters:

val - A string containing lexical representation of xsd:double

Throws:

NumberFormatException - val is not a valid string representation of a double value

Method Detail

compareTo

public int compareTo(DoubleValue o)

Specified by:

compareTo in interface Comparable<DoubleValue>

abs

public DoubleValue abs()

Returns the absolute value of this. Used by the XACML "abs" functions.

Specified by:

abs in class NumericValue<Double,DoubleValue>

Returns:

the absolute value

add

public DoubleValue add(Deque<? extends DoubleValue> others)

Adds numbers to this. Used by the XACML numeric *-add functions.

Specified by:

add in class NumericValue<Double,DoubleValue>

Parameters:

others - values to add to this value

Returns:

sum of this and the others.

multiply

public DoubleValue multiply(Deque<? extends DoubleValue> others)

Multiply this by other numbers. Used by the XACML "multiply" functions.

Specified by:

multiply in class NumericValue<Double,DoubleValue>

Parameters:

others - other values to multiply by

Returns:

product of this by the others

divide

public DoubleValue divide(DoubleValue divisor)
                   throws ArithmeticException

Divide this by some other number. Used by XACML *-divide functions.

Specified by:

divide in class NumericValue<Double,DoubleValue>

Parameters:

divisor - number by which this is divided

Returns:

the result quotient

Throws:

ArithmeticException - if divisor is zero

floor

public DoubleValue floor()

floor

Returns:

result of Math#floor(double) as AttributeValue

See Also:

Math.floor(double)

roundIEEE754Default

public DoubleValue roundIEEE754Default()

Rounds the double using default IEEE754 rounding mode . According to XACML core spec, §7.5 Arithmetic evaluation, "rounding - is set to round-half-even (IEEE 854 §4.1)" ( RoundingMode.HALF_EVEN). This method uses Math.rint(double) that does the equivalent of the RoundingMode.HALF_EVEN.

Returns:

result of Math#rint(double) as AttributeValue

subtract

public DoubleValue subtract(DoubleValue subtractedVal)

Subtract a number from this. Used by XACML numeric *-subtract functions.

Specified by:

subtract in class NumericValue<Double,DoubleValue>

Parameters:

subtractedVal - value to be subtracted from this

Returns:

this - subtractedVal

longValue

public long longValue()

Converts this double value to a long, as specified by Double.longValue()

Returns:

this as an integer

printXML

public String printXML()

Converts the internal value (accessible via SimpleValue.getUnderlyingValue() to a valid lexical representation for XML marshalling. Equivalent to the 'printMethod' in JAXB 'javaType' binding customizations. Implementations of this typically call DatatypeConverter. This method is called by SimpleValue.getContent() and its result cached by the same method for later use. Therefore, no need to cache the result in the implementation.

Specified by:

printXML in class SimpleValue<Double>

Returns:

XML-valid lexical representation.