org.opendaylight.yangtools.yang.common

Class Decimal64

java.lang.Object

java.lang.Number

org.opendaylight.yangtools.yang.common.Decimal64

All Implemented Interfaces:

Serializable, Comparable<Decimal64>, Immutable, MutationBehaviour<Immutable>, CanonicalValue<Decimal64>

@Beta
 @NonNullByDefault
public class Decimal64
extends Number
implements CanonicalValue<Decimal64>

Dedicated type for YANG's 'type decimal64' type. This class is similar to BigDecimal, but provides more efficient storage, as it has fixed precision.

Author:

Robert Varga

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Decimal64.Support

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Decimal64(Decimal64 other)

Method Summary

Modifier and Type	Method and Description
byte	byteValueExact() Converts this BigDecimal to a byte, checking for lost information.
int	compareTo(Decimal64 o)
BigDecimal	decimalValue()
double	doubleValue()
boolean	equals(@Nullable Object obj)
float	floatValue()
int	hashCode()
int	intValue()
int	intValueExact() Converts this BigDecimal to an int, checking for lost information.
long	longValue()
long	longValueExact() Converts this BigDecimal to a long, checking for lost information.
short	shortValueExact() Converts this BigDecimal to a short, checking for lost information.
CanonicalValueSupport<Decimal64>	support() Return the CanonicalValue associated with this type.
String	toCanonicalString() Return the canonical string representation of this value.
String	toString()
static Decimal64	valueOf(BigDecimal decimalVal)
static Decimal64	valueOf(byte byteVal)
static Decimal64	valueOf(double doubleVal)
static Decimal64	valueOf(int intVal)
static Decimal64	valueOf(long longVal)
static Decimal64	valueOf(short shortVal)
static Decimal64	valueOf(String str) Attempt to parse a String into a Decimal64.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.common.CanonicalValue

validator

Constructor Detail

Decimal64

protected Decimal64(Decimal64 other)

Method Detail

valueOf

public static Decimal64 valueOf(byte byteVal)

valueOf

public static Decimal64 valueOf(short shortVal)

valueOf

public static Decimal64 valueOf(int intVal)

valueOf

public static Decimal64 valueOf(long longVal)

valueOf

public static Decimal64 valueOf(double doubleVal)

valueOf

public static Decimal64 valueOf(BigDecimal decimalVal)

valueOf

public static Decimal64 valueOf(String str)

Attempt to parse a String into a Decimal64. This method uses minimum fraction digits required to hold the entire value.

Parameters:

str - String to parser

Returns:

A Decimal64 instance

Throws:

NullPointerException - if value is null.

NumberFormatException - if the string does not contain a parsable decimal64.

decimalValue

public final BigDecimal decimalValue()

intValue

public final int intValue()

Specified by:

intValue in class Number

longValue

public final long longValue()

Specified by:

longValue in class Number

floatValue

public final float floatValue()

Specified by:

floatValue in class Number

doubleValue

public final double doubleValue()

Specified by:

doubleValue in class Number

byteValueExact

public final byte byteValueExact()

Converts this BigDecimal to a byte, checking for lost information. If this Decimal64 has a nonzero fractional part or is out of the possible range for a byte result then an ArithmeticException is thrown.

Returns:

this Decimal64 converted to a byte.

Throws:

ArithmeticException - if this has a nonzero fractional part, or will not fit in a byte.

shortValueExact

public final short shortValueExact()

Converts this BigDecimal to a short, checking for lost information. If this Decimal64 has a nonzero fractional part or is out of the possible range for a short result then an ArithmeticException is thrown.

Returns:

this Decimal64 converted to a short.

Throws:

ArithmeticException - if this has a nonzero fractional part, or will not fit in a short.

intValueExact

public final int intValueExact()

Converts this BigDecimal to an int, checking for lost information. If this Decimal64 has a nonzero fractional part or is out of the possible range for an int result then an ArithmeticException is thrown.

Returns:

this Decimal64 converted to an int.

Throws:

ArithmeticException - if this has a nonzero fractional part, or will not fit in an int.

longValueExact

public final long longValueExact()

Converts this BigDecimal to a long, checking for lost information. If this Decimal64 has a nonzero fractional part then an ArithmeticException is thrown.

Returns:

this Decimal64 converted to a long.

Throws:

ArithmeticException - if this has a nonzero fractional part.

compareTo

public final int compareTo(Decimal64 o)

Specified by:

compareTo in interface Comparable<Decimal64>

toCanonicalString

public final String toCanonicalString()

Description copied from interface: CanonicalValue

Return the canonical string representation of this value.

Specified by:

toCanonicalString in interface CanonicalValue<Decimal64>

Returns:

Canonical string

support

public final CanonicalValueSupport<Decimal64> support()

Description copied from interface: CanonicalValue

Return the CanonicalValue associated with this type. It can be used to create new instances of this representation.

Specified by:

support in interface CanonicalValue<Decimal64>

Returns:

A CanonicalValue instance.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object