CDRInputStream (JacORB Release 3.9 API)

java.lang.Object
- java.io.InputStream
- - org.omg.CORBA.portable.InputStream
  - - org.omg.CORBA_2_3.portable.InputStream
    - - org.jacorb.orb.CDRInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, CodeSet.InputBuffer, ValueInputStream

Direct Known Subclasses:

MessageInputStream
```
public class CDRInputStream
extends InputStream
implements CodeSet.InputBuffer, ValueInputStream
```
Read CDR encoded data

Author:

Gerald Brose

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] buffer
indices into the actual buffer

protected int giop_minor

protected int index

protected int pos

Fields
Modifier and Type	Field and Description
`protected byte[]`	`buffer` indices into the actual buffer
`protected int`	`giop_minor`
`protected int`	`index`
`protected int`	`pos`

Constructor Summary

Constructors
Constructor and Description
`CDRInputStream(byte[] buffer)`
`CDRInputStream(ORB orb, byte[] buf)`
`CDRInputStream(ORB orb, byte[] buf, boolean littleEndian)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`available()`
`void`	`close()`
`void`	`closeEncapsulation()` close a CDR encapsulation and restore index and byte order information
`void`	`end_value()` `end_value` implements ValueInputStream JavaToIDL mapping 02-01-12.
`int`	`get_pos()` Returns the current position in the buffer.
`byte[]`	`getBufferCopy()`
`int`	`getGIOPMinor()`
`String`	`getIndentString()` used for debug/informational output
`protected boolean`	`getLittleEndian()`
`void`	`mark(int readLimit)`
`boolean`	`markSupported()`
`void`	`openEncapsulatedArray()`
`int`	`openEncapsulation()` open a CDR encapsulation and restore index and byte order information
`ORB`	`orb()`
`Object`	`read_abstract_interface()` Reads an abstract interface from this stream.
`Object`	`read_abstract_interface(Class clazz)` Reads an abstract interface from this stream.
`Any`	`read_any()`
`void`	`read_boolean_array(boolean[] value, int offset, int length)` arrays
`boolean`	`read_boolean()`
`void`	`read_char_array(char[] value, int offset, int length)` `read_char_array` reads an character array from the stream.
`char`	`read_char()` `read_char` reads a character from the stream.
`void`	`read_double_array(double[] value, int offset, int length)`
`double`	`read_double()`
`BigDecimal`	`read_fixed()` Deprecated. use `read_fixed(short, short)` instead
`BigDecimal`	`read_fixed(short digits, short scale)`
`void`	`read_float_array(float[] value, int offset, int length)`
`float`	`read_float()`
`void`	`read_long_array(int[] value, int offset, int length)`
`int`	`read_long()`
`void`	`read_longlong_array(long[] value, int offset, int length)`
`long`	`read_longlong()`
`Object`	`read_Object()`
`Object`	`read_Object(Class clazz)`
`void`	`read_octet_array(byte[] value, int offset, int length)`
`byte`	`read_octet()`
`Principal`	`read_Principal()`
`void`	`read_short_array(short[] value, int offset, int length)`
`short`	`read_short()`
`String`	`read_string()` `read_string` reads a string from the buffer.
`TypeCode`	`read_TypeCode()`
`TypeCode`	`read_TypeCode(Map recursiveTCMap, Map repeatedTCMap)`
`void`	`read_ulong_array(int[] value, int offset, int length)`
`int`	`read_ulong()`
`void`	`read_ulonglong_array(long[] value, int offset, int length)`
`long`	`read_ulonglong()`
`void`	`read_ushort_array(short[] value, int offset, int length)`
`short`	`read_ushort()`
`Serializable`	`read_value()`
`Serializable`	`read_value(BoxedValueHelper factory)` Overrides read_value(factory) in org.omg.CORBA_2_3.portable.InputStream
`Serializable`	`read_value(Class clz)` Overrides read_value(clz) in org.omg.CORBA_2_3.portable.InputStream
`Serializable`	`read_value(Serializable value)` Unmarshals a valuetype instance from this stream.
`Serializable`	`read_value(String rep_id)` Overrides read_value(java.io.Serializable value) in org.omg.CORBA_2_3.portable.InputStream
`void`	`read_wchar_array(char[] value, int offset, int length)`
`char`	`read_wchar()`
`String`	`read_wstring()`
`int`	`read()` Reads the next byte of data from the input stream.
`int`	`read(byte[] b)` Has the effect of read(b, 0, b.length);
`int`	`read(byte[] b, int off, int len)` Performs as described by `java.io.InputStream.read(byte[], int, int)`, but never blocks.
`boolean`	`readBOM()` Read the byte order marker indicating the endianess.
`byte`	`readByte()` Reads the next byte from an in-memory buffer.
`TypeCode`	`readTypeCodeCache(String repositoryID, Integer startPosition)` try to locate a TypeCode identified by its repository id in the TypeCodeCache.
`void`	`register_value(Serializable value)` Stores `value' into this stream's valueMap.
`void`	`reset()`
`void`	`setCodeSet(CodeSet codeSet, CodeSet codeSetWide)`
`void`	`setGIOPMinor(int giop_minor)`
`void`	`setLittleEndian(boolean b)`
`void`	`skip(int distance)`
`void`	`skipRemainingTypeCode(Integer start_pos, int size)` Skip amount is skip (size - ((pos - start_pos) - 4 - 4)); EncapsulationSize - ( PositionAfterReadingId - start_pos - 4 [Size] - 4 [KindSize] ) = RemainingSizeToSkip
`void`	`start_value()` `start_value` implements ValueInputStream JavaToIDL mapping 02-01-12.
`void`	`updateMutatorConnection(GIOPConnection connection)` `updateMutatorConnection` is an accessor that updates the ior mutator.
`void`	`updateTypeCodeCache(String repositoryID, Integer startPosition, int size)` update the TypeCodeCache with the contents of the current repeatedTCMap using the entries between startPosition and (startPosition + size).

