com.tailf.jnc

Class YangBoolean

java.lang.Object

com.tailf.jnc.YangBoolean

All Implemented Interfaces:

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

public class YangBoolean
extends java.lang.Object

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

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
YangBoolean(boolean b) Creates a YangBoolean object from a boolean.
YangBoolean(java.lang.String s) Creates a YangBoolean 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 YangBoolean	cloneShallow() Clones this object without cloning its value.
boolean	equals(java.lang.Object obj) Compares this object with another object for equality.
protected java.lang.Boolean	fromString(java.lang.String s) Works much like Boolean.parseBoolean, except that case matters, s is trimmed with wsCollapse prior to parsing, and an exception is thrown if the trimmed string is neither "true" nor "false".
T	getValue()
int	hashCode()
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()

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

YangBoolean

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

Creates a YangBoolean object from a String.

Parameters:

s - The string.

Throws:

YangException - If value is not one of "true" or "false".

YangBoolean

public YangBoolean(boolean b)
            throws YangException

Creates a YangBoolean object from a boolean.

Parameters:

b - The boolean to set the value of the new YangBoolean to.

Throws:

YangException - Never.

Method Detail

fromString

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

Works much like Boolean.parseBoolean, except that case matters, s is trimmed with wsCollapse prior to parsing, and an exception is thrown if the trimmed string is neither "true" nor "false".

Parameters:

s - The String.

Returns:

true if s matches " *true *", false if s matches " *false *".

Throws:

YangException - if s does not match a valid boolean value

check

public void check()
           throws YangException

Nop method provided because this class extends the YangBaseType class.

Specified by:

check in interface YangType<java.lang.Boolean>

Throws:

YangException - If the value of this object is null.

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 YangBoolean or java.lang.Boolean; false otherwise.

cloneShallow

protected YangBoolean cloneShallow()
                            throws YangException

Clones this object without cloning its value.

Returns:

A shallow clone of this object.

Throws:

YangException

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.