org.opcfoundation.ua.encoding.binary
Class BinaryEncoder

java.lang.Object
  extended by org.opcfoundation.ua.encoding.binary.BinaryEncoder
All Implemented Interfaces:
IEncoder

public class BinaryEncoder
extends Object
implements IEncoder

Encodes builtintypes, enumerations, structures and messages to a byte buffer.

Null valued arguments are encoded with default empty values when encoder mode is NonStrict.

Author:
Toni Kalajainen (toni.kalajainen@vtt.fi)
See Also:
Calculates lengths of messages, encoder interface, binary decoder

Field Summary
static Charset UTF8
          Constant UTF8
 
Constructor Summary
BinaryEncoder(byte[] buf)
          Constructor for BinaryEncoder.
BinaryEncoder(byte[] buf, int off, int len)
          Constructor for BinaryEncoder.
BinaryEncoder(ByteBuffer buf)
          Constructor for BinaryEncoder.
BinaryEncoder(IBinaryWriteable out)
          Constructor for BinaryEncoder.
BinaryEncoder(OutputStream os)
          Constructor for BinaryEncoder.
 
Method Summary
 EncoderContext getEncoderContext()
          getEncoderContext.
 EncoderMode getEncoderType()
          getEncoderType.
 IBinaryWriteable getOutput()
          getOutput.
 IBinaryWriteable getWriteable()
          getWriteable.
 void put(String fieldName, Object o)
          put.
 void put(String fieldName, Object o, Class<?> clazz)
          put.
 void putArray(String fieldName, int builtinType, Object o)
          putArray.
 void putBoolean(String fieldName, Boolean v)
          putBoolean.
 void putBooleanArray(String fieldName, Boolean[] v)
          putBooleanArray.
 void putBooleanArray(String fieldName, Collection<Boolean> v)
          putBooleanArray.
 void putByte(String fieldName, UnsignedByte v)
          putByte.
 void putByteArray(String fieldName, Collection<UnsignedByte> v)
          putByteArray.
 void putByteArray(String fieldName, UnsignedByte[] v)
          putByteArray.
 void putByteString(String fieldName, ByteString v)
          putByteString.
 void putByteStringArray(String fieldName, ByteString[] v)
          putByteStringArray.
 void putByteStringArray(String fieldName, Collection<ByteString> v)
          putByteStringArray.
 void putDataValue(String fieldName, DataValue v)
          putDataValue.
 void putDataValueArray(String fieldName, Collection<DataValue> v)
          putDataValueArray.
 void putDataValueArray(String fieldName, DataValue[] v)
          putDataValueArray.
 void putDateTime(String fieldName, DateTime v)
          putDateTime.
 void putDateTimeArray(String fieldName, Collection<DateTime> v)
          putDateTimeArray.
 void putDateTimeArray(String fieldName, DateTime[] v)
          putDateTimeArray.
 void putDiagnosticInfo(String fieldName, DiagnosticInfo v)
          putDiagnosticInfo.
 void putDiagnosticInfoArray(String fieldName, Collection<DiagnosticInfo> v)
          putDiagnosticInfoArray.
 void putDiagnosticInfoArray(String fieldName, DiagnosticInfo[] v)
          putDiagnosticInfoArray.
 void putDouble(String fieldName, double v)
          putDouble.
 void putDouble(String fieldName, Double v)
          putDouble.
 void putDoubleArray(String fieldName, Collection<Double> v)
          putDoubleArray.
 void putDoubleArray(String fieldName, Double[] v)
          putDoubleArray.
 void putEncodeable(String fieldName, Class<? extends IEncodeable> clazz, IEncodeable s)
          putEncodeable.
 void putEncodeable(String fieldName, IEncodeable s)
          putEncodeable.
 void putEncodeableArray(String fieldName, Class<? extends IEncodeable> clazz, Object array)
          putEncodeableArray.
 void putEnumeration(String fieldName, Enumeration v)
          putEnumeration.
 void putEnumerationArray(String fieldName, Object array)
          putEnumerationArray.
 void putExpandedNodeId(String fieldName, ExpandedNodeId v)
          putExpandedNodeId.
 void putExpandedNodeIdArray(String fieldName, Collection<ExpandedNodeId> v)
          putExpandedNodeIdArray.
 void putExpandedNodeIdArray(String fieldName, ExpandedNodeId[] v)
          putExpandedNodeIdArray.
 void putExtensionObject(String fieldName, ExtensionObject v)
          putExtensionObject.
 void putExtensionObjectArray(String fieldName, Collection<ExtensionObject> v)
          putExtensionObjectArray.
 void putExtensionObjectArray(String fieldName, ExtensionObject[] v)
          putExtensionObjectArray.
 void putFloat(String fieldName, float v)
          putFloat.
 void putFloat(String fieldName, Float v)
          putFloat.
 void putFloatArray(String fieldName, Collection<Float> v)
          putFloatArray.
 void putFloatArray(String fieldName, Float[] v)
          putFloatArray.
 void putGuid(String fieldName, UUID v)
          putGuid.
 void putGuidArray(String fieldName, Collection<UUID> v)
          putGuidArray.
 void putGuidArray(String fieldName, UUID[] v)
          putGuidArray.
 void putInt16(String fieldName, short v)
          putInt16.
 void putInt16(String fieldName, Short v)
          putInt16.
 void putInt16Array(String fieldName, Collection<Short> v)
          putInt16Array.
 void putInt16Array(String fieldName, Short[] v)
          putInt16Array.
 void putInt32(String fieldName, int v)
          putInt32.
 void putInt32(String fieldName, Integer v)
          putInt32.
 void putInt32Array(String fieldName, Collection<Integer> v)
          putInt32Array.
 void putInt32Array(String fieldName, int[] v)
          putInt32Array.
 void putInt32Array(String fieldName, Integer[] v)
          putInt32Array.
 void putInt64(String fieldName, long v)
          putInt64.
 void putInt64(String fieldName, Long v)
          putInt64.
 void putInt64Array(String fieldName, Collection<Long> v)
          putInt64Array.
 void putInt64Array(String fieldName, Long[] v)
          putInt64Array.
 void putLocalizedText(String fieldName, LocalizedText v)
          putLocalizedText.
 void putLocalizedTextArray(String fieldName, Collection<LocalizedText> v)
          putLocalizedTextArray.
 void putLocalizedTextArray(String fieldName, LocalizedText[] v)
          putLocalizedTextArray.
 void putMessage(IEncodeable s)
          putMessage.
 void putNodeId(String fieldName, NodeId v)
          putNodeId.
 void putNodeIdArray(String fieldName, Collection<NodeId> v)
          putNodeIdArray.
 void putNodeIdArray(String fieldName, NodeId[] v)
          putNodeIdArray.
 void putObject(String fieldName, Class<?> c, Object o)
          putObject.
 void putObject(String fieldName, Object o)
          putObject.
 void putQualifiedName(String fieldName, QualifiedName v)
          putQualifiedName.
 void putQualifiedNameArray(String fieldName, Collection<QualifiedName> v)
          putQualifiedNameArray.
 void putQualifiedNameArray(String fieldName, QualifiedName[] v)
          putQualifiedNameArray.
 void putSByte(String fieldName, byte v)
          putSByte.
 void putSByte(String fieldName, Byte v)
          putSByte.
 void putSByte(String fieldName, int v)
          putSByte.
 void putSByteArray(String fieldName, Byte[] v)
          putSByteArray.
 void putSByteArray(String fieldName, Collection<Byte> v)
          putSByteArray.
 void putScalar(String fieldName, int builtinType, Object o)
          putScalar.
 void putStatusCode(String fieldName, StatusCode v)
          putStatusCode.
 void putStatusCodeArray(String fieldName, Collection<StatusCode> v)
          putStatusCodeArray.
 void putStatusCodeArray(String fieldName, StatusCode[] v)
          putStatusCodeArray.
 void putString(String fieldName, String v)
          putString.
 void putStringArray(String fieldName, Collection<String> v)
          putStringArray.
 void putStringArray(String fieldName, String[] v)
          putStringArray.
 void putStructure(String fieldName, Structure v)
          putStructure.
 void putStructureArray(String fieldName, Collection<Structure> v)
          putStructureArray.
 void putStructureArray(String fieldName, Structure[] v)
          putStructureArray.
 void putUInt16(String fieldName, UnsignedShort v)
          putUInt16.
 void putUInt16Array(String fieldName, Collection<UnsignedShort> v)
          putUInt16Array.
 void putUInt16Array(String fieldName, UnsignedShort[] v)
          putUInt16Array.
 void putUInt32(String fieldName, UnsignedInteger v)
          putUInt32.
 void putUInt32Array(String fieldName, Collection<UnsignedInteger> v)
          putUInt32Array.
 void putUInt32Array(String fieldName, UnsignedInteger[] v)
          putUInt32Array.
 void putUInt64(String fieldName, UnsignedLong v)
          putUInt64.
 void putUInt64Array(String fieldName, Collection<UnsignedLong> v)
          putUInt64Array.
 void putUInt64Array(String fieldName, UnsignedLong[] v)
          putUInt64Array.
 void putVariant(String fieldName, Variant v)
          putVariant.
 void putVariantArray(String fieldName, Collection<Variant> v)
          putVariantArray.
 void putVariantArray(String fieldName, Variant[] v)
          putVariantArray.
 void putXmlElement(String fieldName, XmlElement v)
          putXmlElement.
 void putXmlElementArray(String fieldName, Collection<XmlElement> v)
          putXmlElementArray.
 void putXmlElementArray(String fieldName, XmlElement[] v)
          putXmlElementArray.
 void setEncoderContext(EncoderContext ctx)
          setEncoderContext.
 void setEncoderMode(EncoderMode type)
          Set encoding mode.
 void setWriteable(IBinaryWriteable out)
          setWriteable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UTF8

