org.eclipse.milo.opcua.stack.core.types

Interface DataTypeDictionary<T extends DataTypeCodec>

All Known Implementing Classes:

OpcUaBinaryDataTypeDictionary, OpcUaXmlDataTypeDictionary

public interface DataTypeDictionary<T extends DataTypeCodec>

Method Summary

Modifier and Type	Method and Description
T	getCodec(NodeId dataTypeId) Get a DataTypeCodec registered with this dictionary.
T	getCodec(String description) Get a DataTypeCodec registered with this dictionary.
default T	getCodecByDataTypeId(NodeId dataTypeId)
default T	getCodecByDescription(String description)
default T	getCodecByEncodingId(NodeId nodeId)
Map<NodeId,T>	getCodecsByDataTypeId()
Map<String,T>	getCodecsByDescription()
Map<NodeId,T>	getCodecsByEncodingId()
QualifiedName	getEncodingName()
String	getNamespaceUri()
void	registerEnumCodec(T codec, String description) Register a DataTypeCodec that serializes an enumeration with this dictionary.
void	registerEnumCodec(T codec, String description, NodeId dataTypeId) Register a DataTypeCodec that serializes an enumeration with this dictionary.
void	registerStructCodec(T codec, String description, NodeId dataTypeId, NodeId encodingId) Register a DataTypeCodec that serializes a structure with this dictionary.

Method Detail

getNamespaceUri

String getNamespaceUri()

Returns:

the namespace URI this DataTypeDictionary belongs to.

getEncodingName

QualifiedName getEncodingName()

Returns:

the name of the datatype encoding for codecs in this dictionary.

registerEnumCodec

void registerEnumCodec(T codec,
                       String description)

Register a DataTypeCodec that serializes an enumeration with this dictionary.

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

registerEnumCodec

void registerEnumCodec(T codec,
                       String description,
                       NodeId dataTypeId)

Register a DataTypeCodec that serializes an enumeration with this dictionary.

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

dataTypeId - the NodeId of the DataType Node for the DataType serialized by codec.

registerStructCodec

void registerStructCodec(T codec,
                         String description,
                         NodeId dataTypeId,
                         NodeId encodingId)

Register a DataTypeCodec that serializes a structure with this dictionary.

Parameters:

codec - the codec to register.

description - the value of the DataTypeDescription Node that identifies codec in the dictionary.

dataTypeId - the NodeId of the DataType Node for the DataType serialized by codec.

encodingId - the NodeId of the appropriate DataTypeEncoding Node for the DataType serialized by codec.

getCodec

T getCodec(String description)

Get a DataTypeCodec registered with this dictionary.

Parameters:

description - the value of the DataTypeDescription that identifies the codec in the dictionary.

Returns:

a DataTypeCodec for description, or null if none is found.

getCodec

T getCodec(NodeId dataTypeId)

Get a DataTypeCodec registered with this dictionary.

Parameters:

dataTypeId - the NodeId of the DataType Node for the DataType serialized by the codec.

Returns:

a DataTypeCodec for dataTypeId, or null if none is found.

getCodecsByDescription

Map<String,T> getCodecsByDescription()

Returns:

a Map of all codecs registered with this dictionary, keyed by description.

getCodecsByEncodingId

Map<NodeId,T> getCodecsByEncodingId()

Returns:

a Map of all codecs registered with this dictionary, keyed by encoding id.

getCodecsByDataTypeId

Map<NodeId,T> getCodecsByDataTypeId()

Returns:

a Map of all codecs registered with this dictionary, keyed by datatype id.

getCodecByDescription

@Nullable
default T getCodecByDescription(String description)

Parameters:

description - the codec description.

Returns:

the DataTypeCodec registered for description, or null if there isn't one.

getCodecByEncodingId

@Nullable
default T getCodecByEncodingId(NodeId nodeId)

Parameters:

nodeId - the codec encoding NodeId.

Returns:

the DataTypeCodec registered for nodeId, or null if there isn't one.

getCodecByDataTypeId

@Nullable
default T getCodecByDataTypeId(NodeId dataTypeId)

Parameters:

dataTypeId - the codec datatype NodeId.

Returns:

the DataTypeCodec registered for dataTypeId, or null if there isn't one.