public interface IEncoder
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
getEncoderContext()
Returns
EncoderContext of this encoder. |
List<Locale> |
getLocales()
The current Locale preferences.
|
void |
put(String fieldName,
Object value,
UaNodeId dataTypeId,
int dimensions)
Encodes the given field.
|
default void |
putBoolean(String fieldName,
Boolean value)
Puts Boolean, throws on failure.
|
default void |
putBooleanArray(String fieldName,
Boolean[] value)
Puts Boolean array, throws on failure.
|
default void |
putBooleanArray(String fieldName,
Collection<Boolean> value)
Puts Boolean array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putByte(String fieldName,
UnsignedByte value)
Puts UInt16 (
UnsignedByte), throws on failure. |
default void |
putByteArray(String fieldName,
Collection<UnsignedByte> value)
Puts UInt16 (
UnsignedByte) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putByteArray(String fieldName,
UnsignedByte[] value)
Puts Byte (
UnsignedByte) array, throws on failure. |
default void |
putByteString(String fieldName,
ByteString value)
Puts ByteString, throws on failure.
|
default void |
putByteStringArray(String fieldName,
ByteString[] value)
Puts ByteString array, throws on failure.
|
default void |
putByteStringArray(String fieldName,
Collection<ByteString> value)
Puts ByteString array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putDataValue(String fieldName,
DataValue value)
Puts DataValue, throws on failure.
|
default void |
putDataValueArray(String fieldName,
Collection<DataValue> value)
Puts DataValue array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putDataValueArray(String fieldName,
DataValue[] value)
Puts DataValue array, throws on failure.
|
default void |
putDateTime(String fieldName,
DateTime value)
Puts DateTime, throws on failure.
|
default void |
putDateTimeArray(String fieldName,
Collection<DateTime> value)
Puts DateTime array, throws on failure.
|
default void |
putDateTimeArray(String fieldName,
DateTime[] value)
Puts DateTime array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putDiagnosticInfo(String fieldName,
DiagnosticInfo value)
Puts DiagnosticInfo, throws on failure.
|
default void |
putDiagnosticInfoArray(String fieldName,
Collection<DiagnosticInfo> value)
Puts DiagnosticInfo array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putDiagnosticInfoArray(String fieldName,
DiagnosticInfo[] value)
Puts DiagnosticInfo array, throws on failure.
|
default void |
putDouble(String fieldName,
double value)
Puts Double (
Double) (boxing the given value), throws on failure. |
default void |
putDouble(String fieldName,
Double value)
Puts Double (
Double), throws on failure. |
default void |
putDoubleArray(String fieldName,
Collection<Double> value)
Puts Double (
Double) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putDoubleArray(String fieldName,
Double[] value)
Puts Double (
Double) array, throws on failure. |
default void |
putExpandedNodeId(String fieldName,
ExpandedNodeId value)
Puts ExpandedNodeId, throws on failure.
|
default void |
putExpandedNodeIdArray(String fieldName,
Collection<ExpandedNodeId> value)
Puts ExpandedNodeId array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putExpandedNodeIdArray(String fieldName,
ExpandedNodeId[] value)
Puts ExpandedNodeId array, throws on failure.
|
default void |
putExtensionObject(String fieldName,
ExtensionObject value)
Puts ExtensionObject, throws on failure.
|
default void |
putExtensionObjectArray(String fieldName,
Collection<ExtensionObject> value)
Puts ExtensionObject array, throws on failure.
|
default void |
putExtensionObjectArray(String fieldName,
ExtensionObject[] value)
Puts ExtensionObject array, throws on failure.
|
default void |
putFloat(String fieldName,
float value)
Puts Float (
Float) (boxing the given value), throws on failure. |
default void |
putFloat(String fieldName,
Float value)
Puts Float (
Float), throws on failure. |
default void |
putFloatArray(String fieldName,
Collection<Float> value)
Puts Float (
Float) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putFloatArray(String fieldName,
Float[] value)
Puts Float (
Float) array, throws on failure. |
default void |
putGuid(String fieldName,
UUID value)
Puts Guid (mapped to Java
UUID), throws on failure. |
default void |
putGuidArray(String fieldName,
Collection<UUID> value)
Puts Guid (mapped to Java
UUID) array (with Collection.toArray(Object[])),
throws on failure. |
default void |
putGuidArray(String fieldName,
UUID[] value)
Puts Guid (mapped to Java
UUID) array, throws on failure. |
default void |
putInt16(String fieldName,
short value)
Puts Int16 (
Short) (boxing the given value), throws on failure. |
default void |
putInt16(String fieldName,
Short value)
Puts Int16 (
Short), throws on failure. |
default void |
putInt16Array(String fieldName,
Collection<Short> value)
Puts Int16 (
Short) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putInt16Array(String fieldName,
Short[] value)
Puts Int16 (
Short) array, throws on failure. |
default void |
putInt32(String fieldName,
int value)
Puts Int32 (
Integer) (boxing the given value), throws on failure. |
default void |
putInt32(String fieldName,
Integer value)
Puts Int32 (
Integer), throws on failure. |
default void |
putInt32Array(String fieldName,
Collection<Integer> value)
Puts Int32 (
Integer) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putInt32Array(String fieldName,
int[] value)
Puts Int32 (
Integer) array (int[] converted to Integer[]), throws on failure. |
default void |
putInt32Array(String fieldName,
Integer[] value)
Puts Int32 (
Integer) array, throws on failure. |
default void |
putInt64(String fieldName,
long value)
Puts Int64 (
Long) (boxing the given value), throws on failure. |
default void |
putInt64(String fieldName,
Long value)
Puts Int64 (
Long), throws on failure. |
default void |
putInt64Array(String fieldName,
Collection<Long> value)
Puts Int64 (
Long) array (with Collection.toArray(Object[])), throws on failure. |
default void |
putInt64Array(String fieldName,
Long[] value)
Puts Int64 (
Long) array, throws on failure. |
default void |
putLocalizedText(String fieldName,
LocalizedText value)
Puts LocalizedText, throws on failure.
|
default void |
putLocalizedTextArray(String fieldName,
Collection<LocalizedText> value)
Puts LocalizedText array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putLocalizedTextArray(String fieldName,
LocalizedText[] value)
Puts LocalizedText array, throws on failure.
|
default void |
putNodeId(String fieldName,
NodeId value)
Puts NodeId, throws on failure.
|
default void |
putNodeIdArray(String fieldName,
Collection<NodeId> value)
Puts NodeId array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putNodeIdArray(String fieldName,
NodeId[] value)
Puts NodeId array, throws on failure.
|
default void |
putQualifiedName(String fieldName,
QualifiedName value)
Puts QualifiedName, throws on failure.
|
default void |
putQualifiedNameArray(String fieldName,
Collection<QualifiedName> value)
Puts QualifiedName array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putQualifiedNameArray(String fieldName,
QualifiedName[] value)
Puts QualifiedName array, throws on failure.
|
default void |
putSByte(String fieldName,
byte value)
Puts SByte (
Byte), throws on failure. |
default void |
putSByte(String fieldName,
Byte value)
Puts SByte (
Byte), throws on failure. |
default void |
putSByte(String fieldName,
int value)
Puts SByte (
Byte), throws on failure. |
default void |
putSByteArray(String fieldName,
Byte[] value)
Puts SByte (
Byte) array, throws on failure. |
default void |
putSByteArray(String fieldName,
Collection<Byte> value)
Puts SByte (
Byte) array (with Collection.toArray(Object[])), throws on failure. |
default void |
putStatusCode(String fieldName,
StatusCode value)
Puts StatusCode, throws on failure.
|
default void |
putStatusCodeArray(String fieldName,
Collection<StatusCode> value)
Puts StatusCode array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putStatusCodeArray(String fieldName,
StatusCode[] value)
Puts StatusCode array, throws on failure.
|
default void |
putString(String fieldName,
String value)
Puts a
String, throws on failure. |
default void |
putStringArray(String fieldName,
Collection<String> value)
Puts a
String array (by using Collection.toArray(Object[])), throws on failure. |
default void |
putStringArray(String fieldName,
String[] value)
Puts a
String array, throws on failure. |
default void |
putUInt16(String fieldName,
UnsignedShort value)
Puts UInt16 (
UnsignedShort), throws on failure. |
default void |
putUInt16Array(String fieldName,
Collection<UnsignedShort> value)
Puts UInt16 (
UnsignedShort) array (with Collection.toArray(Object[])), throws
on failure. |
default void |
putUInt16Array(String fieldName,
UnsignedShort[] value)
Puts UInt16 (
UnsignedShort) array, throws on failure. |
default void |
putUInt32(String fieldName,
UnsignedInteger value)
Puts UInt32 (
UnsignedInteger), throws on failure. |
default void |
putUInt32Array(String fieldName,
Collection<UnsignedInteger> value)
Puts UInt32 (
UnsignedInteger) array (with Collection.toArray(Object[])), throws
on failure. |
default void |
putUInt32Array(String fieldName,
UnsignedInteger[] value)
Puts UInt32 (
UnsignedInteger) array, throws on failure. |
default void |
putUInt64(String fieldName,
UnsignedLong value)
Puts UInt64 (
UnsignedLong), throws on failure. |
default void |
putUInt64Array(String fieldName,
Collection<UnsignedLong> value)
Puts UInt64 (
UnsignedLong) array (with Collection.toArray(Object[])), throws on
failure. |
default void |
putUInt64Array(String fieldName,
UnsignedLong[] value)
Puts UInt64 (
UnsignedLong) array, throws on failure. |
default void |
putVariant(String fieldName,
Variant value)
Puts Variant, throws on failure.
|
default void |
putVariantArray(String fieldName,
Variant[] value)
Puts Variant array, throws on failure.
|
default void |
putXmlElement(String fieldName,
XmlElement value)
Puts XmlElement, throws on failure.
|
default void |
putXmlElementArray(String fieldName,
Collection<XmlElement> value)
Puts XmlElement array (with
Collection.toArray(Object[])), throws on failure. |
default void |
putXmlElementArray(String fieldName,
XmlElement[] value)
Puts XmlElement array, throws on failure.
|
EncoderContext getEncoderContext()
EncoderContext of this encoder.List<Locale> getLocales()
void put(String fieldName, Object value, UaNodeId dataTypeId, int dimensions) throws EncodingException
fieldName - the name of the field (not used in all encodings e.g. Binary encodings do not
typically use a name, but JSON does).value - the value for the field, possibly null.dataTypeId - the OPC UA DataType of the field, not null.dimensions - the dimensions of the field, 0 if scalar, 1 if 1-dim array, etc.).EncodingException - in case the value cannot be encoded. Possible errors are e.g. giving
wrong DataType for a given value, giving wrong dimensions or giving values that are too
large for limits of the getEncoderContext().default void putBoolean(String fieldName, Boolean value) throws EncodingException
EncodingExceptiondefault void putBooleanArray(String fieldName, Boolean[] value) throws EncodingException
EncodingExceptiondefault void putBooleanArray(String fieldName, Collection<Boolean> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putByte(String fieldName, UnsignedByte value) throws EncodingException
UnsignedByte), throws on failure.EncodingExceptiondefault void putByteArray(String fieldName, Collection<UnsignedByte> value) throws EncodingException
UnsignedByte) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putByteArray(String fieldName, UnsignedByte[] value) throws EncodingException
UnsignedByte) array, throws on failure.EncodingExceptiondefault void putByteString(String fieldName, ByteString value) throws EncodingException
EncodingExceptiondefault void putByteStringArray(String fieldName, ByteString[] value) throws EncodingException
EncodingExceptiondefault void putByteStringArray(String fieldName, Collection<ByteString> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putDataValue(String fieldName, DataValue value) throws EncodingException
EncodingExceptiondefault void putDataValueArray(String fieldName, Collection<DataValue> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putDataValueArray(String fieldName, DataValue[] value) throws EncodingException
EncodingExceptiondefault void putDateTime(String fieldName, DateTime value) throws EncodingException
EncodingExceptiondefault void putDateTimeArray(String fieldName, Collection<DateTime> value) throws EncodingException
EncodingExceptiondefault void putDateTimeArray(String fieldName, DateTime[] value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putDiagnosticInfo(String fieldName, DiagnosticInfo value) throws EncodingException
EncodingExceptiondefault void putDiagnosticInfoArray(String fieldName, Collection<DiagnosticInfo> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putDiagnosticInfoArray(String fieldName, DiagnosticInfo[] value) throws EncodingException
EncodingExceptiondefault void putDouble(String fieldName, double value) throws EncodingException
Double) (boxing the given value), throws on failure.EncodingExceptiondefault void putDouble(String fieldName, Double value) throws EncodingException
Double), throws on failure.EncodingExceptiondefault void putDoubleArray(String fieldName, Collection<Double> value) throws EncodingException
Double) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putDoubleArray(String fieldName, Double[] value) throws EncodingException
Double) array, throws on failure.EncodingExceptiondefault void putExpandedNodeId(String fieldName, ExpandedNodeId value) throws EncodingException
EncodingExceptiondefault void putExpandedNodeIdArray(String fieldName, Collection<ExpandedNodeId> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putExpandedNodeIdArray(String fieldName, ExpandedNodeId[] value) throws EncodingException
EncodingExceptiondefault void putExtensionObject(String fieldName, ExtensionObject value) throws EncodingException
EncodingExceptiondefault void putExtensionObjectArray(String fieldName, Collection<ExtensionObject> value) throws EncodingException
EncodingExceptiondefault void putExtensionObjectArray(String fieldName, ExtensionObject[] value) throws EncodingException
EncodingExceptiondefault void putFloat(String fieldName, float value) throws EncodingException
Float) (boxing the given value), throws on failure.EncodingExceptiondefault void putFloat(String fieldName, Float value) throws EncodingException
Float), throws on failure.EncodingExceptiondefault void putFloatArray(String fieldName, Collection<Float> value) throws EncodingException
Float) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putFloatArray(String fieldName, Float[] value) throws EncodingException
Float) array, throws on failure.EncodingExceptiondefault void putGuid(String fieldName, UUID value) throws EncodingException
UUID), throws on failure.EncodingExceptiondefault void putGuidArray(String fieldName, Collection<UUID> value) throws EncodingException
UUID) array (with Collection.toArray(Object[])),
throws on failure.EncodingExceptiondefault void putGuidArray(String fieldName, UUID[] value) throws EncodingException
UUID) array, throws on failure.EncodingExceptiondefault void putInt16(String fieldName, short value) throws EncodingException
Short) (boxing the given value), throws on failure.EncodingExceptiondefault void putInt16(String fieldName, Short value) throws EncodingException
Short), throws on failure.EncodingExceptiondefault void putInt16Array(String fieldName, Collection<Short> value) throws EncodingException
Short) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putInt16Array(String fieldName, Short[] value) throws EncodingException
Short) array, throws on failure.EncodingExceptiondefault void putInt32(String fieldName, int value) throws EncodingException
Integer) (boxing the given value), throws on failure.EncodingExceptiondefault void putInt32(String fieldName, Integer value) throws EncodingException
Integer), throws on failure.EncodingExceptiondefault void putInt32Array(String fieldName, Collection<Integer> value) throws EncodingException
Integer) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putInt32Array(String fieldName, int[] value) throws EncodingException
Integer) array (int[] converted to Integer[]), throws on failure.EncodingExceptiondefault void putInt32Array(String fieldName, Integer[] value) throws EncodingException
Integer) array, throws on failure.EncodingExceptiondefault void putInt64(String fieldName, long value) throws EncodingException
Long) (boxing the given value), throws on failure.EncodingExceptiondefault void putInt64(String fieldName, Long value) throws EncodingException
Long), throws on failure.EncodingExceptiondefault void putInt64Array(String fieldName, Collection<Long> value) throws EncodingException
Long) array (with Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putInt64Array(String fieldName, Long[] value) throws EncodingException
Long) array, throws on failure.EncodingExceptiondefault void putLocalizedText(String fieldName, LocalizedText value) throws EncodingException
EncodingExceptiondefault void putLocalizedTextArray(String fieldName, Collection<LocalizedText> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putLocalizedTextArray(String fieldName, LocalizedText[] value) throws EncodingException
EncodingExceptiondefault void putNodeId(String fieldName, NodeId value) throws EncodingException
EncodingExceptiondefault void putNodeIdArray(String fieldName, Collection<NodeId> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putNodeIdArray(String fieldName, NodeId[] value) throws EncodingException
EncodingExceptiondefault void putQualifiedName(String fieldName, QualifiedName value) throws EncodingException
EncodingExceptiondefault void putQualifiedNameArray(String fieldName, Collection<QualifiedName> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putQualifiedNameArray(String fieldName, QualifiedName[] value) throws EncodingException
EncodingExceptiondefault void putSByte(String fieldName, byte value) throws EncodingException
Byte), throws on failure.EncodingExceptiondefault void putSByte(String fieldName, Byte value) throws EncodingException
Byte), throws on failure.EncodingExceptiondefault void putSByte(String fieldName, int value) throws EncodingException
Byte), throws on failure.EncodingExceptiondefault void putSByteArray(String fieldName, Byte[] value) throws EncodingException
Byte) array, throws on failure.EncodingExceptiondefault void putSByteArray(String fieldName, Collection<Byte> value) throws EncodingException
Byte) array (with Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putStatusCode(String fieldName, StatusCode value) throws EncodingException
EncodingExceptiondefault void putStatusCodeArray(String fieldName, Collection<StatusCode> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putStatusCodeArray(String fieldName, StatusCode[] value) throws EncodingException
EncodingExceptiondefault void putString(String fieldName, String value) throws EncodingException
String, throws on failure.EncodingExceptiondefault void putStringArray(String fieldName, Collection<String> value) throws EncodingException
String array (by using Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putStringArray(String fieldName, String[] value) throws EncodingException
String array, throws on failure.EncodingExceptiondefault void putUInt16(String fieldName, UnsignedShort value) throws EncodingException
UnsignedShort), throws on failure.EncodingExceptiondefault void putUInt16Array(String fieldName, Collection<UnsignedShort> value) throws EncodingException
UnsignedShort) array (with Collection.toArray(Object[])), throws
on failure.EncodingExceptiondefault void putUInt16Array(String fieldName, UnsignedShort[] value) throws EncodingException
UnsignedShort) array, throws on failure.EncodingExceptiondefault void putUInt32(String fieldName, UnsignedInteger value) throws EncodingException
UnsignedInteger), throws on failure.EncodingExceptiondefault void putUInt32Array(String fieldName, Collection<UnsignedInteger> value) throws EncodingException
UnsignedInteger) array (with Collection.toArray(Object[])), throws
on failure.EncodingExceptiondefault void putUInt32Array(String fieldName, UnsignedInteger[] value) throws EncodingException
UnsignedInteger) array, throws on failure.EncodingExceptiondefault void putUInt64(String fieldName, UnsignedLong value) throws EncodingException
UnsignedLong), throws on failure.EncodingExceptiondefault void putUInt64Array(String fieldName, Collection<UnsignedLong> value) throws EncodingException
UnsignedLong) array (with Collection.toArray(Object[])), throws on
failure.EncodingExceptiondefault void putUInt64Array(String fieldName, UnsignedLong[] value) throws EncodingException
UnsignedLong) array, throws on failure.EncodingExceptiondefault void putVariant(String fieldName, Variant value) throws EncodingException
EncodingExceptiondefault void putVariantArray(String fieldName, Variant[] value) throws EncodingException
EncodingExceptiondefault void putXmlElement(String fieldName, XmlElement value) throws EncodingException
EncodingExceptiondefault void putXmlElementArray(String fieldName, Collection<XmlElement> value) throws EncodingException
Collection.toArray(Object[])), throws on failure.EncodingExceptiondefault void putXmlElementArray(String fieldName, XmlElement[] value) throws EncodingException
EncodingExceptionCopyright © 2026. All rights reserved.