public static final Charset UTF8
Constant UTF8

Constructor Detail

BinaryEncoder

public BinaryEncoder(IBinaryWriteable out)

Constructor for BinaryEncoder.

Parameters:
out - a IBinaryWriteable object.

BinaryEncoder

public BinaryEncoder(OutputStream os)

Constructor for BinaryEncoder.

Parameters:
os - a OutputStream object.

BinaryEncoder

public BinaryEncoder(ByteBuffer buf)

Constructor for BinaryEncoder.

Parameters:
buf - a ByteBuffer object.

BinaryEncoder

public BinaryEncoder(byte[] buf)

Constructor for BinaryEncoder.

Parameters:
buf - an array of byte.

BinaryEncoder

public BinaryEncoder(byte[] buf,
                     int off,
                     int len)

Constructor for BinaryEncoder.

Parameters:
buf - an array of byte.
off - a int.
len - a int.
Method Detail

getEncoderContext

public EncoderContext getEncoderContext()

getEncoderContext.

Returns:
a EncoderContext object.

setEncoderContext

public void setEncoderContext(EncoderContext ctx)

setEncoderContext.

Parameters:
ctx - a EncoderContext object.

setWriteable

public void setWriteable(IBinaryWriteable out)

setWriteable.

Parameters:
out - a IBinaryWriteable object.

