org.omg.IOP

Interface CodecOperations

public interface CodecOperations

Defines the operations, applicable to the Codec.
Method Summary
Anydecode(byte[] them)
Decode the given array of bytes and return the decoded value, inserted into {@link Any}.
Anydecode_value(byte[] them, TypeCode type)
Decode the given array of bytes, supposing that they contain the given data structure, and return the decoded value.
byte[]encode(Any that)
Encode the value, stored inside the given {@link Any}, into array of bytes.
byte[]encode_value(Any that_value)
Encode the value (without the typecode), stored in the passed {@link Any}, into the given byte array.

Method Detail

decode

public Any decode(byte[] them)
Decode the given array of bytes and return the decoded value, inserted into {@link Any}. This methods expects that the byte array contains the CDR-encoded data structure {@link TypeCode}, followed by the data structure itself.

Parameters: them an array of bytes to decode.

Returns: the {@link Any}, containing the decoded structure. The structure can be extracted from the Any with the appropriate helper.

Throws: FormatMismatch on the invalid structure of the byte array.

See Also: encode

decode_value

public Any decode_value(byte[] them, TypeCode type)
Decode the given array of bytes, supposing that they contain the given data structure, and return the decoded value.

Parameters: them the array of bytes to decode. Should contain the data type, matching the structure, defined in the type parameter. Does not contain the typecode itself. type the typecode of the data structure, stored in the byte array.

Returns: the {@link Any}, containing the decoded structure. The structure can be extracted from the Any with the appropriate helper.

Throws: FormatMismatch on the invalid structure of the byte array. TypeMismatch if discovered that the the byte array defines a different structure.

See Also: encode_value

encode

public byte[] encode(Any that)
Encode the value, stored inside the given {@link Any}, into array of bytes. The returned byte array contains the data structure typecode, followed by the data structure itself.

Parameters: that the {@link Any}, containing the data structure, required to encode.

Returns: the array of bytes, containing the encoded data structure.

Throws: InvalidTypeForEncoding if the data structure is not supported by this {@link Codec} (wide char and wide string are not supported by ENCODING_CDR_ENCAPS v 1.0).

See Also: (byte[])

encode_value

public byte[] encode_value(Any that_value)
Encode the value (without the typecode), stored in the passed {@link Any}, into the given byte array.

Parameters: that_value the {@link Any}, holding the value to encode.

Returns: the array, containing the encoded value alone (no preceeding typecode).

See Also: (byte[], TypeCode)