Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.omg.IOP

Interface CodecOperations

Known Subinterfaces:
Codec
Known Implementing Classes:
CdrEncapsCodecImpl
public interface CodecOperations
Defines the operations, applicable to the Codec.

Method Summary

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

Method Details

decode

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

decode_value

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

encode

public 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[])

encode_value

public 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).
See Also:
decode_value(byte[],TypeCode)
CodecOperations.java -- Copyright (C) 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About