getWriteable

public IBinaryWriteable getWriteable()

getWriteable.

Returns:
a IBinaryWriteable object.

getOutput

public IBinaryWriteable getOutput()

getOutput.

Returns:
a IBinaryWriteable object.

getEncoderType

public EncoderMode getEncoderType()

getEncoderType.

Returns:
a EncoderMode object.

setEncoderMode

public void setEncoderMode(EncoderMode type)
Set encoding mode. If Strict, null values cannot be encoded. If Slack then nulls are encoded with empty default values.

Parameters:
type - encoder type

putBoolean

public void putBoolean(String fieldName,
                       Boolean v)
                throws EncodingException

putBoolean.

Specified by:
putBoolean in interface IEncoder
Parameters:
fieldName - a String object.
v - a Boolean object.
Throws:
EncodingException - if any.

putBooleanArray

public void putBooleanArray(String fieldName,
                            Boolean[] v)
                     throws EncodingException

putBooleanArray.

Specified by:
putBooleanArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Boolean objects.
Throws:
EncodingException - if any.

putBooleanArray

public void putBooleanArray(String fieldName,
                            Collection<Boolean> v)
                     throws EncodingException

putBooleanArray.

Specified by:
putBooleanArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putSByte

public void putSByte(String fieldName,
                     Byte v)
              throws EncodingException

putSByte.

Specified by:
putSByte in interface IEncoder
Parameters:
fieldName - a String object.
v - a Byte object.
Throws:
EncodingException - if any.

putSByte

public void putSByte(String fieldName,
                     byte v)
              throws EncodingException

putSByte.

Specified by:
putSByte in interface IEncoder
Parameters:
fieldName - a String object.
v - a byte.
Throws:
EncodingException - if any.

putSByte

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

putSByte.

Specified by:
putSByte in interface IEncoder
Parameters:
fieldName - a String object.
v - a int.
Throws:
EncodingException - if any.

putSByteArray

public void putSByteArray(String fieldName,
                          Byte[] v)
                   throws EncodingException

putSByteArray.

