com.prosysopc.ua.typedictionary

Interface FieldSpecification.Builder

Enclosing interface:

FieldSpecification

public static interface FieldSpecification.Builder

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

Method Summary

Modifier and Type	Method and Description
FieldSpecification	build() Create FieldSpecification based on set data.
FieldSpecification.Builder	setAllowSubTypes(boolean allowSubTypes) Set does the field allow sub types.
FieldSpecification.Builder	setArrayDimensions(UaArrayDimensions arrayDimensions) Set ArrayDimensions of the field.
FieldSpecification.Builder	setDataTypeId(UaNodeId dataTypeId) Set the DataType of this field.
FieldSpecification.Builder	setDescription(String description) Set Description of the field.
FieldSpecification.Builder	setFieldIndex(int fieldIndex) Set the FieldIndex i.e.
FieldSpecification.Builder	setIsOptional(boolean isOptional) Set true if field is Optional Structure field.
FieldSpecification.Builder	setJavaClass(Class<?> javaClass) Set Java Class of the field.
FieldSpecification.Builder	setMaxStringLength(int maxStringLength) Set maximum String length the field can have (if the DataType of the field is String).
FieldSpecification.Builder	setName(String name) Set name of the field.
FieldSpecification.Builder	setValueRank(int valueRank) Sets the ValueRank of the field.
FieldSpecification.Builder	setXmlName(String name) Internal.

Method Detail

build

FieldSpecification build()

Create FieldSpecification based on set data. This method may return a cached instance.

setAllowSubTypes

FieldSpecification.Builder setAllowSubTypes(boolean allowSubTypes)

Set does the field allow sub types. Default is false. Cannot be combined with true setIsOptional(boolean) (doing so will cause IllegalStateException to be thrown).

setArrayDimensions

FieldSpecification.Builder setArrayDimensions(UaArrayDimensions arrayDimensions)

Set ArrayDimensions of the field. This behaves the same ways as ArrayDimensions Attribute on a Variable node. If not known can be null (the default).

Throws:

IllegalArgumentException - if given negative values.

setDataTypeId

FieldSpecification.Builder setDataTypeId(UaNodeId dataTypeId)

Set the DataType of this field.

setDescription

FieldSpecification.Builder setDescription(String description)

Set Description of the field. If not known can be null (the default).

setFieldIndex

FieldSpecification.Builder setFieldIndex(int fieldIndex)

Set the FieldIndex i.e. the position of the Field in the Structure. The first field has the index 0.

setIsOptional

FieldSpecification.Builder setIsOptional(boolean isOptional)

Set true if field is Optional Structure field. Default is false. Cannot be combined with true setAllowSubTypes(boolean) (doing so will cause IllegalStateException to be thrown).

setJavaClass

FieldSpecification.Builder setJavaClass(Class<?> javaClass)

Set Java Class of the field. This is the exact type, if the field is e.g. Double array, give Double[].class.

setMaxStringLength

FieldSpecification.Builder setMaxStringLength(int maxStringLength)

Set maximum String length the field can have (if the DataType of the field is String). If not known or not matching type this should be 0 (the default).

Throws:

IllegalArgumentException - if given negative value.

setName

FieldSpecification.Builder setName(String name)

Set name of the field. Usually these should begin with Capital letter in OPC UA.

setValueRank

FieldSpecification.Builder setValueRank(int valueRank)

Sets the ValueRank of the field. Must be either -1 (scalar) or a fixed number of dimensions (1+). Default value is -1 (scalar).

setXmlName

FieldSpecification.Builder setXmlName(String name)

Internal.