com.prosysopc.ua.stack.encoding.json

Enum JsonEncodingMode

java.lang.Object

java.lang.Enum<JsonEncodingMode>

com.prosysopc.ua.stack.encoding.json.JsonEncodingMode

All Implemented Interfaces:

Serializable, Comparable<JsonEncodingMode>

public enum JsonEncodingMode
extends Enum<JsonEncodingMode>

OPC UA has multiple different JSON flavors, this is used to select which one is being used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT Defined in OPC UA 1.05.04, omits default values of Structure fields etc.
LEGACY_NON_REVERSIBLE Legacy format that was used before 1.05.04.
LEGACY_REVERSIBLE Legacy format that was used before 1.05.04.
VERBOSE Defined in OPC UA 1.05.04, doesn't omit optional fields nor default values and in some cases adds additional description fields to the output.

Method Summary

Modifier and Type	Method and Description
static JsonEncodingMode	from(JsonDataSetMessageContentMask contentMask) Returns mode based on the FieldEncoding1 and FieldEncoding2 bits as described in https://reference.opcfoundation.org/Core/Part14/v105/docs/6.3.2.3.1.
boolean	isLegacy()
static JsonEncodingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JsonEncodingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEGACY_REVERSIBLE

public static final JsonEncodingMode LEGACY_REVERSIBLE

Legacy format that was used before 1.05.04.

LEGACY_NON_REVERSIBLE

public static final JsonEncodingMode LEGACY_NON_REVERSIBLE

Legacy format that was used before 1.05.04.

COMPACT

public static final JsonEncodingMode COMPACT

Defined in OPC UA 1.05.04, omits default values of Structure fields etc. offers more "compact" output, but decoders must be aware of suitable default values.

VERBOSE

public static final JsonEncodingMode VERBOSE

Defined in OPC UA 1.05.04, doesn't omit optional fields nor default values and in some cases adds additional description fields to the output.

Method Detail

values

public static JsonEncodingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JsonEncodingMode c : JsonEncodingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JsonEncodingMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

from

public static JsonEncodingMode from(JsonDataSetMessageContentMask contentMask)

Returns mode based on the FieldEncoding1 and FieldEncoding2 bits as described in https://reference.opcfoundation.org/Core/Part14/v105/docs/6.3.2.3.1. Null input is the same as no bits set.

isLegacy

public boolean isLegacy()