Specified by:
putSByteArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Byte objects.
Throws:
EncodingException - if any.

putSByteArray

public void putSByteArray(String fieldName,
                          Collection<Byte> v)
                   throws EncodingException

putSByteArray.

Specified by:
putSByteArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putByte

public void putByte(String fieldName,
                    UnsignedByte v)
             throws EncodingException

putByte.

Specified by:
putByte in interface IEncoder
Parameters:
fieldName - a String object.
v - a UnsignedByte object.
Throws:
EncodingException - if any.

putByteArray

public void putByteArray(String fieldName,
                         UnsignedByte[] v)
                  throws EncodingException

putByteArray.

Specified by:
putByteArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of UnsignedByte objects.
Throws:
EncodingException - if any.

putByteArray

public void putByteArray(String fieldName,
                         Collection<UnsignedByte> v)
                  throws EncodingException

putByteArray.

Specified by:
putByteArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putInt16

public void putInt16(String fieldName,
                     Short v)
              throws EncodingException

putInt16.

Specified by:
putInt16 in interface IEncoder
Parameters:
fieldName - a String object.
v - a Short object.
Throws:
EncodingException - if any.

putInt16

public void putInt16(String fieldName,
                     short v)
              throws EncodingException

putInt16.

Specified by:
putInt16 in interface IEncoder
Parameters:
fieldName - a String object.
v - a short.
Throws:
EncodingException - if any.

putInt16Array

public void putInt16Array(String fieldName,
                          Short[] v)
                   throws EncodingException

putInt16Array.

Specified by:
putInt16Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Short objects.
Throws:
EncodingException - if any.

putInt16Array

public void putInt16Array(String fieldName,
                          Collection<Short> v)
                   throws EncodingException

putInt16Array.

Specified by:
putInt16Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putUInt16

public void putUInt16(String fieldName,
                      UnsignedShort v)
               throws EncodingException

putUInt16.

Specified by:
putUInt16 in interface IEncoder
Parameters:
fieldName - a String object.
v - a UnsignedShort object.
Throws:
EncodingException - if any.

putUInt16Array

public void putUInt16Array(String fieldName,
                           UnsignedShort[] v)
                    throws EncodingException

putUInt16Array.

Specified by:
putUInt16Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of UnsignedShort objects.
Throws:
EncodingException - if any.

putUInt16Array

public void putUInt16Array(String fieldName,
                           Collection<UnsignedShort> v)
                    throws EncodingException

putUInt16Array.

Specified by:
putUInt16Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putInt32

public void putInt32(String fieldName,
                     Integer v)
              throws EncodingException

putInt32.

Specified by:
putInt32 in interface IEncoder
Parameters:
fieldName - a String object.
v - a Integer object.
Throws:
EncodingException - if any.

putInt32

public void putInt32(String fieldName,
                     int v)
              throws EncodingException

putInt32.

Specified by:
putInt32 in interface IEncoder
Parameters:
fieldName - a String object.
v - a int.
Throws:
EncodingException - if any.

putInt32Array

public void putInt32Array(String fieldName,
                          int[] v)
                   throws EncodingException

putInt32Array.

Specified by:
putInt32Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of int.
Throws:
EncodingException - if any.

putInt32Array

public void putInt32Array(String fieldName,
                          Collection<Integer> v)
                   throws EncodingException

putInt32Array.

Specified by:
putInt32Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putInt32Array

public void putInt32Array(String fieldName,
                          Integer[] v)
                   throws EncodingException

putInt32Array.

Specified by:
putInt32Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Integer objects.
Throws:
EncodingException - if any.

putUInt32

public void putUInt32(String fieldName,
                      UnsignedInteger v)
               throws EncodingException

putUInt32.

Specified by:
putUInt32 in interface IEncoder
Parameters:
fieldName - a String object.
v - a UnsignedInteger object.
Throws:
EncodingException - if any.

putUInt32Array

public void putUInt32Array(String fieldName,
                           UnsignedInteger[] v)
                    throws EncodingException

putUInt32Array.

Specified by:
putUInt32Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of UnsignedInteger objects.
Throws:
EncodingException - if any.

putUInt32Array

public void putUInt32Array(String fieldName,
                           Collection<UnsignedInteger> v)
                    throws EncodingException

putUInt32Array.

Specified by:
putUInt32Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putInt64

public void putInt64(String fieldName,
                     Long v)
              throws EncodingException

putInt64.

