com.prosysopc.ua.stack.core

Class Union

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractStructure

com.prosysopc.ua.typedictionary.DynamicStructure

com.prosysopc.ua.stack.core.Union

All Implemented Interfaces:

Structure, IEncodeable, UaNamespaceTranslateable<Structure>, Cloneable

public class Union
extends DynamicStructure

Base for all Unions. OPC UA Unions are Structures that have 0 or 1 of their fields set at a time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Union.Builder Base builder for Unions.

Nested classes/interfaces inherited from interface com.prosysopc.ua.stack.builtintypes.Structure

Structure.MapKind<T>

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Field Summary

Fields

Modifier and Type	Field and Description
static StructureSpecification	SPECIFICATION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Union()
protected	Union(UaDataTypeSpecification specification)

Method Summary

Modifier and Type	Method and Description
Union	clone() Clones the Structure.
protected <T> T	indexGet(int index) Returns the field in the given index.
protected <T> void	indexSet(T value, int index) Sets the given value to the given index.
Union.Builder	toBuilder() Returns a builder with the data of this Structure pre-set.
FieldSpecification	type() Returns currently set field.
Object	value() Returns the set value or null if no field was set.

Methods inherited from class com.prosysopc.ua.typedictionary.DynamicStructure

builder

Methods inherited from class com.prosysopc.ua.stack.utils.AbstractStructure

clear, equals, forEachField, forEachField, get, get, hashCode, set, set, specification, toFieldNamesMap, toFieldNamesMap, toFieldsMap, toFieldsMap, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.stack.builtintypes.Structure

reduceFields, reduceFields, toMap, withTranslatedNamespaces

Field Detail

SPECIFICATION

public static final StructureSpecification SPECIFICATION

Constructor Detail

Union

public Union()

Union

protected Union(UaDataTypeSpecification specification)

Method Detail

clone

public Union clone()

Description copied from class: AbstractStructure

Clones the Structure. This base implementation removes the CloneNotSupportedException as all Structures must be cloneable.

Specified by:

clone in interface Structure

Overrides:

clone in class DynamicStructure

toBuilder

public Union.Builder toBuilder()

Description copied from interface: Structure

Returns a builder with the data of this Structure pre-set. The returned builder shall return instances of the same #getClass() as this one.

Specified by:

toBuilder in interface Structure

Overrides:

toBuilder in class AbstractStructure

type

public FieldSpecification type()

Returns currently set field. If none is set this will return null.

value

public Object value()

Returns the set value or null if no field was set. Note that in Unions only a single field at most can be set.

indexGet

protected <T> T indexGet(int index)

Description copied from class: AbstractStructure

Returns the field in the given index. Shall only be called from Codegen classes.

Overrides:

indexGet in class AbstractStructure

indexSet

protected <T> void indexSet(T value,
                            int index)

Description copied from class: AbstractStructure

Sets the given value to the given index. Shall only be called from Codegen classes.

Overrides:

indexSet in class AbstractStructure