com.prosysopc.ua.stack.utils

Class AbstractStructure

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractStructure

All Implemented Interfaces:

Structure, IEncodeable, UaNamespaceTranslateable<Structure>, Cloneable

Direct Known Subclasses:

DynamicStructure

public abstract class AbstractStructure
extends Object
implements Structure

A base class for Structure implementations. Note that only the SDK itself or Codegen code should make subtypes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractStructure.Builder Base builder implementation for Structures.

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 A StructureSpecification for the raw (i=22) Structure DataType.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStructure(UaDataTypeSpecification specification) Constructor for AbstractStructure.

Method Summary

Modifier and Type	Method and Description
void	clear() Sets all fields to their default values (i.e.
AbstractStructure	clone() Clones the Structure.
boolean	equals(Object obj)
<E extends Exception> void	forEachField(CheckedBiConsumer<FieldSpecification,Object,E> operation) Calls the given CheckedBiConsumer for each of the Structure.specification() fields with the value of the field.
<E extends Exception> void	forEachField(StructureSpecification other, CheckedBiConsumer<FieldSpecification,Object,E> operation) Calls the given CheckedBiConsumer for each of the given specification (see Structure.toFieldNamesMap(StructureSpecification) on the restrictions of the given StructureSpecification) fields with the value of the field.
Object	get(FieldSpecification field) Get the value of the given field.
Object	get(String fieldName) Get the value of the given field.
int	hashCode()
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.
void	set(FieldSpecification field, Object value) Sets a new value for a field.
void	set(String fieldName, Object value) Sets a new value for a field.
StructureSpecification	specification() Returns the specification of the given Structure.
AbstractStructure.Builder	toBuilder() Returns a builder with the data of this Structure pre-set.
Map<String,Object>	toFieldNamesMap() Same as Structure.toFieldsMap(), but uses FieldSpecification.getName() as the key.
Map<String,Object>	toFieldNamesMap(StructureSpecification other) Same as Structure.toFieldsMap(StructureSpecification), but uses FieldSpecification.getName() as the key.
Map<FieldSpecification,Object>	toFieldsMap() Splits this Structure to a Map where keys are the FieldSpecification (from Structure.specification()) and values as-if Structure.get(FieldSpecification) would have been called per each field.
Map<FieldSpecification,Object>	toFieldsMap(StructureSpecification other) "Casts" this Structure based on the given StructureSpecification and then split it to it's fields similar to Structure.toFieldsMap().
String	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

A StructureSpecification for the raw (i=22) Structure DataType.

Constructor Detail

AbstractStructure

protected AbstractStructure(UaDataTypeSpecification specification)

Constructor for AbstractStructure. The given UaDataTypeSpecification defines the "true type" of this instance and shall be a StructureSpecification. Only SDK itself or Codegen should be calling this.

Method Detail

clear

public void clear()

Description copied from interface: Structure

Sets all fields to their default values (i.e. null). After the call the state of this Structure shall the same as a newly created instance where no fields have been set.

Specified by:

clear in interface Structure

clone

public AbstractStructure clone()

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 Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

forEachField

public <E extends Exception> void forEachField(CheckedBiConsumer<FieldSpecification,Object,E> operation)
                                        throws E extends Exception

Description copied from interface: Structure

Calls the given CheckedBiConsumer for each of the Structure.specification() fields with the value of the field. Note that for Unions this will also happen for each field (but only at most one of them has a non-null value). This gives similar results as doing Map.forEach(BiConsumer) for Structure.toFieldsMap(), but may perform better.

Specified by:

forEachField in interface Structure

Throws:

E extends Exception

forEachField

public <E extends Exception> void forEachField(StructureSpecification other,
                                               CheckedBiConsumer<FieldSpecification,Object,E> operation)
                                        throws E extends Exception

Description copied from interface: Structure

Calls the given CheckedBiConsumer for each of the given specification (see Structure.toFieldNamesMap(StructureSpecification) on the restrictions of the given StructureSpecification) fields with the value of the field. Note that for Unions this will also happen for each field (but only at most one of them has a non-null value). This gives similar results as doing Map.forEach(BiConsumer) for Structure.toFieldsMap(StructureSpecification), but may perform better.

Specified by:

forEachField in interface Structure

Throws:

E extends Exception

get

public Object get(FieldSpecification field)

Description copied from interface: Structure

Get the value of the given field.

Specified by:

get in interface Structure

Parameters:

field - specification of a field, must be one of the fields in the specification given by Structure.specification().

Returns:

the value of the field (can be null)

get

public Object get(String fieldName)

Description copied from interface: Structure

Get the value of the given field. Note that the fieldName must be the name of one of the FieldSpecifications in the specification given by Structure.specification().

Specified by:

get in interface Structure

Parameters:

fieldName - name of the field

Returns:

the value of the field (can be null)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

set

public void set(FieldSpecification field,
                Object value)

Description copied from interface: Structure

Sets a new value for a field. Note that the field must be an existing one i.e. one of the fields of Structure.specification(). Setting an Optional Field to null will make it not present for encoding. Setting a Field in an Union will unset other fields.

Specified by:

set in interface Structure

Parameters:

field - specification of a field, must be one of the fields in the specification given by Structure.specification().

value - the value of the field (can be null)

set

public void set(String fieldName,
                Object value)

Description copied from interface: Structure

Sets a new value for a field. Note that the fieldName must be the name of one of the FieldSpecifications in the specification given by Structure.specification(). Setting an Optional Field to null will make it not present for encoding. Setting a Field in an Union will unset other fields.

Specified by:

set in interface Structure

Parameters:

fieldName - the field, must be the name of one of the FieldSpecifications in the specification given by Structure.specification().

value - new value for the given field, can be null.

specification

public StructureSpecification specification()

Description copied from interface: Structure

Returns the specification of the given Structure. Can be used to dynamically display the fields of the Structure.

Specified by:

specification in interface Structure

toBuilder

public AbstractStructure.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

toFieldNamesMap

public Map<String,Object> toFieldNamesMap()

Description copied from interface: Structure

Same as Structure.toFieldsMap(), but uses FieldSpecification.getName() as the key.

Specified by:

toFieldNamesMap in interface Structure

toFieldNamesMap

public Map<String,Object> toFieldNamesMap(StructureSpecification other)

Description copied from interface: Structure

Same as Structure.toFieldsMap(StructureSpecification), but uses FieldSpecification.getName() as the key.

Specified by:

toFieldNamesMap in interface Structure

toFieldsMap

public Map<FieldSpecification,Object> toFieldsMap()

Description copied from interface: Structure

Splits this Structure to a Map where keys are the FieldSpecification (from Structure.specification()) and values as-if Structure.get(FieldSpecification) would have been called per each field. The iteration order of the Map is the order of the fields. The returned Map is unmodifiable.

Specified by:

toFieldsMap in interface Structure

toFieldsMap

public Map<FieldSpecification,Object> toFieldsMap(StructureSpecification other)

Description copied from interface: Structure

"Casts" this Structure based on the given StructureSpecification and then split it to it's fields similar to Structure.toFieldsMap().

Throws IllegalArgumentException if the casting cannot be made, which happens if the given StructureSpecification is not part of the inheritance hierarchy of this Structure, i.e. the given StructureSpecification must be one of 1. the same as Structure.specification() or 2. a supertype of this Structure.specification() or 3. a subtype of this Structure.specification(). This method only uses UaDataTypeSpecification.getTypeId(), StructureSpecification.getSuperTypeIds() and FieldSpecification.getName() i.e. it is assumed that the given specification is from the same context (client, server, pubsub) as this Structure.specification().

The return is a Map where keys are the FieldSpecification (from the given specification) and values as-if Structure.get(FieldSpecification) would have been called per each field (for the casted Structure). The iteration order of the Map is the order of the fields. The returned Map is unmodifiable.

This method mainly exist for encoding purposes , where Structure fields that are Structures themselves must be encoded as the specified type (unless FieldSpecification.isAllowSubTypes() is true.

Specified by:

toFieldsMap in interface Structure

toString

public String toString()

Overrides:

toString in class Object

indexGet

protected <T> T indexGet(int index)

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

indexSet

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

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