com.prosysopc.ua.typedictionary

Interface OptionSetSpecification

All Superinterfaces:

UaDataTypeSpecification, UaNamespaceTranslateable<UaDataTypeSpecification>

All Known Subinterfaces:

OptionSetStructureSpecification

public interface OptionSetSpecification
extends UaDataTypeSpecification

This interface defines a Specification for a UaOptionSet info to enable dynamic handling. This interface is sealed, the only implementations are internal to the SDK or generated via Codegen. Normally instances of this shouldn't be made manually, but instead resolved by the UaClient from the server or in the server side by loading NodeSet information models. Instances can be searched via EncoderContext. However, a OptionSetSpecification.Builder can be constructed via builder(). Note that if you make a Structure-based OptionSet, you must instead call OptionSetStructureSpecification.builder()-

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OptionSetSpecification.Builder<T extends UaOptionSet.Builder> Builder for OptionSetSpecification.

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
static OptionSetSpecification.Builder<UaOptionSet.Builder>	builder() Creates a new OptionSetSpecification.Builder.
UaNodeId	getBaseTypeId() Returns the base DataTypeId.
default Class<?>	getBaseTypeJavaClass() Returns the Java Class that matches the getBaseTypeId().
Function<UaDataTypeSpecification,? extends UaOptionSet.Builder>	getBuilderSupplier() Returns value set by OptionSetSpecification.Builder.setBuilderSupplier(Function).
Class<?>	getJavaClass() Returns the java Class of OptionSet that are returned by the #toOptionSetBuilder().
OptionSpecification	getOption(String name) Get FieldSpecification that has the given name.
List<String>	getOptionNames() Returns the names of options as an unmodifiable list.
List<OptionSpecification>	getOptions() Returns the options as an unmodifiable list.
OptionSetSpecification.Builder	toBuilder() Returns a new OptionSetSpecification.Builder initialized with the data of this instance.
UaOptionSet.Builder	toInstanceBuilder() Creates a UaOptionSet.Builder implementation that creates Structures that match this specification.
OptionSetSpecification	withTranslatedNamespaces(UaNamespaceTranslateable.Context context) Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context.

Methods inherited from interface com.prosysopc.ua.typedictionary.UaDataTypeSpecification

getName, getTypeId, getXmlName, isAbstract, toDataTypeDefinition

Method Detail

builder

static OptionSetSpecification.Builder<UaOptionSet.Builder> builder()

Creates a new OptionSetSpecification.Builder. IMPORTANT! if making a Structure-based OptionSetSpecification, you must instead call OptionSetStructureSpecification.builder().

getBaseTypeId

UaNodeId getBaseTypeId()

Returns the base DataTypeId. For UInteger-based OptionSets, this is one of Byte, UInt16, UInt32 or UInt64. For 'OptionSet Structure' based OptionSets this is the 'OptionSet' Structure DataType.

getBaseTypeJavaClass

default Class<?> getBaseTypeJavaClass()

Returns the Java Class that matches the getBaseTypeId(). One of Byte -> UnsignedByte, UInt16 -> UnsignedShort, UInt32 -> UnsignedInteger, UInt64 -> UnsignedLong, or OptionSet -> OptionSet.

getBuilderSupplier

Function<UaDataTypeSpecification,? extends UaOptionSet.Builder> getBuilderSupplier()

Returns value set by OptionSetSpecification.Builder.setBuilderSupplier(Function). Important! This method is only intended for SDK internal usage for the purposes of using this when creating OptionSetSpecifications of subtypes. Use toInstanceBuilder() for obtaining UaOptionSet.Builder.

getJavaClass

Class<?> getJavaClass()

Returns the java Class of OptionSet that are returned by the #toOptionSetBuilder().

Specified by:

getJavaClass in interface UaDataTypeSpecification

getOption

OptionSpecification getOption(String name)

Get FieldSpecification that has the given name. NOTE! The given name must be exact match for FieldSpecification.getName() of one of the FieldSpecification returned by getOptions().

Parameters:

name - name of the field

Returns:

matching FieldSpecification for the given name.

Throws:

IllegalArgumentException - if this OptionSetSpecification does not have the field.

getOptionNames

List<String> getOptionNames()

Returns the names of options as an unmodifiable list. For more specific info use getOptions().

getOptions

List<OptionSpecification> getOptions()

Returns the options as an unmodifiable list.

toBuilder

OptionSetSpecification.Builder toBuilder()

Returns a new OptionSetSpecification.Builder initialized with the data of this instance.

toInstanceBuilder

UaOptionSet.Builder toInstanceBuilder()

Creates a UaOptionSet.Builder implementation that creates Structures that match this specification.

withTranslatedNamespaces

OptionSetSpecification withTranslatedNamespaces(UaNamespaceTranslateable.Context context)

Description copied from interface: UaNamespaceTranslateable

Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context. Returning the same object is allowed if the type is immutable and the result is equal to this. Note that for Structure types if the UaDataTypeSpecification translation is active the returned type can be of different java class.

Specified by:

withTranslatedNamespaces in interface UaNamespaceTranslateable<UaDataTypeSpecification>