com.tailf.jnc

Class YangDecimal64

java.lang.Object

com.tailf.jnc.YangDecimal64

All Implemented Interfaces:

YangType<java.math.BigDecimal>, java.io.Serializable

public class YangDecimal64
extends java.lang.Object

Implements the built-in YANG data type "decimal64".

Author:

emil@tail-f.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.math.BigDecimal	MAX_VALUE An upper bound for the value of this object, or null if none.
protected java.math.BigDecimal	MIN_VALUE A lower bound for the value of this object, or null if none.
protected T	value The value of this object, of which this class is a wrapper for.

Constructor Summary

Constructors

Constructor and Description
YangDecimal64(java.lang.Number n, int fractionDigits) Creates a YangDecimal64 object from a Number.
YangDecimal64(java.lang.String s, int fractionDigits) Creates a YangDecimal64 object from a String.

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(java.lang.Object obj) Compares type of obj with this object to see if they can be equal.
void	check() Checks that the value of this object does not violate any invariants.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
protected YangDecimal64	cloneShallow() Clones this object without cloning its value.
protected java.math.BigDecimal	decode(java.lang.String s) Returns a value of type T given a String.
boolean	equals(java.lang.Object obj) Compares this object with another object for equality.
protected void	exact(java.lang.Number value) Checks that the value of this object equals another value.
protected T	fromString(java.lang.String s) Returns a value of type T given a String.
int	getFractionDigits()
T	getValue()
int	hashCode()
protected void	max(java.lang.Number max) Checks that the value of this object is not larger than the max-value.
protected void	min(java.lang.Number min) Checks that the value of this object is not smaller than the min-value.
protected void	setMinMax(java.lang.Number minValue, java.lang.Number maxValue) Sets the MIN_VALUE and MAX_VALUE fields of this object.
void	setValue(java.lang.Number n) Sets the value of this object using a Number.
void	setValue(java.lang.String value) Sets the value of this object using a String.
void	setValue(T value) Sets the value of this object using a value of type T.
java.lang.String	toString()
protected boolean	valid(java.lang.Number n)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VALUE

protected java.math.BigDecimal MIN_VALUE

A lower bound for the value of this object, or null if none.

MAX_VALUE

protected java.math.BigDecimal MAX_VALUE

An upper bound for the value of this object, or null if none.

value

protected T value

The value of this object, of which this class is a wrapper for.

Constructor Detail

YangDecimal64

public YangDecimal64(java.lang.String s,
                     int fractionDigits)
              throws YangException

Creates a YangDecimal64 object from a String.

Parameters:

s - The string.

fractionDigits - [1, 18], Number of decimals allowed in value.

Throws:

YangException - If value is too small or too large with regard to the number of decimals.

java.lang.NumberFormatException - If value is not a valid representation of a java.math.BigDecimal.

See Also:

BigDecimal

YangDecimal64

public YangDecimal64(java.lang.Number n,
                     int fractionDigits)
              throws YangException

Creates a YangDecimal64 object from a Number.

Parameters:

n - The Number to initialize the value of this object with.

fractionDigits - [1, 18], Number of decimals allowed in n.

Throws:

YangException - If n is too small or too large with regard to the fractionDigits argument.

Method Detail

setValue

public void setValue(java.lang.String value)
              throws YangException

Sets the value of this object using a String.

Specified by:

setValue in interface YangType<java.math.BigDecimal>

Parameters:

value - The string.

Throws:

YangException - If value is too small or too large with regard to the fractionDigits of this YangDecimal.

java.lang.NumberFormatException - If value is not a valid representation of a java.math.BigDecimal.

See Also:

BigDecimal

setValue

public void setValue(java.lang.Number n)
              throws YangException

Sets the value of this object using a Number.

Parameters:

n - The Number.

Throws:

YangException - If value is too small or too large with regard to the fractionDigits of this YangDecimal.

getFractionDigits

public int getFractionDigits()

Returns:

The fractionDigits value of this object.

toString

public java.lang.String toString()

Returns:

The value of this object, as a String.

check

public void check()
           throws YangException

Checks that the value of this object does not violate any invariants.

Specified by:

check in interface YangType<java.math.BigDecimal>

Throws:

YangException - If fractionDigits is not in [1, 18] or if value of this object is not in [minValue, maxValue].

decode

protected java.math.BigDecimal decode(java.lang.String s)
                               throws java.lang.NumberFormatException

Returns a value of type T given a String. No implementation should use this.value - this method would be static if Java allowed for abstract static classes.

Parameters:

s - A string representation of a value of type T.

Returns:

A T value parsed from s.

Throws:

java.lang.NumberFormatException - If unable to parse a value of type T.

canEqual

public boolean canEqual(java.lang.Object obj)

Compares type of obj with this object to see if they can be equal.

If a subclass of this class overrides the equals method, this method should be overridden as well.

Specified by:

canEqual in interface YangType<java.math.BigDecimal>

Parameters:

obj - Object to compare type with.

Returns:

true if obj type is compatible; false otherwise.

equals

public boolean equals(java.lang.Object obj)

Compares this object with another object for equality.

Parameters:

obj - The object to compare with.

Returns:

true if obj can be cast to a comparable type and the value of this object is equal to the value of obj; false otherwise.

hashCode

public int hashCode()

cloneShallow

protected YangDecimal64 cloneShallow()
                              throws YangException

Clones this object without cloning its value.

Returns:

A shallow clone of this object.

Throws:

YangException

setMinMax

protected void setMinMax(java.lang.Number minValue,
                         java.lang.Number maxValue)
                  throws YangException

Sets the MIN_VALUE and MAX_VALUE fields of this object.

Parameters:

minValue - value to set MIN_VALUE to.

maxValue - value to set MAX_VALUE to.

Throws:

YangException - If minValue is larger than maxValue.

valid

protected boolean valid(java.lang.Number n)

Parameters:

n - A number to check for validity.

Returns:

true if n is within this object's value domain; false otherwise.

fromString

protected final T fromString(java.lang.String s)
                      throws YangException

Returns a value of type T given a String.

Note: This method is non-static since T is a non-static type.

Parameters:

s - A string representation of a value of type T.

Returns:

A T value parsed from s (not this.value!).

Throws:

YangException - If s does not contain a parsable T.

exact

protected void exact(java.lang.Number value)
              throws YangException

Checks that the value of this object equals another value.

Parameters:

value - The value to compare against.

Throws:

YangException - If comparison does not evaluate to true or if the value argument is not YangBaseInt.valid(java.lang.Number).

min

protected void min(java.lang.Number min)
            throws YangException

Checks that the value of this object is not smaller than the min-value.

Parameters:

min - The min-value to compare against.

Throws:

YangException - If value is smaller than min or min is invalid.

max

protected void max(java.lang.Number max)
            throws YangException

Checks that the value of this object is not larger than the max-value.

Parameters:

max - The max-value to compare against.

Throws:

YangException - If value is larger than max or max is invalid.

setValue

public void setValue(T value)
              throws YangException

Description copied from interface: YangType

Sets the value of this object using a value of type T.

Specified by:

setValue in interface YangType<T>

Parameters:

value - The new value to set.

Throws:

YangException - If an invariant was broken during assignment.

getValue

public T getValue()

Specified by:

getValue in interface YangType<T>

Returns:

The value of this object.

clone

public com.tailf.jnc.YangBaseType<T> clone()

Description copied from interface: YangType

Clones this object and its value.

Specified by:

clone in interface YangType<T>

Overrides:

clone in class java.lang.Object

Returns:

A deep clone of this object.