Specified by:
putInt64 in interface IEncoder
Parameters:
fieldName - a String object.
v - a Long object.
Throws:
EncodingException - if any.

putInt64

public void putInt64(String fieldName,
                     long v)
              throws EncodingException

putInt64.

Specified by:
putInt64 in interface IEncoder
Parameters:
fieldName - a String object.
v - a long.
Throws:
EncodingException - if any.

putInt64Array

public void putInt64Array(String fieldName,
                          Long[] v)
                   throws EncodingException

putInt64Array.

Specified by:
putInt64Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Long objects.
Throws:
EncodingException - if any.

putInt64Array

public void putInt64Array(String fieldName,
                          Collection<Long> v)
                   throws EncodingException

putInt64Array.

Specified by:
putInt64Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putUInt64

public void putUInt64(String fieldName,
                      UnsignedLong v)
               throws EncodingException

putUInt64.

Specified by:
putUInt64 in interface IEncoder
Parameters:
fieldName - a String object.
v - a UnsignedLong object.
Throws:
EncodingException - if any.

putUInt64Array

public void putUInt64Array(String fieldName,
                           UnsignedLong[] v)
                    throws EncodingException

putUInt64Array.

Specified by:
putUInt64Array in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of UnsignedLong objects.
Throws:
EncodingException - if any.

putUInt64Array

public void putUInt64Array(String fieldName,
                           Collection<UnsignedLong> v)
                    throws EncodingException

putUInt64Array.

Specified by:
putUInt64Array in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putFloat

public void putFloat(String fieldName,
                     Float v)
              throws EncodingException

putFloat.

Specified by:
putFloat in interface IEncoder
Parameters:
fieldName - a String object.
v - a Float object.
Throws:
EncodingException - if any.

putFloat

public void putFloat(String fieldName,
                     float v)
              throws EncodingException

putFloat.

Specified by:
putFloat in interface IEncoder
Parameters:
fieldName - a String object.
v - a float.
Throws:
EncodingException - if any.

putFloatArray

public void putFloatArray(String fieldName,
                          Float[] v)
                   throws EncodingException

putFloatArray.

Specified by:
putFloatArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Float objects.
Throws:
EncodingException - if any.

putFloatArray

public void putFloatArray(String fieldName,
                          Collection<Float> v)
                   throws EncodingException

putFloatArray.

Specified by:
putFloatArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putDouble

public void putDouble(String fieldName,
                      Double v)
               throws EncodingException

putDouble.

Specified by:
putDouble in interface IEncoder
Parameters:
fieldName - a String object.
v - a Double object.
Throws:
EncodingException - if any.

putDouble

public void putDouble(String fieldName,
                      double v)
               throws EncodingException

putDouble.

Specified by:
putDouble in interface IEncoder
Parameters:
fieldName - a String object.
v - a double.
Throws:
EncodingException - if any.

putDoubleArray

public void putDoubleArray(String fieldName,
                           Double[] v)
                    throws EncodingException

putDoubleArray.

Specified by:
putDoubleArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Double objects.
Throws:
EncodingException - if any.

putDoubleArray

public void putDoubleArray(String fieldName,
                           Collection<Double> v)
                    throws EncodingException

putDoubleArray.

Specified by:
putDoubleArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putString

public void putString(String fieldName,
                      String v)
               throws EncodingException

putString.

Specified by:
putString in interface IEncoder
Parameters:
fieldName - a String object.
v - a String object.
Throws:
EncodingException - if any.

putStringArray

public void putStringArray(String fieldName,
                           Collection<String> v)
                    throws EncodingException

putStringArray.

Specified by:
putStringArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putStringArray

public void putStringArray(String fieldName,
                           String[] v)
                    throws EncodingException

putStringArray.

Specified by:
putStringArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of String objects.
Throws:
EncodingException - if any.

putDateTime

public void putDateTime(String fieldName,
                        DateTime v)
                 throws EncodingException

putDateTime.

Specified by:
putDateTime in interface IEncoder
Parameters:
fieldName - a String object.
v - a DateTime object.
Throws:
EncodingException - if any.

putDateTimeArray

public void putDateTimeArray(String fieldName,
                             DateTime[] v)
                      throws EncodingException

putDateTimeArray.

Specified by:
putDateTimeArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of DateTime objects.
Throws:
EncodingException - if any.

putDateTimeArray

public void putDateTimeArray(String fieldName,
                             Collection<DateTime> v)
                      throws EncodingException

putDateTimeArray.

