com.prosysopc.ua.typedictionary

Interface OptionSetStructure.Builder

All Superinterfaces:

Structure.Builder, UaOptionSet.Builder

All Known Implementing Classes:

OptionSet.Builder

Enclosing interface:

OptionSetStructure

public static interface OptionSetStructure.Builder
extends Structure.Builder, UaOptionSet.Builder

Builder for OptionSetStructure.

Method Summary

Modifier and Type	Method and Description
OptionSetStructure	build() Builds a Structure with the given data.
OptionSetStructure.Builder	clear() Sets all fields to their default values (i.e.
default boolean	isValid(int bitPosition) Returns true if the bit position is set in the OptionSet.getValidBits().
default boolean	isValid(OptionSpecification option) Returns true if the option exist (is part of specification()) and it's position is set in the OptionSet.getValidBits().
OptionSetStructure.Builder	setValid(int bitPosition, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
OptionSetStructure.Builder	setValid(OptionSpecification option, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
OptionSetStructureSpecification	specification() Returns the specification of the Structures that this builder builds.

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

get, get, set, set

Methods inherited from interface com.prosysopc.ua.UaOptionSet.Builder

add, addAll, contains, containsAll, remove, removeAll

Method Detail

build

OptionSetStructure 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

Specified by:

build in interface UaOptionSet.Builder

clear

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

Specified by:

clear in interface UaOptionSet.Builder

isValid

default boolean isValid(int bitPosition)

Returns true if the bit position is set in the OptionSet.getValidBits().

isValid

default boolean isValid(OptionSpecification option)

Returns true if the option exist (is part of specification()) and it's position is set in the OptionSet.getValidBits().

setValid

OptionSetStructure.Builder setValid(int bitPosition,
                                    boolean valid)

Sets or clears the bit in OptionSet.getValidBits() in the position. Does nothing if the given position is not one of the specification() option(s) position.

setValid

OptionSetStructure.Builder setValid(OptionSpecification option,
                                    boolean valid)

Sets or clears the bit in OptionSet.getValidBits() in the position. Does nothing if the given option is not part of specification().

specification

OptionSetStructureSpecification specification()

Description copied from interface: Structure.Builder

Returns the specification of the Structures that this builder builds.

Specified by:

specification in interface Structure.Builder

Specified by:

specification in interface UaOptionSet.Builder