com.tailf.jnc

Class YangEnumeration

java.lang.Object

com.tailf.jnc.YangBaseString

com.tailf.jnc.YangEnumeration

All Implemented Interfaces:

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

public class YangEnumeration
extends YangBaseString

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

An enumeration checker method is provided.

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
YangEnumeration(java.lang.String value, java.lang.String[] enums) Creates an YangEnumeration object given an enum (as a String) and an array of the allowed enum names.

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 YangEnumeration	cloneShallow() Clones this object without cloning its value.
protected java.lang.String[]	enums() Get the allowed type names for this enumeration.
boolean	equals(java.lang.Object obj) Compares this enumeration with another object for equality.
T	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.tailf.jnc.YangBaseString

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

YangEnumeration

public YangEnumeration(java.lang.String value,
                       java.lang.String[] enums)
                throws YangException

Creates an YangEnumeration object given an enum (as a String) and an array of the allowed enum names.

Parameters:

value - The enum name

enums - The allowed type names of the enumeration.

Throws:

YangException - If an invariant was broken during assignment.

Method Detail

enums

protected java.lang.String[] enums()

Get the allowed type names for this enumeration.

Returns:

A string array with the enum names

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<java.lang.String>

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.

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 YangEnumeration or java.lang.String; false otherwise.

equals

public boolean equals(java.lang.Object obj)

Compares this enumeration with another object for equality.

Parameters:

obj - The object to compare with.

Returns:

true if obj is an enumeration with same value and enum names; false otherwise.

hashCode

public int hashCode()

cloneShallow

protected YangEnumeration cloneShallow()
                                throws YangException

Clones this object without cloning its value.

Overrides:

cloneShallow in class YangBaseString

Returns:

A shallow clone of this object.

Throws:

YangException

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.

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.