Specified by:
putDateTimeArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putGuid

public void putGuid(String fieldName,
                    UUID v)
             throws EncodingException

putGuid.

Specified by:
putGuid in interface IEncoder
Parameters:
fieldName - a String object.
v - a UUID object.
Throws:
EncodingException - if any.

putGuidArray

public void putGuidArray(String fieldName,
                         UUID[] v)
                  throws EncodingException

putGuidArray.

Specified by:
putGuidArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of UUID objects.
Throws:
EncodingException - if any.

putGuidArray

public void putGuidArray(String fieldName,
                         Collection<UUID> v)
                  throws EncodingException

putGuidArray.

Specified by:
putGuidArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putByteString

public void putByteString(String fieldName,
                          ByteString v)
                   throws EncodingException

putByteString.

Specified by:
putByteString in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of byte.
Throws:
EncodingException - if any.

putByteStringArray

public void putByteStringArray(String fieldName,
                               ByteString[] v)
                        throws EncodingException

putByteStringArray.

Specified by:
putByteStringArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of byte.
Throws:
EncodingException - if any.

putByteStringArray

public void putByteStringArray(String fieldName,
                               Collection<ByteString> v)
                        throws EncodingException

putByteStringArray.

Specified by:
putByteStringArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putXmlElement

public void putXmlElement(String fieldName,
                          XmlElement v)
                   throws EncodingException

putXmlElement.

Specified by:
putXmlElement in interface IEncoder
Parameters:
fieldName - a String object.
v - a XmlElement object.
Throws:
EncodingException - if any.

putXmlElementArray

public void putXmlElementArray(String fieldName,
                               XmlElement[] v)
                        throws EncodingException

putXmlElementArray.

Specified by:
putXmlElementArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of XmlElement objects.
Throws:
EncodingException - if any.

putXmlElementArray

public void putXmlElementArray(String fieldName,
                               Collection<XmlElement> v)
                        throws EncodingException

putXmlElementArray.

Specified by:
putXmlElementArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putNodeId

public void putNodeId(String fieldName,
                      NodeId v)
               throws EncodingException

putNodeId.

Specified by:
putNodeId in interface IEncoder
Parameters:
fieldName - a String object.
v - a NodeId object.
Throws:
EncodingException - if any.

putNodeIdArray

public void putNodeIdArray(String fieldName,
                           NodeId[] v)
                    throws EncodingException

putNodeIdArray.

Specified by:
putNodeIdArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of NodeId objects.
Throws:
EncodingException - if any.

putNodeIdArray

public void putNodeIdArray(String fieldName,
                           Collection<NodeId> v)
                    throws EncodingException

putNodeIdArray.

Specified by:
putNodeIdArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putExpandedNodeId

public void putExpandedNodeId(String fieldName,
                              ExpandedNodeId v)
                       throws EncodingException

putExpandedNodeId.

Specified by:
putExpandedNodeId in interface IEncoder
Parameters:
fieldName - a String object.
v - a ExpandedNodeId object.
Throws:
EncodingException - if any.

putExpandedNodeIdArray

public void putExpandedNodeIdArray(String fieldName,
                                   ExpandedNodeId[] v)
                            throws EncodingException

putExpandedNodeIdArray.

Specified by:
putExpandedNodeIdArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of ExpandedNodeId objects.
Throws:
EncodingException - if any.

putExpandedNodeIdArray

public void putExpandedNodeIdArray(String fieldName,
                                   Collection<ExpandedNodeId> v)
                            throws EncodingException

putExpandedNodeIdArray.

Specified by:
putExpandedNodeIdArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putStatusCode

public void putStatusCode(String fieldName,
                          StatusCode v)
                   throws EncodingException

putStatusCode.

Specified by:
putStatusCode in interface IEncoder
Parameters:
fieldName - a String object.
v - a StatusCode object.
Throws:
EncodingException - if any.

putStatusCodeArray

public void putStatusCodeArray(String fieldName,
                               StatusCode[] v)
                        throws EncodingException

putStatusCodeArray.

Specified by:
putStatusCodeArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of StatusCode objects.
Throws:
EncodingException - if any.

putStatusCodeArray

public void putStatusCodeArray(String fieldName,
                               Collection<StatusCode> v)
                        throws EncodingException

putStatusCodeArray.

Specified by:
putStatusCodeArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putQualifiedName

public void putQualifiedName(String fieldName,
                             QualifiedName v)
                      throws EncodingException

