com.prosysopc.ua.typedictionary

Interface StructureSpecification.Builder<T extends Structure.Builder>

All Known Subinterfaces:

OptionSetStructureSpecification.Builder<T>

Enclosing interface:

StructureSpecification

public static interface StructureSpecification.Builder<T extends Structure.Builder>

Builder for StructureSpecification. This class is not thread-safe.

Method Summary

Modifier and Type	Method and Description
StructureSpecification.Builder<T>	addField(FieldSpecification field) Add a single field.
StructureSpecification.Builder<T>	addSuperTypeId(UaNodeId superTypeId) Adds a super type NodeId, all direct and indirect types shall be added.
StructureSpecification	build() Builds a StructureSpecification based on the given data.
StructureSpecification.Builder<T>	setAbstract(boolean isAbstract) Set to true, if type is known to be abstract, false otherwise (the default).
StructureSpecification.Builder<T>	setBinaryEncodeId(UaNodeId binaryEncodeId) Set the Binary encoding NodeId.
StructureSpecification.Builder<T>	setBuilderSupplier(Function<UaDataTypeSpecification,T> builderSupplier) Set supplier used in StructureSpecification.toStructureBuilder().
StructureSpecification.Builder<T>	setFields(List<FieldSpecification> fields) Set all fields of this Structure.
StructureSpecification.Builder<T>	setJavaClass(Class<?> javaClass) Sets the java class of returned objects.
StructureSpecification.Builder<T>	setJsonEncodeId(UaNodeId jsonEncodeId) Set JSON encoding NodeId, or null if not supported.
StructureSpecification.Builder<T>	setName(String name) Set the name of the Structure, Structure names in OPC UA should start with Capital letter.
StructureSpecification.Builder<T>	setStructureType(StructureSpecification.StructureType structureType) Set the StructureSpecification.StructureType.
StructureSpecification.Builder<T>	setTypeId(UaNodeId typeId) Set the DataType NodeId of the Structure type.
StructureSpecification.Builder<T>	setXmlEncodeId(UaNodeId xmlEncodeId) Set XML encoding NodeId, or null if not supported.
StructureSpecification.Builder<T>	setXmlName(String name) Internal.

Method Detail

addField

StructureSpecification.Builder<T> addField(FieldSpecification field)

Add a single field. See setFields(List) for the definition of the order of the fields.

addSuperTypeId

StructureSpecification.Builder<T> addSuperTypeId(UaNodeId superTypeId)

Adds a super type NodeId, all direct and indirect types shall be added. The types shall be added iteratively from ROOT->LEAF, i.e. the root type 'Structure' (UaDataTypeIds.Structure) shall be added first and then lastly the direct supertype.

build

StructureSpecification build()

Builds a StructureSpecification based on the given data. This method may return a cached instance.

setAbstract

StructureSpecification.Builder<T> setAbstract(boolean isAbstract)

Set to true, if type is known to be abstract, false otherwise (the default).

setBinaryEncodeId

StructureSpecification.Builder<T> setBinaryEncodeId(UaNodeId binaryEncodeId)

Set the Binary encoding NodeId. This should always be set.

setBuilderSupplier

StructureSpecification.Builder<T> setBuilderSupplier(Function<UaDataTypeSpecification,T> builderSupplier)

Set supplier used in StructureSpecification.toStructureBuilder(). If set to null, which is the default, the method will provide DynamicStructure.Builders. The given Function shall create a new Structure.Builder each time it is called. The given UaDataTypeSpecification parameter shall be given as parameter to the respective Structure.Builder's constructor and that constructor shall be the nearest/closest supertype that is code-generated (or left to null if no such type). The parameter is UaDataTypeSpecification due to multiple-inheritance reasons with UaOptionSet, but in this context shall be always be StructureSpecification or OptionSetStructureSpecification.

setFields

StructureSpecification.Builder<T> setFields(List<FieldSpecification> fields)

Set all fields of this Structure. Must include all (direct and non-direct) supertype fields as well in the order that the most supertype fields are first and fields of this subtype is last. The given fields are copied from the given list, it is not used directly.

setJavaClass

StructureSpecification.Builder<T> setJavaClass(Class<?> javaClass)

Sets the java class of returned objects. If null, DynamicStructure is used.

setJsonEncodeId

StructureSpecification.Builder<T> setJsonEncodeId(UaNodeId jsonEncodeId)

Set JSON encoding NodeId, or null if not supported.

setName

StructureSpecification.Builder<T> setName(String name)

Set the name of the Structure, Structure names in OPC UA should start with Capital letter.

setStructureType

StructureSpecification.Builder<T> setStructureType(StructureSpecification.StructureType structureType)

Set the StructureSpecification.StructureType. If given null, uses StructureSpecification.StructureType.NORMAL.

setTypeId

StructureSpecification.Builder<T> setTypeId(UaNodeId typeId)

Set the DataType NodeId of the Structure type. This is the NodeId of the DataType node which models the Structure.

setXmlEncodeId

StructureSpecification.Builder<T> setXmlEncodeId(UaNodeId xmlEncodeId)

Set XML encoding NodeId, or null if not supported.

setXmlName

StructureSpecification.Builder<T> setXmlName(String name)

Internal.