JavaTM 2 Platform
Std. Ed. v1.3.1

org.omg.CORBA.portable
Class InputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--org.omg.CORBA.portable.InputStream
Direct Known Subclasses:
InputStream

public abstract class InputStream
extends InputStream

InputStream is the Java API for reading IDL types from CDR marshal streams. These methods are used by the ORB to unmarshal IDL types as well as to extract IDL types out of Anys. The _array versions of the methods can be directly used to read sequences and arrays of IDL types.

Since:
JDK1.2

Constructor Summary
InputStream()
           
 
Method Summary
 ORB orb()
          Returns the ORB that created this InputStream.
abstract  Any read_any()
          Reads an Any from this input stream.
abstract  void read_boolean_array(boolean[] value, int offset, int length)
          Reads an array of booleans from this input stream.
abstract  boolean read_boolean()
          Reads a boolean value from this input stream.
abstract  void read_char_array(char[] value, int offset, int length)
          Reads an array of chars from this input stream.
abstract  char read_char()
          Reads a char value from this input stream.
 Context read_Context()
          Reads a CORBA context from the stream.
abstract  void read_double_array(double[] value, int offset, int length)
          Reads an array of boubles from this input stream.
abstract  double read_double()
          Reads a double value from this input stream.
 BigDecimal read_fixed()
          Reads a BigDecimal number.
abstract  void read_float_array(float[] value, int offset, int length)
          Reads an array of floats from this input stream.
abstract  float read_float()
          Reads a float value from this input stream.
