Module org.eclipse.milo.opcua.stack.core

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

Class ExtensionObject

java.lang.Object

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

Direct Known Subclasses:

ExtensionObject.Binary, ExtensionObject.Json, ExtensionObject.Xml

@NullMarked
public abstract sealed class ExtensionObject
extends Object
permits ExtensionObject.Binary, ExtensionObject.Json, ExtensionObject.Xml

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExtensionObject.Binary	An ExtensionObject that contains a ByteString body, used with Binary encoding.
static final class	ExtensionObject.Json	An ExtensionObject that contains a String body, used with JSON encoding.
static final class	ExtensionObject.Xml	An ExtensionObject that contains an XmlElement body, used with XML encoding.

Constructor Summary

Constructors

Constructor	Description
ExtensionObject()

Method Summary

Modifier and Type	Method	Description
final UaStructuredType	decode(EncodingContext context)	Decode the UaStructuredType value contained in this ExtensionObject using the datatype encoding that matches its body type.
final UaStructuredType	decode(EncodingContext context, DataTypeEncoding encoding)	Decode the UaStructuredType value contained in this ExtensionObject using the specified encoding, if it hasn't already been decoded.
static ExtensionObject	encode(EncodingContext context, UaStructuredType value)	Encode a UaStructuredType value in the default binary encoding.
static ExtensionObject	encode(EncodingContext context, UaStructuredType struct, DataTypeEncoding encoding)	Encode a UaStructuredType value in the specified datatype encoding.
static ExtensionObject[]	encodeArray(EncodingContext context, UaStructuredType[] values)	Encode an array of UaStructuredType values in the default binary encoding.
abstract Object	getBody()	Get the body of this ExtensionObject.
abstract NodeId	getEncodingOrTypeId()	Get the NodeId of the datatype encoding or datatype of the encoded value contained by this ExtensionObject.
abstract boolean	isNull()	Check if this ExtensionObject is null.
static ExtensionObject	of(String body, NodeId typeId)	Create a new ExtensionObject with the specified String body and type id.
static ExtensionObject	of(ByteString body, NodeId encodingId)	Create a new ExtensionObject with the specified ByteString body and encoding id.
static ExtensionObject	of(XmlElement body, NodeId encodingId)	Create a new ExtensionObject with the specified XmlElement body and encoding id.
final ExtensionObject	transcode(EncodingContext context, NodeId newEncodingId, DataTypeEncoding newEncoding)	Transcode this ExtensionObject to a new encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExtensionObject

public ExtensionObject()

Method Details

getBody

public abstract Object getBody()

Get the body of this ExtensionObject.

The body is the encoded value of the ExtensionObject. The type of the body depends on the encoding that was used to encode the ExtensionObject. The body is one of:

• ByteString for Binary encoding
• XmlElement for XML encoding
• String for JSON encoding

Returns:

the body of this ExtensionObject.

getEncodingOrTypeId

public abstract NodeId getEncodingOrTypeId()

Get the NodeId of the datatype encoding or datatype of the encoded value contained by this ExtensionObject.

The NodeId returned is the encoding id if the encoding is Binary or XML, or the datatype id if the encoding is JSON.

Returns:

the NodeId of the datatype encoding or datatype.

isNull

public abstract boolean isNull()

Check if this ExtensionObject is null.

Returns:

true if this ExtensionObject is null, false otherwise.

decode

public final UaStructuredType decode(EncodingContext context)
                              throws UaSerializationException

Decode the UaStructuredType value contained in this ExtensionObject using the datatype encoding that matches its body type.

Parameters:

context - an EncodingContext.

Returns:

the decoded UaStructuredType value.

Throws:

UaSerializationException - if the decoding fails.

decode

public final UaStructuredType decode(EncodingContext context,
 DataTypeEncoding encoding)
                              throws UaSerializationException

Decode the UaStructuredType value contained in this ExtensionObject using the specified encoding, if it hasn't already been decoded.

Parameters:

context - an EncodingContext.

encoding - the DataTypeEncoding to use.

Returns:

the decoded UaStructuredType value.

Throws:

UaSerializationException - if the decoding fails.

transcode

public final ExtensionObject transcode(EncodingContext context,
 NodeId newEncodingId,
 DataTypeEncoding newEncoding)
                                throws UaSerializationException

Transcode this ExtensionObject to a new encoding.

Parameters:

context - an EncodingContext.

newEncodingId - the NodeId of the new encoding.

newEncoding - the DataTypeEncoding to use.

Returns:

a new ExtensionObject with a value encoded in the specified encoding.

Throws:

UaSerializationException - if the transcoding fails.

of

public static ExtensionObject of(ByteString body,
 NodeId encodingId)

Create a new ExtensionObject with the specified ByteString body and encoding id.

Parameters:

body - the ByteString body of the ExtensionObject

encodingId - the NodeId of the datatype encoding.

Returns:

a new ExtensionObject with the specified body and encoding id.

of

public static ExtensionObject of(XmlElement body,
 NodeId encodingId)

Create a new ExtensionObject with the specified XmlElement body and encoding id.

Parameters:

body - the XmlElement body of the ExtensionObject

encodingId - the NodeId of the datatype encoding.

Returns:

a new ExtensionObject with the specified body and encoding id.

of

public static ExtensionObject of(String body,
 NodeId typeId)

Create a new ExtensionObject with the specified String body and type id.

Parameters:

body - the String body of the ExtensionObject

typeId - the NodeId of the datatype.

Returns:

a new ExtensionObject with the specified body and type id.

encodeArray

public static ExtensionObject[] encodeArray(EncodingContext context,
 UaStructuredType[] values)
                                     throws UaSerializationException

Encode an array of UaStructuredType values in the default binary encoding.

Parameters:

context - an EncodingContext.

values - the UaStructuredType values to encode.

Returns:

an array of ExtensionObject containing the encoded values.

Throws:

UaSerializationException - if the encoding fails.

encode

public static ExtensionObject encode(EncodingContext context,
 UaStructuredType value)
                              throws UaSerializationException

Encode a UaStructuredType value in the default binary encoding.

Parameters:

context - an EncodingContext.

value - the UaStructuredType value to encode.

Returns:

an ExtensionObject containing the encoded value.

Throws:

UaSerializationException - if the encoding fails.

encode

public static ExtensionObject encode(EncodingContext context,
 UaStructuredType struct,
 DataTypeEncoding encoding)
                              throws UaSerializationException

Encode a UaStructuredType value in the specified datatype encoding.

Parameters:

context - an EncodingContext.

struct - the UaStructuredType value to encode.

encoding - the DataTypeEncoding to use.

Returns:

an ExtensionObject containing the encoded value.

Throws:

UaSerializationException - if the encoding fails.