com.prosysopc.ua.stack.core

Class OptionSet.Builder

java.lang.Object

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

com.prosysopc.ua.typedictionary.DynamicStructure.Builder

com.prosysopc.ua.stack.core.OptionSet.Builder

All Implemented Interfaces:

Structure.Builder, OptionSetStructure.Builder, UaOptionSet.Builder

Enclosing class:

OptionSet

public static class OptionSet.Builder
extends DynamicStructure.Builder
implements UaOptionSet.Builder, OptionSetStructure.Builder

Base for Structure-OptionSet builders.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OptionSet.Builder	add(OptionSpecification... options) Adds the given options (if they are part of UaOptionSet.Builder.specification()).
OptionSet.Builder	addAll(Iterable<? extends OptionSpecification> options) Adds the given options (if they are part of UaOptionSet.Builder.specification()).
OptionSet	build() Builds a Structure with the given data.
OptionSet.Builder	clear() Sets all fields to their default values (i.e.
boolean	contains(OptionSpecification... options) Returns true if the given options are set in the builder, false otherwise.
boolean	containsAll(Iterable<? extends OptionSpecification> options) Returns true if the given options are set in the builder, false otherwise.
ByteString	getValidBits()
ByteString	getValue()
boolean	isValid(int bitPosition) Returns true if the bit position is set in the OptionSet.getValidBits().
boolean	isValid(OptionSpecification option) Returns true if the option exist (is part of OptionSetStructure.Builder.specification()) and it's position is set in the OptionSet.getValidBits().
OptionSet.Builder	remove(OptionSpecification... options) Removes the given options (if they are part of UaOptionSet.Builder.specification()).
OptionSet.Builder	removeAll(Iterable<? extends OptionSpecification> options) Removes the given options (if they are part of UaOptionSet.Builder.specification()).
OptionSet.Builder	set(FieldSpecification field, Object value) Sets a new value for a field.
OptionSet.Builder	setValid(int bitPosition, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
OptionSet.Builder	setValid(OptionSpecification option, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
OptionSet.Builder	setValidBits(ByteString validBits)
OptionSet.Builder	setValue(ByteString value)
OptionSetStructureSpecification	specification() Returns the specification of the Structures that this builder builds.

Methods inherited from class com.prosysopc.ua.stack.utils.AbstractStructure.Builder

equals, get, get, hashCode, indexGet, indexSet, set, toString

Methods inherited from class java.lang.Object

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

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

get, get, set

Constructor Detail

Builder

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

Method Detail

add

public OptionSet.Builder add(OptionSpecification... options)

Description copied from interface: UaOptionSet.Builder

Adds the given options (if they are part of UaOptionSet.Builder.specification()). For OptionSet Structures, this also sets the respective OptionSet.getValidBits() bits as set.

Specified by:

add in interface UaOptionSet.Builder

addAll

public OptionSet.Builder addAll(Iterable<? extends OptionSpecification> options)

Description copied from interface: UaOptionSet.Builder

Adds the given options (if they are part of UaOptionSet.Builder.specification()). For OptionSet Structures, this also sets the respective OptionSet.getValidBits() bits as set.

Specified by:

addAll in interface UaOptionSet.Builder

build

public OptionSet 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 OptionSetStructure.Builder

Specified by:

build in interface UaOptionSet.Builder

Overrides:

build in class DynamicStructure.Builder

clear

public OptionSet.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 OptionSetStructure.Builder

Specified by:

clear in interface UaOptionSet.Builder

Overrides:

clear in class AbstractStructure.Builder

contains

public boolean contains(OptionSpecification... options)

Description copied from interface: UaOptionSet.Builder

Returns true if the given options are set in the builder, false otherwise.

Specified by:

contains in interface UaOptionSet.Builder

containsAll

public boolean containsAll(Iterable<? extends OptionSpecification> options)

Description copied from interface: UaOptionSet.Builder

Returns true if the given options are set in the builder, false otherwise.

Specified by:

containsAll in interface UaOptionSet.Builder

getValidBits

public ByteString getValidBits()

getValue

public ByteString getValue()

isValid

public final boolean isValid(int bitPosition)

Description copied from interface: OptionSetStructure.Builder

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

Specified by:

isValid in interface OptionSetStructure.Builder

isValid

public final boolean isValid(OptionSpecification option)

Description copied from interface: OptionSetStructure.Builder

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

Specified by:

isValid in interface OptionSetStructure.Builder

remove

public OptionSet.Builder remove(OptionSpecification... options)

Description copied from interface: UaOptionSet.Builder

Removes the given options (if they are part of UaOptionSet.Builder.specification()). For OptionSet Structures, this also sets the respective OptionSet.getValidBits() bits as set.

Specified by:

remove in interface UaOptionSet.Builder

removeAll

public OptionSet.Builder removeAll(Iterable<? extends OptionSpecification> options)

Description copied from interface: UaOptionSet.Builder

Removes the given options (if they are part of UaOptionSet.Builder.specification()). For OptionSet Structures, this also sets the respective OptionSet.getValidBits() bits as set.

Specified by:

removeAll in interface UaOptionSet.Builder

set

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

Overrides:

set in class AbstractStructure.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.

setValid

public OptionSet.Builder setValid(int bitPosition,
                                  boolean valid)

Description copied from interface: OptionSetStructure.Builder

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

Specified by:

setValid in interface OptionSetStructure.Builder

setValid

public OptionSet.Builder setValid(OptionSpecification option,
                                  boolean valid)

Description copied from interface: OptionSetStructure.Builder

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

Specified by:

setValid in interface OptionSetStructure.Builder

setValidBits

public OptionSet.Builder setValidBits(ByteString validBits)

setValue

public OptionSet.Builder setValue(ByteString value)

specification

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

Specified by:

specification in interface UaOptionSet.Builder

Overrides:

specification in class AbstractStructure.Builder