putQualifiedName.

Specified by:
putQualifiedName in interface IEncoder
Parameters:
fieldName - a String object.
v - a QualifiedName object.
Throws:
EncodingException - if any.

putQualifiedNameArray

public void putQualifiedNameArray(String fieldName,
                                  QualifiedName[] v)
                           throws EncodingException

putQualifiedNameArray.

Specified by:
putQualifiedNameArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of QualifiedName objects.
Throws:
EncodingException - if any.

putQualifiedNameArray

public void putQualifiedNameArray(String fieldName,
                                  Collection<QualifiedName> v)
                           throws EncodingException

putQualifiedNameArray.

Specified by:
putQualifiedNameArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putLocalizedText

public void putLocalizedText(String fieldName,
                             LocalizedText v)
                      throws EncodingException

putLocalizedText.

Specified by:
putLocalizedText in interface IEncoder
Parameters:
fieldName - a String object.
v - a LocalizedText object.
Throws:
EncodingException - if any.

putLocalizedTextArray

public void putLocalizedTextArray(String fieldName,
                                  LocalizedText[] v)
                           throws EncodingException

putLocalizedTextArray.

Specified by:
putLocalizedTextArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of LocalizedText objects.
Throws:
EncodingException - if any.

putLocalizedTextArray

public void putLocalizedTextArray(String fieldName,
                                  Collection<LocalizedText> v)
                           throws EncodingException

putLocalizedTextArray.

Specified by:
putLocalizedTextArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putStructure

public void putStructure(String fieldName,
                         Structure v)
                  throws EncodingException

putStructure.

Specified by:
putStructure in interface IEncoder
Parameters:
fieldName - a String object.
v - a Structure object.
Throws:
EncodingException - if any.

putStructureArray

public void putStructureArray(String fieldName,
                              Structure[] v)
                       throws EncodingException

putStructureArray.

Specified by:
putStructureArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Structure objects.
Throws:
EncodingException - if any.

putStructureArray

public void putStructureArray(String fieldName,
                              Collection<Structure> v)
                       throws EncodingException

putStructureArray.

Specified by:
putStructureArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putExtensionObject

public void putExtensionObject(String fieldName,
                               ExtensionObject v)
                        throws EncodingException

putExtensionObject.

Specified by:
putExtensionObject in interface IEncoder
Parameters:
fieldName - a String object.
v - a ExtensionObject object.
Throws:
EncodingException - if any.

putExtensionObjectArray

public void putExtensionObjectArray(String fieldName,
                                    ExtensionObject[] v)
                             throws EncodingException

putExtensionObjectArray.

Specified by:
putExtensionObjectArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of ExtensionObject objects.
Throws:
EncodingException - if any.

putExtensionObjectArray

public void putExtensionObjectArray(String fieldName,
                                    Collection<ExtensionObject> v)
                             throws EncodingException

putExtensionObjectArray.

Specified by:
putExtensionObjectArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putDataValue

public void putDataValue(String fieldName,
                         DataValue v)
                  throws EncodingException

putDataValue.

Specified by:
putDataValue in interface IEncoder
Parameters:
fieldName - a String object.
v - a DataValue object.
Throws:
EncodingException - if any.

putDataValueArray

public void putDataValueArray(String fieldName,
                              DataValue[] v)
                       throws EncodingException

putDataValueArray.

Specified by:
putDataValueArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of DataValue objects.
Throws:
EncodingException - if any.

putDataValueArray

public void putDataValueArray(String fieldName,
                              Collection<DataValue> v)
                       throws EncodingException

putDataValueArray.

Specified by:
putDataValueArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putVariant

public void putVariant(String fieldName,
                       Variant v)
                throws EncodingException

putVariant.

Specified by:
putVariant in interface IEncoder
Parameters:
fieldName - a String object.
v - a Variant object.
Throws:
EncodingException - if any.

putVariantArray

public void putVariantArray(String fieldName,
                            Variant[] v)
                     throws EncodingException

putVariantArray.

Specified by:
putVariantArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of Variant objects.
Throws:
EncodingException - if any.

putVariantArray

public void putVariantArray(String fieldName,
                            Collection<Variant> v)
                     throws EncodingException

putVariantArray.

Specified by:
putVariantArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putDiagnosticInfoArray

public void putDiagnosticInfoArray(String fieldName,
                                   DiagnosticInfo[] v)
                            throws EncodingException