Methods inherited from class org.omg.CORBA.portable.InputStream
read_Context

Methods inherited from class java.io.InputStream
skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - giop_minor
```
protected int giop_minor
```
  - buffer
```
protected byte[] buffer
```
    indices into the actual buffer
  - pos
```
protected int pos
```
  - index
```
protected int index
```
- Constructor Detail
  - CDRInputStream
```
public CDRInputStream(byte[] buffer)
```
  - CDRInputStream
```
public CDRInputStream(ORB orb,
              byte[] buf)
```
  - CDRInputStream
```
public CDRInputStream(ORB orb,
              byte[] buf,
              boolean littleEndian)
```
- Method Detail
  - setGIOPMinor
```
public void setGIOPMinor(int giop_minor)
```
  - getGIOPMinor
```
public int getGIOPMinor()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class InputStream
  - orb
```
public ORB orb()
```
    Overrides:
    
    orb in class InputStream
  - setCodeSet
```
public void setCodeSet(CodeSet codeSet,
              CodeSet codeSetWide)
```
  - skip
```
public final void skip(int distance)
```
  - closeEncapsulation
```
public final void closeEncapsulation()
```
    close a CDR encapsulation and restore index and byte order information
  - openEncapsulation
```
public final int openEncapsulation()
```
    open a CDR encapsulation and restore index and byte order information
  - openEncapsulatedArray
```
public final void openEncapsulatedArray()
```
  - getBufferCopy
```
public byte[] getBufferCopy()
```
  - read
```
public int read()
         throws IOException
```
    Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned.
    
    Overrides:
    
    read in class InputStream
    
    Returns:
    the next byte of data, or -1 if the end of the stream is reached.
    
    Throws:
    
    IOException - if stream is closed.
  - available
```
public int available()
```
    Overrides:
    
    available in class InputStream
    
    Returns:
    the number of bytes that can be read (or skipped over) from this input stream. This is not necessarily the number of 'valid' bytes.
  - read
```
public int read(byte[] b)
         throws IOException
