org.omg.IOP

Interface CodecOperations

All Known Subinterfaces:

Codec

public interface CodecOperations

Defines the operations, applicable to the Codec.

Method Summary

Methods

Modifier and Type	Method and Description
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.
Any	decode(byte[] them) Decode the given array of bytes and return the decoded value, inserted into Any.
byte[]	encode_value(Any that_value) Encode the value (without the typecode), stored in the passed Any, into the given byte array.
byte[]	encode(Any that) Encode the value, stored inside the given Any, into array of bytes.

Method Detail

encode

byte[] encode(Any that)
              throws InvalidTypeForEncoding

Encode the value, stored inside the given Any, into array of bytes. The returned byte array contains the data structure typecode, followed by the data structure itself.

Parameters:

that - the 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 Codec (wide char and wide string are not supported by ENCODING_CDR_ENCAPS v 1.0).

See Also:

decode(byte[])

decode

Any decode(byte[] them)
           throws FormatMismatch

Decode the given array of bytes and return the decoded value, inserted into Any. This methods expects that the byte array contains the CDR-encoded data structure TypeCode, followed by the data structure itself.

Parameters:

them - an array of bytes to decode.

Returns:

the 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(Any)

encode_value

byte[] encode_value(Any that_value)
                    throws InvalidTypeForEncoding

Encode the value (without the typecode), stored in the passed Any, into the given byte array.

Parameters:

that_value - the Any, holding the value to encode.

Returns:

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

Throws:

InvalidTypeForEncoding

See Also:

decode_value(byte[], TypeCode)

decode_value

Any decode_value(byte[] them,
               TypeCode type)
                 throws FormatMismatch,
                        TypeMismatch

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 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(Any)