com.tailf.jnc

Class YangUnion

java.lang.Object

com.tailf.jnc.YangUnion

All Implemented Interfaces:

YangType<YangType<?>>, java.io.Serializable

public class YangUnion
extends java.lang.Object

Implements the built-in YANG data type "union". Represents a union of different sub-types.

From RFC 6020: When a string representing a union data type is validated, the string is validated against each member type, in the order they are specified in the "type" statement, until a match is found. Any default value or "units" property defined in the member types is not inherited by the union type.

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
YangUnion(java.lang.String value, java.lang.String[] memberTypes) Creates a YangUnion object from a java.lang.String representing a value of one of the member types.
YangUnion(YangType<?> value, java.lang.String[] memberTypes) Creates a YangUnion object from a YangType, which should be an instance of one of the member types.

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 and is instance of a member type.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
protected YangUnion	cloneShallow() Clones this object without cloning its value.
boolean	equals(java.lang.Object obj) Compares this union with another object for equality.
protected YangType<?>	fromString(java.lang.String s) Parses a value of a member type
T	getValue()
int	hashCode()
protected java.lang.String[]	memberTypes() Get the types allowed for this union.
void	setValue(java.lang.String value) Sets the value of this object using a java.lang.String.
void	setValue(YangType<?> value) Sets the value of this object using an Object.
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

YangUnion

public YangUnion(java.lang.String value,
                 java.lang.String[] memberTypes)
          throws YangException

Creates a YangUnion object from a java.lang.String representing a value of one of the member types.

Parameters:

value - The Java String.

memberTypes - A string array with the types of the union

Throws:

YangException - If an invariant was broken during assignment.

YangUnion

public YangUnion(YangType<?> value,
                 java.lang.String[] memberTypes)
          throws YangException

Creates a YangUnion object from a YangType, which should be an instance of one of the member types.

Parameters:

value - The Object to use as value.

memberTypes - A string array with the types of the union

Throws:

YangException - If an invariant was broken during assignment, for example if the value is of an incorrect type.

Method Detail

memberTypes

protected java.lang.String[] memberTypes()

Get the types allowed for this union.

Returns:

A string array with the member types of this union

setValue

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

Sets the value of this object using a java.lang.String.

Specified by:

setValue in interface YangType<YangType<?>>

Parameters:

value - The Java String.

Throws:

YangException - If an invariant was broken during assignment.

setValue

public void setValue(YangType<?> value)
              throws YangException

Sets the value of this object using an Object.

Specified by:

setValue in interface YangType<YangType<?>>

Parameters:

value - The Object to set as the new value.

Throws:

YangException - If an invariant was broken during assignment.

fromString

protected YangType<?> fromString(java.lang.String s)

Parses a value of a member type

Parameters:

s - String representation of member type value

Returns:

first valid value, or null if none

check

public void check()
           throws YangException

Checks that the value of this object is not null and is instance of a member type. Called in constructors and value setters.

Specified by:

check in interface YangType<YangType<?>>

Throws:

YangException - If the value of this object is invalid.

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 YangUnion; false otherwise.

equals

public boolean equals(java.lang.Object obj)

Compares this union with another object for equality.

Parameters:

obj - The object to compare with.

Returns:

true if obj is a a union with equal value and member types; false otherwise.

hashCode

public int hashCode()

cloneShallow

protected YangUnion cloneShallow()
                          throws YangException

Clones this object without cloning its value.

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.