```
    Has the effect of read(b, 0, b.length);
    
    Overrides:
    
    read in class InputStream
    
    Throws:
    
    IOException
    See Also:
    read(byte[], int, int)
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Performs as described by java.io.InputStream.read(byte[], int, int), but never blocks.
    
    Overrides:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - read_any
```
public final Any read_any()
```
    Specified by:
    
    read_any in class InputStream
  - read_boolean
```
public final boolean read_boolean()
```
    Specified by:
    
    read_boolean in class InputStream
  - read_boolean_array
```
public final void read_boolean_array(boolean[] value,
                      int offset,
                      int length)
```
    arrays
    
    Specified by:
    
    read_boolean_array in class InputStream
  - read_char
```
public final char read_char()
```
    read_char reads a character from the stream.
    
    Specified by:
    
    read_char in class InputStream
    
    Returns:
    a char value
  - read_char_array
```
public final void read_char_array(char[] value,
                   int offset,
                   int length)
```
    read_char_array reads an character array from the stream.
    
    Specified by:
    
    read_char_array in class InputStream
    
    Parameters:
    value - a char[], the result array.
    offset - an int, an offset into value
    length - an int, the length of the array to read
  - read_double
```
public final double read_double()
```
    Specified by:
    
    read_double in class InputStream
  - read_double_array
```
public final void read_double_array(double[] value,
                     int offset,
                     int length)
```
    Specified by:
    
    read_double_array in class InputStream
  - read_fixed
```
@Deprecated
public BigDecimal read_fixed()
```
    Deprecated. use read_fixed(short, short) instead
    
    Overrides:
    
    read_fixed in class InputStream
  - read_fixed
```
public BigDecimal read_fixed(short digits,
                    short scale)
```
  - read_float
```
public final float read_float()
```
    Specified by:
    
    read_float in class InputStream
  - read_float_array
```
public final void read_float_array(float[] value,
                    int offset,
                    int length)
```
    Specified by:
    
    read_float_array in class InputStream
  - read_long
```
public final int read_long()
```
    Specified by:
    
    read_long in class InputStream
  - read_long_array
```
public final void read_long_array(int[] value,
                   int offset,
                   int length)
```
    Specified by:
    
    read_long_array in class InputStream
  - read_longlong
```
public final long read_longlong()
```
    Specified by:
    
    read_longlong in class InputStream
  - read_longlong_array
```
public final void read_longlong_array(long[] value,
                       int offset,
                       int length)
```
    Specified by:
    
    read_longlong_array in class InputStream
  - read_Object
```
public final Object read_Object()
```
    Specified by:
    
    read_Object in class InputStream
  - read_Object
```
public Object read_Object(Class clazz)
```
    Overrides:
    
    read_Object in class InputStream
  - read_octet
```
public final byte read_octet()
```
    Specified by:
    
    read_octet in class InputStream
  - read_octet_array
```
public final void read_octet_array(byte[] value,
                    int offset,
                    int length)
```
    Specified by:
    
    read_octet_array in class InputStream
  - read_Principal
```
public final Principal read_Principal()
```
    Overrides:
    
    read_Principal in class InputStream
  - read_short
```
public final short read_short()
```
    Specified by:
    
    read_short in class InputStream
  - read_short_array
```
public final void read_short_array(short[] value,
                    int offset,
                    int length)
```
    Specified by:
    
    read_short_array in class InputStream
  - read_string
```
public final String read_string()
```
    read_string reads a string from the buffer. It is optimized for whether it is reading a blank string, and whether codeset translation is active.
    
    Specified by:
    
    read_string in class InputStream
    
    Returns:
    a String value, possibly blank, never null.
  - read_TypeCode
```
public final TypeCode read_TypeCode()
```
    Specified by:
    
    read_TypeCode in class InputStream
  - read_TypeCode
```
public final TypeCode read_TypeCode(Map recursiveTCMap,
                     Map repeatedTCMap)
```
  - skipRemainingTypeCode
```
public void skipRemainingTypeCode(Integer start_pos,
                         int size)
