com.tailf.jnc

Class YangIdentityref

java.lang.Object

com.tailf.jnc.YangIdentityref

All Implemented Interfaces:

YangType<Element>, java.io.Serializable

public class YangIdentityref
extends java.lang.Object

Implements the built-in YANG data type "identityref". FIXME add toString

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
YangIdentityref(Element identity) Creates a YangIdentityref object from an Element.
YangIdentityref(java.lang.String s) Creates a YangIdentityref object from a String, formatted as described in fromString(String).
YangIdentityref(java.lang.String ns, java.lang.String prefix, java.lang.String id) Creates a YangIdentityref object from three strings: identity namespace, prefix and argument/identifier.

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.
protected YangIdentityref	cloneShallow() Clones this object without cloning its value.
boolean	equals(java.lang.Object obj) Compares this object with another object for equality.
protected Element	fromString(java.lang.String s) Returns an identity element from a String.
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

YangIdentityref

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

Creates a YangIdentityref object from a String, formatted as described in fromString(String).

Parameters:

s - The string.

Throws:

YangException - If s is improperly formatted.

YangIdentityref

public YangIdentityref(Element identity)
                throws YangException

Creates a YangIdentityref object from an Element.

Parameters:

identity - The initial value of the new YangIdentityref object.

Throws:

YangException - If an invariant was broken during initialization.

YangIdentityref

public YangIdentityref(java.lang.String ns,
                       java.lang.String prefix,
                       java.lang.String id)
                throws YangException

Creates a YangIdentityref object from three strings: identity namespace, prefix and argument/identifier.

Parameters:

ns - identity module namespace

prefix - identity module prefix

id - identity argument/identifier

Throws:

YangException - If an invariant was broken during initialization.

Method Detail

fromString

protected Element fromString(java.lang.String s)

Returns an identity element from a String.

Parameters:

s - The string.

Returns:

An Element representing the referenced identity, parsed from s.

canEqual

public boolean canEqual(java.lang.Object obj)

Description copied from interface: YangType

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 type is compatible; false otherwise.

cloneShallow

protected YangIdentityref 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.

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.