com.prosysopc.ua.stack.utils

Class AbstractStructure.Builder

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractStructure.Builder

All Implemented Interfaces:

Structure.Builder

Direct Known Subclasses:

DynamicStructure.Builder

Enclosing class:

AbstractStructure

public abstract static class AbstractStructure.Builder
extends Object
implements Structure.Builder

Base builder implementation for Structures.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(UaDataTypeSpecification specification, Supplier<? extends Structure> emptyInstanceSupplier) Constructor for Builder.

Method Summary

Modifier and Type	Method and Description
AbstractStructure	build() Builds a Structure with the given data.
AbstractStructure.Builder	clear() Sets all fields to their default values (i.e.
boolean	equals(Object obj)
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.
AbstractStructure.Builder	set(FieldSpecification field, Object value) Sets a new value for a field.
AbstractStructure.Builder	set(String fieldName, Object value) Sets a new value for a field.
StructureSpecification	specification() Returns the specification of the Structures that this builder builds.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(UaDataTypeSpecification specification,
                  Supplier<? extends Structure> emptyInstanceSupplier)

Constructor for Builder. Only SDK itself or Codegen should be calling this.

Method Detail

build

public AbstractStructure build()

Description copied from interface: Structure.Builder

Builds a Structure with the given data. This method may return a cached instance. Implementation should override this method to return the concrete type.

Specified by:

build in interface Structure.Builder

clear

public AbstractStructure.Builder clear()

Description copied from interface: Structure.Builder

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

Specified by:

clear in interface Structure.Builder

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

get

public Object get(FieldSpecification field)

Description copied from interface: Structure.Builder

Get the value of the given field.

Specified by:

get in interface Structure.Builder

Parameters:

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

Returns:

the value of the field (can be null)

get

public Object get(String fieldName)

Description copied from interface: Structure.Builder

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.Builder.specification().

Specified by:

get in interface Structure.Builder

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 AbstractStructure.Builder set(FieldSpecification field,
                                     Object value)

Description copied from interface: Structure.Builder

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.Builder

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) * @throws IllegalArgumentException if the given field is not one of the fields of the Structure.Builder.specification().

Returns:

itself for method chaining.

set

public AbstractStructure.Builder set(String fieldName,
                                     Object value)

Description copied from interface: Structure.Builder

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.Builder

Parameters:

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

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

Returns:

itself for method chaining.

specification

public StructureSpecification specification()

Description copied from interface: Structure.Builder

Returns the specification of the Structures that this builder builds.

Specified by:

specification in interface Structure.Builder

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.