com.tailf.jnc

Class YangBinary

java.lang.Object

com.tailf.jnc.YangBinary

All Implemented Interfaces:

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

public class YangBinary
extends java.lang.Object

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

Author:

emil@tail-f.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	value The value of this object, of which this class is a wrapper for.

Constructor Summary

Constructors

Constructor and Description
YangBinary(byte[] buffer) Creates a YangBinary object from a base 64 encoded byte buffer.
YangBinary(java.lang.String value) Creates a YangBinary 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() Nop method provided because this class extends the YangBaseType class.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
protected YangBinary	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(int numberOfBytes) Checks that the value buffer of this object has the specified number of octets/bytes.
protected java.lang.String	fromString(java.lang.String s) Identity method provided because this class extends the YangBaseType class.
T	getValue()
int	hashCode()
protected void	max(int numberOfBytes) Checks that the value buffer of this object has more than the specified number of octets/bytes.
protected void	min(int numberOfBytes) Checks that the value buffer of this object has less than the specified number of octets/bytes.
void	setValue(byte[] buffer) Sets the value of this object by copying a base 64 encoded byte buffer.
void	setValue(java.lang.String value) Sets the value of this object using a String.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected T value

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

Constructor Detail

YangBinary

public YangBinary(java.lang.String value)
           throws YangException

Creates a YangBinary object from a String. The string is whitespace collapsed before it is encoded.

Parameters:

value - the String

Throws:

YangException - if setValue(value) does

YangBinary

public YangBinary(byte[] buffer)

Creates a YangBinary object from a base 64 encoded byte buffer. No checks are performed to confirm that the buffer is actually encoded in base 64.

Parameters:

buffer - The base 64 encoded byte buffer

Method Detail

setValue

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

Sets the value of this object using a String. The string is whitespace collapsed before it is encoded.

Specified by:

setValue in interface YangType<java.lang.String>

Parameters:

value - The string

Throws:

YangException - If the input is not valid Base64 encoded data.

setValue

public void setValue(byte[] buffer)

Sets the value of this object by copying a base 64 encoded byte buffer. No checks are performed to confirm that the buffer is actually encoded in base 64.

Parameters:

buffer - The base 64 encoded byte buffer.

check

public void check()
           throws YangException

Nop method provided because this class extends the YangBaseType class.

Specified by:

check in interface YangType<java.lang.String>

Throws:

YangException - If the value of this object is null.

toString

public java.lang.String toString()

Returns:

The decoded value of this object, as a String.

fromString

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

Identity method provided because this class extends the YangBaseType class.

Parameters:

s - A string.

Returns:

s.

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.

Parameters:

obj - Object to compare type with.

Returns:

true if obj is an instance of YangBinary; false otherwise.

cloneShallow

protected YangBinary cloneShallow()
                           throws YangException

Clones this object without cloning its value.

Returns:

A shallow clone of this object.

Throws:

YangException

exact

protected void exact(int numberOfBytes)
              throws YangException

Checks that the value buffer of this object has the specified number of octets/bytes.

Parameters:

len - The number of octets/bytes to check for.

Throws:

YangException - If value buffer does not have len number of octets/bytes.

min

protected void min(int numberOfBytes)
            throws YangException

Checks that the value buffer of this object has less than the specified number of octets/bytes.

Parameters:

len - The number of octets/bytes to compare against.

Throws:

YangException - If value buffer does not have less than len number of octets/bytes.

max

protected void max(int numberOfBytes)
            throws YangException

Checks that the value buffer of this object has more than the specified number of octets/bytes.

Parameters:

len - The number of octets/bytes to compare against.

Throws:

YangException - If value buffer does not have more than len number of octets/bytes.

getValue

public T getValue()

Specified by:

getValue in interface YangType<T>

Returns:

The value of this object.

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.