com.prosysopc.ua.stack.encoding.json

Class JsonEncoder

java.lang.Object

com.prosysopc.ua.stack.encoding.AbstactEncoder

com.prosysopc.ua.stack.encoding.json.JsonEncoder

All Implemented Interfaces:

IEncoder

public class JsonEncoder
extends AbstactEncoder
implements IEncoder

JSON encoder related to Part 6. Note that there are 4 encoding modes in JSON: Verbose, compact, reversible and non-reversible. The latter two are considered to be legacy encoding modes.

Field Summary

Fields inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

ctx

Constructor Summary

Constructors

Constructor and Description
JsonEncoder(EncoderContext encoderContext, JsonEncodingMode mode, Writer writer) Creates a new JsonEncoder that will write to the given output.

Method Summary

Modifier and Type	Method and Description
void	beginArray()
void	beginArray(String fieldName)
void	beginObject()
void	beginObject(String fieldName)
void	close()
void	endArray()
void	endObject()
JsonEncodingMode	getEncodingMode() Returns the JsonEncodingMode of this JsonEncoder.
List<Locale>	getLocales() The current Locale preferences.
void	put(String fieldName, Object value, UaNodeId dataTypeId, int dimensions) Encodes the given field.
void	putArrayElement(Object value)
void	putComma()
void	putDataValue(String fieldName, DataValue value, DataSetFieldContentMask fieldContentMask, UaNodeId dataSetFieldDataType, int valueRank) Puts a DataValue, NOTE! this is only intended to be used by the SDK itself related to Part 14 PubSub.
void	putObject(String fieldName, Object value) Deprecated.
void	putSByte(String fieldName, int value) Puts SByte (Byte), throws on failure.
void	putStructure(String fieldName, Structure value) Deprecated.
void	putVariantArray(String fieldName, Collection<Variant> value) Deprecated.
String	toString()

Methods inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

getEncoderContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.stack.encoding.IEncoder

getEncoderContext, putBoolean, putBooleanArray, putBooleanArray, putByte, putByteArray, putByteArray, putByteString, putByteStringArray, putByteStringArray, putDataValue, putDataValueArray, putDataValueArray, putDateTime, putDateTimeArray, putDateTimeArray, putDiagnosticInfo, putDiagnosticInfoArray, putDiagnosticInfoArray, putDouble, putDouble, putDoubleArray, putDoubleArray, putExpandedNodeId, putExpandedNodeIdArray, putExpandedNodeIdArray, putExtensionObject, putExtensionObjectArray, putExtensionObjectArray, putFloat, putFloat, putFloatArray, putFloatArray, putGuid, putGuidArray, putGuidArray, putInt16, putInt16, putInt16Array, putInt16Array, putInt32, putInt32, putInt32Array, putInt32Array, putInt32Array, putInt64, putInt64, putInt64Array, putInt64Array, putLocalizedText, putLocalizedTextArray, putLocalizedTextArray, putNodeId, putNodeIdArray, putNodeIdArray, putQualifiedName, putQualifiedNameArray, putQualifiedNameArray, putSByte, putSByte, putSByteArray, putSByteArray, putStatusCode, putStatusCodeArray, putStatusCodeArray, putString, putStringArray, putStringArray, putUInt16, putUInt16Array, putUInt16Array, putUInt32, putUInt32Array, putUInt32Array, putUInt64, putUInt64Array, putUInt64Array, putVariant, putVariantArray, putXmlElement, putXmlElementArray, putXmlElementArray

Constructor Detail

JsonEncoder

public JsonEncoder(EncoderContext encoderContext,
                   JsonEncodingMode mode,
                   Writer writer)

Creates a new JsonEncoder that will write to the given output.

Method Detail

beginArray

public void beginArray()
                throws EncodingException

Throws:

EncodingException

beginArray

public void beginArray(String fieldName)
                throws EncodingException

Throws:

EncodingException

beginObject

public void beginObject()
                 throws EncodingException

Throws:

EncodingException

beginObject

public void beginObject(String fieldName)
                 throws EncodingException

Throws:

EncodingException

close

public void close()
           throws EncodingException

Throws:

EncodingException

endArray

public void endArray()
              throws EncodingException

Throws:

EncodingException

endObject

public void endObject()
               throws EncodingException

Throws:

EncodingException

getEncodingMode

public JsonEncodingMode getEncodingMode()

Returns the JsonEncodingMode of this JsonEncoder.

getLocales

public List<Locale> getLocales()

Description copied from interface: IEncoder

The current Locale preferences. When encoding localized data, the first index is preferred, then second etc., until there is a direct match. If there are no direct matches (or this list is empty), one of the values or an "invariant locale" (i.e. typically the one for locale==null case) value is returned. Note! this is only used in the server side, in the client side there is only a single locale at a time (when encoding messages to be sent to the server), while the server will encode the messages based on the client's localization preferences.

Specified by:

getLocales in interface IEncoder

put

public void put(String fieldName,
                Object value,
                UaNodeId dataTypeId,
                int dimensions)
         throws EncodingException

Description copied from interface: IEncoder

Encodes the given field.

Specified by:

put in interface IEncoder

Parameters:

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.).

Throws:

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 IEncoder.getEncoderContext().

putArrayElement

public void putArrayElement(Object value)
                     throws EncodingException

Throws:

EncodingException

putComma

public void putComma()
              throws EncodingException

Throws:

EncodingException

putDataValue

public void putDataValue(String fieldName,
                         DataValue value,
                         DataSetFieldContentMask fieldContentMask,
                         UaNodeId dataSetFieldDataType,
                         int valueRank)
                  throws EncodingException

Puts a DataValue, NOTE! this is only intended to be used by the SDK itself related to Part 14 PubSub.

Throws:

EncodingException

putObject

@Deprecated
public void putObject(String fieldName,
                                   Object value)
                            throws EncodingException

Deprecated.

Throws:

EncodingException

putSByte

public void putSByte(String fieldName,
                     int value)
              throws EncodingException

Description copied from interface: IEncoder

Puts SByte (Byte), throws on failure.

Specified by:

putSByte in interface IEncoder

Throws:

EncodingException

putStructure

@Deprecated
public void putStructure(String fieldName,
                                      Structure value)
                               throws EncodingException

Deprecated.

Throws:

EncodingException

putVariantArray

@Deprecated
public void putVariantArray(String fieldName,
                                         Collection<Variant> value)
                                  throws EncodingException

Deprecated.

Throws:

EncodingException

toString

public String toString()

Overrides:

toString in class Object