```
    Skip amount is skip (size - ((pos - start_pos) - 4 - 4)); EncapsulationSize - ( PositionAfterReadingId - start_pos - 4 [Size] - 4 [KindSize] ) = RemainingSizeToSkip
    
    Parameters:
    start_pos -
    size -
  - read_ulong
```
public final int read_ulong()
```
    Specified by:
    
    read_ulong in class InputStream
  - read_ulong_array
```
public final void read_ulong_array(int[] value,
                    int offset,
                    int length)
```
    Specified by:
    
    read_ulong_array in class InputStream
  - read_ulonglong
```
public final long read_ulonglong()
```
    Specified by:
    
    read_ulonglong in class InputStream
  - read_ulonglong_array
```
public final void read_ulonglong_array(long[] value,
                        int offset,
                        int length)
```
    Specified by:
    
    read_ulonglong_array in class InputStream
  - read_ushort
```
public final short read_ushort()
```
    Specified by:
    
    read_ushort in class InputStream
  - read_ushort_array
```
public final void read_ushort_array(short[] value,
                     int offset,
                     int length)
```
    Specified by:
    
    read_ushort_array in class InputStream
  - read_wchar
```
public final char read_wchar()
```
    Specified by:
    
    read_wchar in class InputStream
  - readByte
```
public byte readByte()
```
    Description copied from interface: CodeSet.InputBuffer
    
    Reads the next byte from an in-memory buffer.
    
    Specified by:
    
    readByte in interface CodeSet.InputBuffer
  - readBOM
```
public final boolean readBOM()
```
    Read the byte order marker indicating the endianess.
    
    Specified by:
    
    readBOM in interface CodeSet.InputBuffer
    
    Returns:
    true for little endianess, false otherwise (including no BOM present. In this case, big endianess is assumed per spec).
  - read_wchar_array
```
public final void read_wchar_array(char[] value,
                    int offset,
                    int length)
```
    Specified by:
    
    read_wchar_array in class InputStream
  - read_wstring
```
public final String read_wstring()
```
    Specified by:
    
    read_wstring in class InputStream
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class InputStream
  - mark
```
public void mark(int readLimit)
```
    Overrides:
    
    mark in class InputStream
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class InputStream
    
    Throws:
    
    IOException
  - setLittleEndian
```
public final void setLittleEndian(boolean b)
```
  - getLittleEndian
```
protected boolean getLittleEndian()
```
  - read_value
```
public Serializable read_value()
```
    Overrides:
    
    read_value in class InputStream
  - read_value
```
public Serializable read_value(String rep_id)
```
    Overrides read_value(java.io.Serializable value) in org.omg.CORBA_2_3.portable.InputStream
    
    Overrides:
    
    read_value in class InputStream
  - read_value
```
public Serializable read_value(Serializable value)
```
    Unmarshals a valuetype instance from this stream. The value returned is the same value passed in, with all the data unmarshaled (IDL-to-Java Mapping 1.2, August 2002, 1.13.1, p. 1-39). The specified value is an uninitialized value that is added to the ORB's indirection table before unmarshaling (1.21.4.1, p. 1-117). This method is intended to be called from custom valuetype factories. Unlike the other read_value() methods in this class, this method does not expect a GIOP value tag nor a repository id in the stream. Overrides read_value(value) in org.omg.CORBA_2_3.portable.InputStream
    
    Overrides:
    
    read_value in class InputStream
  - read_value
```
public Serializable read_value(Class clz)
```
    Overrides read_value(clz) in org.omg.CORBA_2_3.portable.InputStream
    
    Overrides:
    
    read_value in class InputStream
  - read_value
```
public Serializable read_value(BoxedValueHelper factory)
```
    Overrides read_value(factory) in org.omg.CORBA_2_3.portable.InputStream
    
    Overrides:
    
    read_value in class InputStream
  - read_abstract_interface
```
public Object read_abstract_interface()
```
    Reads an abstract interface from this stream. The abstract interface Reads an abstract interface from this stream. The abstract interface appears as a union with a boolean discriminator, which is true if the union contains a CORBA object reference, or false if the union contains a value.
    
    Overrides:
    
    read_abstract_interface in class InputStream
  - read_abstract_interface
```
public Object read_abstract_interface(Class clazz)
```
    Reads an abstract interface from this stream. The abstract interface appears as a union with a boolean discriminator, which is true if the union contains a CORBA object reference, or false if the union contains a value.
    
    Overrides:
    
    read_abstract_interface in class InputStream
  - get_pos
```
public int get_pos()
```
    Description copied from interface: CodeSet.InputBuffer
    
    Returns the current position in the buffer.
    
    Specified by:
    
    get_pos in interface CodeSet.InputBuffer
  - register_value
```
public void register_value(Serializable value)
```
    Stores `value' into this stream's valueMap. This is provided as a callback for value factories, so that a value factory can store an object into the map before actually reading its state. This is essential for unmarshalling recursive values.
  - updateMutatorConnection
