InputStream (ice 3.6.5 API)

All Known Implementing Classes:

InputStreamI
```
public interface InputStream
```
Interface for input streams used to extract Slice types from a sequence of bytes.

See Also:

OutputStream

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Communicator`	`communicator()` Returns the communicator for this input stream.
`void`	`destroy()` Destroys the stream and its associated resources.
`void`	`endEncapsulation()` Indicates that the end of an encapsulation has been reached.
`SlicedData`	`endException(boolean preserve)` Marks the end of a user exception.
`SlicedData`	`endObject(boolean preserve)` Marks the end of an Ice object.
`void`	`endSlice()` Indicates that the end of an object or exception slice has been reached.
`EncodingVersion`	`getEncoding()` Determines the current encoding version.
`int`	`pos()`
`int`	`readAndCheckSeqSize(int minSize)` Extracts and check a sequence size from the stream.
`boolean`	`readBool()` Extracts a boolean value from the stream.
`boolean[]`	`readBoolSeq()` Extracts a sequence of boolean values from the stream.
`byte`	`readByte()` Extracts a byte value from the stream.
`java.nio.ByteBuffer`	`readByteBuffer()` Extracts a sequence of byte values from the stream as a ByteBuffer.
`byte[]`	`readByteSeq()` Extracts a sequence of byte values from the stream.
`double`	`readDouble()` Extracts a double value from the stream.
`java.nio.DoubleBuffer`	`readDoubleBuffer()` Extracts a sequence of double values from the stream as a DoubleBuffer.
`double[]`	`readDoubleSeq()` Extracts a sequence of double values from the stream.
`int`	`readEnum(int maxValue)` Read an enumerated value.
`float`	`readFloat()` Extracts a float value from the stream.
`java.nio.FloatBuffer`	`readFloatBuffer()` Extracts a sequence of float values from the stream as a FloatBuffer.
`float[]`	`readFloatSeq()` Extracts a sequence of float values from the stream.
`int`	`readInt()` Extracts an integer value from the stream.
`java.nio.IntBuffer`	`readIntBuffer()` Extracts a sequence of int values from the stream as a IntBuffer.
`int[]`	`readIntSeq()` Extracts a sequence of integer values from the stream.
`long`	`readLong()` Extracts a long value from the stream.
`java.nio.LongBuffer`	`readLongBuffer()` Extracts a sequence of long values from the stream as a LongBuffer.
`long[]`	`readLongSeq()` Extracts a sequence of long values from the stream.
`void`	`readObject(ReadObjectCallback cb)` Extracts the index of a Slice class from the stream.
`boolean`	`readOptional(int tag, OptionalFormat format)` Determine if an optional value is available for reading.
`void`	`readPendingObjects()` Indicates that unmarshaling is complete, except for any Slice objects.
`ObjectPrx`	`readProxy()` Extracts a proxy from the stream.
`java.io.Serializable`	`readSerializable()` Extracts a serializable Java object from the stream.
`short`	`readShort()` Extracts a short value from the stream.
`java.nio.ShortBuffer`	`readShortBuffer()` Extracts a sequence of short values from the stream as a ShortBuffer.
`short[]`	`readShortSeq()` Extracts a sequence of short values from the stream.
`int`	`readSize()` Extracts a size from the stream.
`java.lang.String`	`readString()` Extracts a string from the stream.
`java.lang.String[]`	`readStringSeq()` Extracts a string sequence from the stream.
`void`	`rewind()` Resets the read position of the stream to the beginning.
`void`	`skip(int sz)` Skips ahead in the stream.
`EncodingVersion`	`skipEncapsulation()` Skips over an encapsulation.
`void`	`skipSize()` Skips over a size value.
`void`	`skipSlice()` Skips over an object or exception slice.
`void`	`sliceObjects(boolean slice)` Determines the behavior of the stream when extracting Slice objects.
`EncodingVersion`	`startEncapsulation()` Reads the start of an encapsulation.
`void`	`startException()` Marks the start of a user exception.
`void`	`startObject()` Marks the start of an Ice object.
`java.lang.String`	`startSlice()` Reads the start of an object or exception slice.
`void`	`throwException()` Extracts a user exception from the stream and throws it.
`void`	`throwException(UserExceptionReaderFactory factory)` Extracts a user exception from the stream and throws it, using the supplied factory to instantiate a UserExceptionReader.

- Method Detail
  - communicator
```
Communicator communicator()
```
    Returns the communicator for this input stream.
    
    Returns:
    
    The communicator.
  - sliceObjects
```
void sliceObjects(boolean slice)
```
    Determines the behavior of the stream when extracting Slice objects. A Slice object is "sliced" when a factory cannot be found for a Slice type ID.
    
    Parameters:
    
    slice - If true (the default), slicing is enabled; if false, slicing is disabled. If slicing is disabled and the stream encounters a Slice type ID during decoding for which no object factory is installed, it raises NoObjectFactoryException.
  - readBool
```
boolean readBool()
```
    Extracts a boolean value from the stream.
    
    Returns:
    
    The extracted boolean.
  - readBoolSeq
```
boolean[] readBoolSeq()
```
    Extracts a sequence of boolean values from the stream.
    
    Returns:
    
    The extracted boolean sequence.
  - readByte
```
byte readByte()
```
    Extracts a byte value from the stream.
    
    Returns:
    
    The extracted byte.
  - readByteSeq
```
byte[] readByteSeq()
```
    Extracts a sequence of byte values from the stream.
    
    Returns:
    
    The extracted byte sequence.
  - readByteBuffer
```
java.nio.ByteBuffer readByteBuffer()
```
    Extracts a sequence of byte values from the stream as a ByteBuffer.
    
    Returns:
    
    The ByteBuffer wrapping the sequence.
  - readSerializable
```
java.io.Serializable readSerializable()
```
    Extracts a serializable Java object from the stream.
    
    Returns:
    
    The deserialized Java object.
  - readShort
```
short readShort()
```
    Extracts a short value from the stream.
    
    Returns:
    
    The extracted short value.
  - readShortSeq
```
short[] readShortSeq()
```
    Extracts a sequence of short values from the stream.
    
    Returns:
    
    The extracted short sequence.
  - readShortBuffer
```
java.nio.ShortBuffer readShortBuffer()
```
    Extracts a sequence of short values from the stream as a ShortBuffer.
    
    Returns:
    
    The ShortBuffer wrapping the sequence.
  - readInt
```
int readInt()
```
    Extracts an integer value from the stream.
    
    Returns:
    
    The extracted integer.
  - readIntSeq
```
int[] readIntSeq()
```
    Extracts a sequence of integer values from the stream.
    
    Returns:
    
    The extracted integer sequence.
  - readIntBuffer
```
java.nio.IntBuffer readIntBuffer()
```
    Extracts a sequence of int values from the stream as a IntBuffer.
    
    Returns:
    
    The IntBuffer wrapping the sequence.
  - readLong
```
long readLong()
```
    Extracts a long value from the stream.
    
    Returns:
    
    The extracted long value.
  - readLongSeq
```
long[] readLongSeq()
```
    Extracts a sequence of long values from the stream.
    
    Returns:
    
    The extracted long sequence.
  - readLongBuffer
```
java.nio.LongBuffer readLongBuffer()
```
    Extracts a sequence of long values from the stream as a LongBuffer.
    
    Returns:
    
    The LongBuffer wrapping the sequence.
  - readFloat
```
float readFloat()
```
    Extracts a float value from the stream.
    
    Returns:
    
    The extracted float value.
  - readFloatSeq
```
float[] readFloatSeq()
```
    Extracts a sequence of float values from the stream.
    
    Returns:
    
    The extracted float sequence.
  - readFloatBuffer
```
java.nio.FloatBuffer readFloatBuffer()
```
    Extracts a sequence of float values from the stream as a FloatBuffer.
    
    Returns:
    
    The FloatBuffer wrapping the sequence.
  - readDouble
```
double readDouble()
```
    Extracts a double value from the stream.
    
    Returns:
    
    The extracted double value.
  - readDoubleSeq
```
double[] readDoubleSeq()
```
    Extracts a sequence of double values from the stream.
    
    Returns:
    
    The extracted float sequence.
  - readDoubleBuffer
```
java.nio.DoubleBuffer readDoubleBuffer()
```
    Extracts a sequence of double values from the stream as a DoubleBuffer.
    
    Returns:
    
    The DoubleBuffer wrapping the sequence.
  - readString
```
java.lang.String readString()
```
    Extracts a string from the stream.
    
    Returns:
    
    The extracted string.
  - readStringSeq
```
java.lang.String[] readStringSeq()
```
    Extracts a string sequence from the stream.
    
    Returns:
    
    The extracted string sequence.
  - readSize
```
int readSize()
```
    Extracts a size from the stream.
    
    Returns:
    
    The extracted size.
  - readAndCheckSeqSize
```
int readAndCheckSeqSize(int minSize)
```
    Extracts and check a sequence size from the stream. The check ensures not too much memory will be pre-allocated for the sequence.
    
    Parameters:
    
    minSize - The minimum size of an element of the sequence.
    
    Returns:
    
    The extracted size.
  - readProxy
```
ObjectPrx readProxy()
```
    Extracts a proxy from the stream.
    
    Returns:
    
    The extracted proxy.
  - readObject
```
void readObject(ReadObjectCallback cb)
```
    Extracts the index of a Slice class from the stream.
    
    Parameters:
    
    cb - The callback to notify the application when the extracted instance is available. The Ice run time extracts Slice classes in stages. The Ice run time calls ReadObjectCallback.invoke(Ice.Object) when the corresponding instance has been fully unmarshaled.
    
    See Also:
    
    ReadObjectCallback
  - readEnum
```
int readEnum(int maxValue)
```
    Read an enumerated value.
    
    Parameters:
    
    maxValue - The maximum enumerator value in the definition.
    
    Returns:
    
    The enumerator.
  - throwException
```
void throwException()
             throws UserException