putDiagnosticInfoArray.

Specified by:
putDiagnosticInfoArray in interface IEncoder
Parameters:
fieldName - a String object.
v - an array of DiagnosticInfo objects.
Throws:
EncodingException - if any.

putDiagnosticInfoArray

public void putDiagnosticInfoArray(String fieldName,
                                   Collection<DiagnosticInfo> v)
                            throws EncodingException

putDiagnosticInfoArray.

Specified by:
putDiagnosticInfoArray in interface IEncoder
Parameters:
fieldName - a String object.
v - a Collection object.
Throws:
EncodingException - if any.

putDiagnosticInfo

public void putDiagnosticInfo(String fieldName,
                              DiagnosticInfo v)
                       throws EncodingException

putDiagnosticInfo.

Specified by:
putDiagnosticInfo in interface IEncoder
Parameters:
fieldName - a String object.
v - a DiagnosticInfo object.
Throws:
EncodingException - if any.

putEnumerationArray

public void putEnumerationArray(String fieldName,
                                Object array)
                         throws EncodingException

putEnumerationArray.

Specified by:
putEnumerationArray in interface IEncoder
Parameters:
fieldName - a String object.
array - a Object object.
Throws:
EncodingException - if any.

putEnumeration

public void putEnumeration(String fieldName,
                           Enumeration v)
                    throws EncodingException

putEnumeration.

Specified by:
putEnumeration in interface IEncoder
Parameters:
fieldName - a String object.
v - a Enumeration object.
Throws:
EncodingException - if any.

putObject

public void putObject(String fieldName,
                      Object o)
               throws EncodingException

putObject.

Specified by:
putObject in interface IEncoder
Parameters:
fieldName - a String object.
o - a Object object.
Throws:
EncodingException - if any.

putObject

public void putObject(String fieldName,
                      Class<?> c,
                      Object o)
               throws EncodingException

putObject.

Specified by:
putObject in interface IEncoder
Parameters:
fieldName - a String object.
c - a Class object.
o - a Object object.
Throws:
EncodingException - if any.

putScalar

public void putScalar(String fieldName,
                      int builtinType,
                      Object o)
               throws EncodingException

putScalar.

Specified by:
putScalar in interface IEncoder
Parameters:
fieldName - a String object.
builtinType - a int.
o - a Object object.
Throws:
EncodingException - if any.

putArray

public void putArray(String fieldName,
                     int builtinType,
                     Object o)
              throws EncodingException

putArray.

Specified by:
putArray in interface IEncoder
Parameters:
fieldName - a String object.
builtinType - a int.
o - a Object object.
Throws:
EncodingException - if any.

putEncodeableArray

public void putEncodeableArray(String fieldName,
                               Class<? extends IEncodeable> clazz,
                               Object array)
                        throws EncodingException

putEncodeableArray.

Specified by:
putEncodeableArray in interface IEncoder
Parameters:
fieldName - a String object.
clazz - a Class object.
array - a Object object.
Throws:
EncodingException - if any.

putEncodeable

public void putEncodeable(String fieldName,
                          IEncodeable s)
                   throws EncodingException

putEncodeable.

Encodes stucture without header

Specified by:
putEncodeable in interface IEncoder
Parameters:
fieldName - a String object.
s - a IEncodeable object.
Throws:
EncodingException - if any.

putEncodeable

public void putEncodeable(String fieldName,
                          Class<? extends IEncodeable> clazz,
                          IEncodeable s)
                   throws EncodingException

putEncodeable.

Encodes stucture without header

Specified by:
putEncodeable in interface IEncoder
Parameters:
fieldName - a String object.
clazz - a Class object.
s - a IEncodeable object.
Throws:
EncodingException - if any.

putMessage

public void putMessage(IEncodeable s)
                throws EncodingException

putMessage.

Specified by:
putMessage in interface IEncoder
Parameters:
s - a IEncodeable object.
Throws:
EncodingException - if any.

put

public void put(String fieldName,
                Object o)
         throws EncodingException

put.

Specified by:
put in interface IEncoder
Parameters:
fieldName - a String object.
o - a Object object.
Throws:
EncodingException - if any.

put

public void put(String fieldName,
                Object o,
                Class<?> clazz)
         throws EncodingException

put.

Specified by:
put in interface IEncoder
Parameters:
fieldName - a String object.
o - a Object object.
clazz - a Class object.
Throws:
EncodingException - if any.


Copyright © 2018. All rights reserved.