```
public void updateMutatorConnection(GIOPConnection connection)
```
    updateMutatorConnection is an accessor that updates the ior mutator. By making callers pass in a GIOPConnection not a transport this allows callers to not have to call getTransport which would require a synchronized lock. Therefore if the mutator has not been enabled this is effectively a NOP.
    
    Parameters:
    connection - an org.omg.ETF.Connection value
  - updateTypeCodeCache
```
public void updateTypeCodeCache(String repositoryID,
                       Integer startPosition,
                       int size)
```
    update the TypeCodeCache with the contents of the current repeatedTCMap using the entries between startPosition and (startPosition + size). the entries are stored using repositoryID as a key.
  - readTypeCodeCache
```
public TypeCode readTypeCodeCache(String repositoryID,
                         Integer startPosition)
```
    try to locate a TypeCode identified by its repository id in the TypeCodeCache. as cached complex TypeCodes may contain nested TypeCodes. the repeatedTCMap will be updated with entries for these TypeCodes. this is necessary so that later indirections pointing to these nested TypeCodes can be resolved.
    
    Parameters:
    repositoryID - repository id of the TypeCode that should be looked up in the cache
    startPosition - start position in the buffer of the TypeCode that should be looked up in the cache
    
    Returns:
    the cached TypeCode or null
  - getIndentString
```
public String getIndentString()
```
    used for debug/informational output
  - start_value
```
public void start_value()
```
    start_value implements ValueInputStream JavaToIDL mapping 02-01-12. It should read a valuetype header for a nested custom valuetype and increment the valuetype nesting depth.
    
    Specified by:
    
    start_value in interface ValueInputStream
  - end_value
```
public void end_value()
```
    end_value implements ValueInputStream JavaToIDL mapping 02-01-12. It should read the end tag for the nested custom valuetype (after skipping any data that precedes the end tag) and decrements the valuetype nesting depth.
    
    Specified by:
    
    end_value in interface ValueInputStream

Class CDRInputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.omg.CORBA.portable.InputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Field Detail

giop_minor

buffer

pos

index

Constructor Detail

CDRInputStream

CDRInputStream

CDRInputStream

Method Detail

setGIOPMinor

getGIOPMinor

close

orb

setCodeSet

skip

closeEncapsulation

openEncapsulation

openEncapsulatedArray

getBufferCopy

read

available

read

read

read_any

read_boolean

read_boolean_array

read_char

read_char_array

read_double

read_double_array

read_fixed

read_fixed

read_float

read_float_array

read_long

read_long_array

read_longlong

read_longlong_array

read_Object

read_Object

read_octet

read_octet_array

read_Principal

read_short

read_short_array

read_string

read_TypeCode

read_TypeCode

skipRemainingTypeCode

read_ulong

read_ulong_array

read_ulonglong

read_ulonglong_array

read_ushort

read_ushort_array

read_wchar

readByte

readBOM

read_wchar_array

read_wstring

markSupported

mark

reset

setLittleEndian

getLittleEndian

read_value

read_value

read_value

read_value

read_value

read_abstract_interface

read_abstract_interface