```
    Extracts a user exception from the stream and throws it.
    
    Throws:
    
    UserException - The user exception that was unmarshaled.
  - throwException
```
void throwException(UserExceptionReaderFactory factory)
             throws UserException
```
    Extracts a user exception from the stream and throws it, using the supplied factory to instantiate a UserExceptionReader.
    
    Parameters:
    
    factory - A factory that creates UserExceptionReader instances.
    
    Throws:
    
    UserException - The user exception that was unmarshaled.
  - startObject
```
void startObject()
```
    Marks the start of an Ice object.
  - endObject
```
SlicedData endObject(boolean preserve)
```
    Marks the end of an Ice object.
    
    Parameters:
    
    preserve - Pass true and the stream will preserve the unknown slices of the instance, or false to discard the unknown slices.
    
    Returns:
    
    A SlicedData object containing the preserved slices for unknown types.
  - startException
```
void startException()
```
    Marks the start of a user exception.
  - endException
```
SlicedData endException(boolean preserve)
```
    Marks the end of a user exception.
    
    Parameters:
    
    preserve - Pass true and the stream will preserve the unknown slices of the exception, or false to discard the unknown slices.
    
    Returns:
    
    A SlicedData object containing the preserved slices for unknown types.
  - startSlice
```
java.lang.String startSlice()
```
    Reads the start of an object or exception slice.
    
    Returns:
    
    The Slice type ID for this slice.
  - endSlice
```
void endSlice()
```
    Indicates that the end of an object or exception slice has been reached.
  - skipSlice
```
void skipSlice()
```
    Skips over an object or exception slice.
  - startEncapsulation
```
EncodingVersion startEncapsulation()
```
    Reads the start of an encapsulation.
    
    Returns:
    
    The encapsulation encoding version.
  - endEncapsulation
```
void endEncapsulation()
```
    Indicates that the end of an encapsulation has been reached.
  - skipEncapsulation
```
EncodingVersion skipEncapsulation()
```
    Skips over an encapsulation.
    
    Returns:
    
    The encapsulation encoding version.
  - getEncoding
```
EncodingVersion getEncoding()
```
    Determines the current encoding version.
    
    Returns:
    
    The encoding version.
  - readPendingObjects
```
void readPendingObjects()
```
    Indicates that unmarshaling is complete, except for any Slice objects. The application must call this method only if the stream actually contains Slice objects. Calling readPendingObjects triggers the calls to ReadObjectCallback.invoke(Ice.Object) that inform the application that unmarshaling of a Slice object is complete.
  - rewind
```
void rewind()
```
    Resets the read position of the stream to the beginning.
  - skip
```
void skip(int sz)
```
    Skips ahead in the stream.
    
    Parameters:
    
    sz - The number of bytes to skip.
  - skipSize
```
void skipSize()
```
    Skips over a size value.
  - readOptional
```
boolean readOptional(int tag,
                     OptionalFormat format)
```
    Determine if an optional value is available for reading.
    
    Parameters:
    
    tag - The tag associated with the value.
    
    format - The optional format for the value.
    
    Returns:
    
    True if the value is present, false otherwise.
  - pos
```
int pos()
```
  - destroy
```
void destroy()
```
    Destroys the stream and its associated resources. The application must call destroy prior to releasing the last reference to a stream; failure to do so may result in resource leaks.

Interface InputStream

Method Summary

Method Detail

communicator

sliceObjects

readBool

readBoolSeq

readByte

readByteSeq

readByteBuffer

readSerializable

readShort

readShortSeq

readShortBuffer

readInt

readIntSeq

readIntBuffer

readLong

readLongSeq

readLongBuffer

readFloat

readFloatSeq

readFloatBuffer

readDouble

readDoubleSeq

readDoubleBuffer

readString

readStringSeq

readSize

readAndCheckSeqSize

readProxy

readObject

readEnum

throwException

throwException

startObject

endObject

startException

endException

startSlice

endSlice

skipSlice

startEncapsulation

endEncapsulation

skipEncapsulation

getEncoding

readPendingObjects

rewind

skip

skipSize

readOptional

pos

destroy