com.tailf.jnc

Class YangUInt8

java.lang.Object

com.tailf.jnc.YangInt16

com.tailf.jnc.YangUInt8

All Implemented Interfaces:

YangType<java.lang.Short>, java.io.Serializable

public class YangUInt8
extends YangInt16

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

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
YangUInt8(java.lang.Number value) Creates a YangUInt8 object from a Number.
YangUInt8(java.lang.String s) Creates a YangUInt8 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 is not null and valid.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
protected YangUInt8	cloneShallow() Clones this object without cloning its value.
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.
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.String s) 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 com.tailf.jnc.YangInt16

decode

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

YangUInt8

public YangUInt8(java.lang.String s)
          throws YangException

Creates a YangUInt8 object from a String.

Parameters:

s - The string.

Throws:

YangException - If value could not be parsed from s or if the parsed value is negative or larger than 0xff.

YangUInt8

public YangUInt8(java.lang.Number value)
          throws YangException

Creates a YangUInt8 object from a Number. This may involve rounding or truncation.

Parameters:

value - The initial value of the new YangUInt8 object.

Throws:

YangException - If value is negative or larger than 0xff.

Method Detail

cloneShallow

protected YangUInt8 cloneShallow()
                          throws YangException

Clones this object without cloning its value.

Overrides:

cloneShallow in class YangInt16

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.

check

public void check()
           throws YangException

Checks that the value of this object is not null and valid. Called in constructors and value setters. Subclasses that have state invariants in addition to those handled by the YangBaseInt.valid(java.lang.Number) method should override this method and throw a YangException if such an invariant has been violated.

Specified by:

check in interface YangType<T extends java.lang.Number>

Throws:

YangException - If the value of this object is null or invalid.

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.

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.

Parameters:

obj - Object to compare type with.

Returns:

true if obj type is compatible; false otherwise.

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(java.lang.String s)
              throws YangException

Description copied from interface: YangType

Sets the value of this object using a String.

Specified by:

setValue in interface YangType<T>

Parameters:

s - A string containing the new value to set.

Throws:

YangException - If an invariant was broken during assignment, or if value could not be parsed from s.

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The value of this object, as a String.

equals

public boolean equals(java.lang.Object obj)

Compares this object with another object for equality.

Overrides:

equals in class java.lang.Object

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()

Overrides:

hashCode in class java.lang.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.