com.tailf.jnc

Class YangString

java.lang.Object

com.tailf.jnc.YangBaseString

com.tailf.jnc.YangString

All Implemented Interfaces:

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

public class YangString
extends YangBaseString

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

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
YangString(java.lang.String value) Creates a YangString object from a java.lang.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.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
boolean	equals(java.lang.Object obj) Compares this object with another object for equality.
T	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.tailf.jnc.YangBaseString

cloneShallow, exact, fromString, max, min, pattern, pattern, setValue, wsCollapse, wsReplace

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

YangString

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

Creates a YangString object from a java.lang.String.

Parameters:

value - The Java String.

Throws:

YangException - If an invariant was broken during assignment.

Method Detail

canEqual

public boolean canEqual(java.lang.Object obj)

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

Specified by:

canEqual in interface YangType<java.lang.String>

Overrides:

canEqual in class YangBaseString

Parameters:

obj - Object to compare type with.

Returns:

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

getValue

public T getValue()

Specified by:

getValue in interface YangType<T>

Returns:

The value of this object.

check

public void check()
           throws YangException

Description copied from interface: YangType

Checks that the value of this object is not null. Called in constructors and value setters. Subclasses that have state invariants should extend this method and throw a YangException if such an invariant has been violated.

Specified by:

check in interface YangType<T>

Throws:

YangException - If the value of this object is null.

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.