abstract  void read_long_array(int[] value, int offset, int length)
          Reads an array of CORBA longs (i.e.
abstract  int read_long()
          Reads a CORBA long (i.e.
abstract  void read_longlong_array(long[] value, int offset, int length)
          Reads an array of CORBA longlongs (i.e.
abstract  long read_longlong()
          Reads a CORBA longlong (i.e.
abstract  Object read_Object()
          Reads a CORBA object from this input stream.
 Object read_Object(Class clz)
          read_Object unmarshals an object and returns a CORBA Object which is an instance of the class passed as its argument.
abstract  void read_octet_array(byte[] value, int offset, int length)
          Reads an array of octets (i.e.
abstract  byte read_octet()
          Reads an octet (i.e.
abstract  Principal read_Principal()
          Deprecated. Deprecated by CORBA 2.2.
abstract  void read_short_array(short[] value, int offset, int length)
          Reads an array of shorts from this input stream.
abstract  short read_short()
          Reads a short value from this input stream.
abstract  String read_string()
          Reads a string value from this input stream.
abstract  TypeCode read_TypeCode()
          Reads a TypeCode from this input stream.
abstract  void read_ulong_array(int[] value, int offset, int length)
          Reads an array of unsigned CORBA longs (i.e.
abstract  int read_ulong()
          Reads an unsigned CORBA long (i.e.
abstract  void read_ulonglong_array(long[] value, int offset, int length)
          Reads an array of unsigned CORBA longlongs (i.e.
abstract  long read_ulonglong()
          Reads a CORBA unsigned longlong (i.e.
abstract  void read_ushort_array(short[] value, int offset, int length)
          Reads an array of unsigned shorts from this input stream.
abstract  short read_ushort()
          Reads a unsigned short value from this input stream.
abstract  void read_wchar_array(char[] value, int offset, int length)
          Reads an array of wide chars from this input stream.
abstract  char read_wchar()
          Reads a wide char value from this input stream.
abstract  String read_wstring()
          Reads a wide string value from this input stream.
 int read()
          Reads the next byte of data from the input stream.
 
Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputStream

public InputStream()
Method Detail

read_boolean

public abstract boolean read_boolean()
Reads a boolean value from this input stream.

read_char

public abstract char read_char()
Reads a char value from this input stream.

read_wchar

public abstract char read_wchar()
Reads a wide char value from this input stream.

read_octet

public abstract byte read_octet()
Reads an octet (i.e. a byte) value from this input stream.

read_short

public abstract short read_short()
Reads a short value from this input stream.

read_ushort

public abstract short read_ushort()
Reads a unsigned short value from this input stream.

read_long

public abstract int read_long()
Reads a CORBA long (i.e. Java int) value from this input stream.

read_ulong

public abstract int read_ulong()
Reads an unsigned CORBA long (i.e. Java int) value from this input stream.

read_longlong

public abstract long read_longlong()
Reads a CORBA longlong (i.e. Java long) value from this input stream.

read_ulonglong

public abstract long read_ulonglong()
Reads a CORBA unsigned longlong (i.e. Java long) value from this input stream.

read_float

public abstract float read_float()
Reads a float value from this input stream.

read_double

public abstract double read_double()
Reads a double value from this input stream.

read_string

public abstract String read_string()
Reads a string value from this input stream.

read_wstring

public abstract String read_wstring()
Reads a wide string value from this input stream.

read_boolean_array

public abstract void read_boolean_array(boolean[] value,
                                        int offset,
                                        int length)
Reads an array of booleans from this input stream.
Parameters:
value - returned array of booleans.
offset - offset on the stream.
length - length of buffer to read

read_char_array

public abstract void read_char_array(char[] value,
                                     int offset,
                                     int length)
Reads an array of chars from this input stream.
Parameters:
value - returned array of chars.
offset - offset on the stream.
length - length of buffer to read

read_wchar_array

public abstract void read_wchar_array(char[] value,
                                      int offset,
                                      int length)
Reads an array of wide chars from this input stream.
Parameters:
value - returned array of wide chars.
offset - offset on the stream.
length - length of buffer to read

read_octet_array

public abstract void read_octet_array(byte[] value,
                                      int offset,
                                      int length)
Reads an array of octets (i.e. bytes) from this input stream.
Parameters:
value - returned array of octets (i.e. bytes).
offset - offset on the stream.
length - length of buffer to read

read_short_array

public abstract void read_short_array(short[] value,
                                      int offset,
                                      int length)
Reads an array of shorts from this input stream.
Parameters:
value - returned array of shorts.
offset - offset on the stream.
length - length of buffer to read

read_ushort_array

public abstract void read_ushort_array(short[] value,
                                       int offset,
                                       int length)
Reads an array of unsigned shorts from this input stream.
Parameters:
value - returned array of shorts.
offset - offset on the stream.
length - length of buffer to read

read_long_array

public abstract void read_long_array(int[] value,
                                     int offset,
                                     int length)
Reads an array of CORBA longs (i.e. Java ints) from this input stream.
Parameters:
value - returned array of CORBA longs (i.e. Java ints).
offset - offset on the stream.
length - length of buffer to read

read_ulong_array

public abstract void read_ulong_array(int[] value,
                                      int offset,
                                      int length)
Reads an array of unsigned CORBA longs (i.e. Java ints) from this input stream.
Parameters:
value - returned array of CORBA longs (i.e. Java ints).
offset - offset on the stream.
length - length of buffer to read

read_longlong_array

public abstract void read_longlong_array(long[] value,
                                         int offset,
                                         int length)
Reads an array of CORBA longlongs (i.e. Java longs) from this input stream.
Parameters:
value - returned array of CORBA longs (i.e. Java longs).
offset - offset on the stream.
length - length of buffer to read

read_ulonglong_array

public abstract void read_ulonglong_array(long[] value,
                                          int offset,
                                          int length)
Reads an array of unsigned CORBA longlongs (i.e. Java longs) from this input stream.
Parameters:
value - returned array of CORBA longs (i.e. Java longs).
offset - offset on the stream.
length - length of buffer to read

read_float_array

public abstract void read_float_array(float[] value,
                                      int offset,
                                      int length)
Reads an array of floats from this input stream.
Parameters:
value - returned array of floats.
offset - offset on the stream.
length - length of buffer to read

read_double_array

public abstract void read_double_array(double[] value,
                                       int offset,
                                       int length)
Reads an array of boubles from this input stream.
Parameters:
value - returned array of doubles.
offset - offset on the stream.
length - length of buffer to read

read_Object

public abstract Object read_Object()
Reads a CORBA object from this input stream.

read_TypeCode

public abstract TypeCode read_TypeCode()
Reads a TypeCode from this input stream.

read_any

public abstract Any read_any()
Reads an Any from this input stream.

read_Principal

public abstract Principal read_Principal()
Deprecated. Deprecated by CORBA 2.2.

Returns principle for invocation.
Returns:
Principle for invocation.

read

public int read()
         throws IOException
Description copied from class: InputStream
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. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

A subclass must provide an implementation of this method.

Overrides:
read in class InputStream
See Also:
portable package comments for unimplemented features

read_fixed

public BigDecimal read_fixed()
Reads a BigDecimal number.
Returns:
a java.math.BigDecimal number.
See Also:
portable package comments for unimplemented features

read_Context

public Context read_Context()
Reads a CORBA context from the stream.
Returns:
a CORBA context.
See Also:
portable package comments for unimplemented features

read_Object

public Object read_Object(Class clz)
read_Object unmarshals an object and returns a CORBA Object which is an instance of the class passed as its argument. This class is the stub class of the expected type.
Parameters:
clz - a Class object, one of whose instances this method will read and return from the stream.
Returns:
an Object instance of clz read from this stream.
See Also:
portable package comments for unimplemented features

orb

public ORB orb()
Returns the ORB that created this InputStream.
Returns:
an ORB object.
See Also:
portable package comments for unimplemented features

JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.