Ice

Class InputStreamI

java.lang.Object

Ice.InputStreamI

All Implemented Interfaces:

InputStream

public class InputStreamI
extends java.lang.Object
implements InputStream

Constructor Summary

Constructors

Constructor and Description
InputStreamI(Communicator communicator, byte[] data, boolean copyData)
InputStreamI(Communicator communicator, byte[] data, EncodingVersion v, boolean copyData)

Method Summary

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 minWire) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputStreamI

public InputStreamI(Communicator communicator,
                    byte[] data,
                    boolean copyData)

InputStreamI

public InputStreamI(Communicator communicator,
                    byte[] data,
                    EncodingVersion v,
                    boolean copyData)

Method Detail

communicator

public Communicator communicator()

Description copied from interface: InputStream

Returns the communicator for this input stream.

Specified by:

communicator in interface InputStream

Returns:

The communicator.

sliceObjects

public void sliceObjects(boolean slice)

Description copied from interface: InputStream

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.

Specified by:

sliceObjects in interface InputStream

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

public boolean readBool()

Description copied from interface: InputStream

Extracts a boolean value from the stream.

Specified by:

readBool in interface InputStream

Returns:

The extracted boolean.

readBoolSeq

public boolean[] readBoolSeq()

Description copied from interface: InputStream

Extracts a sequence of boolean values from the stream.

Specified by:

readBoolSeq in interface InputStream

Returns:

The extracted boolean sequence.

readByte

public byte readByte()

Description copied from interface: InputStream

Extracts a byte value from the stream.

Specified by:

readByte in interface InputStream

Returns:

The extracted byte.

readByteSeq

public byte[] readByteSeq()

Description copied from interface: InputStream

Extracts a sequence of byte values from the stream.

Specified by:

readByteSeq in interface InputStream

Returns:

The extracted byte sequence.

readByteBuffer

public java.nio.ByteBuffer readByteBuffer()

Description copied from interface: InputStream

Extracts a sequence of byte values from the stream as a ByteBuffer.

Specified by:

readByteBuffer in interface InputStream

Returns:

The ByteBuffer wrapping the sequence.

readSerializable

public java.io.Serializable readSerializable()

Description copied from interface: InputStream

Extracts a serializable Java object from the stream.

Specified by:

readSerializable in interface InputStream

Returns:

The deserialized Java object.

readShort

public short readShort()

Description copied from interface: InputStream

Extracts a short value from the stream.

Specified by:

readShort in interface InputStream

Returns:

The extracted short value.

readShortSeq

public short[] readShortSeq()

Description copied from interface: InputStream

Extracts a sequence of short values from the stream.

Specified by:

readShortSeq in interface InputStream

Returns:

The extracted short sequence.

readShortBuffer

public java.nio.ShortBuffer readShortBuffer()

Description copied from interface: InputStream

Extracts a sequence of short values from the stream as a ShortBuffer.

Specified by:

readShortBuffer in interface InputStream

Returns:

The ShortBuffer wrapping the sequence.

readInt

public int readInt()

Description copied from interface: InputStream

Extracts an integer value from the stream.

Specified by:

readInt in interface InputStream

Returns:

The extracted integer.

readIntSeq

public int[] readIntSeq()

Description copied from interface: InputStream

Extracts a sequence of integer values from the stream.

Specified by:

readIntSeq in interface InputStream

Returns:

The extracted integer sequence.

readIntBuffer

public java.nio.IntBuffer readIntBuffer()

Description copied from interface: InputStream

Extracts a sequence of int values from the stream as a IntBuffer.

Specified by:

readIntBuffer in interface InputStream

Returns:

The IntBuffer wrapping the sequence.

readLong

public long readLong()

Description copied from interface: InputStream

Extracts a long value from the stream.

Specified by:

readLong in interface InputStream

Returns:

The extracted long value.

readLongSeq

public long[] readLongSeq()

Description copied from interface: InputStream

Extracts a sequence of long values from the stream.

Specified by:

readLongSeq in interface InputStream

Returns:

The extracted long sequence.

readLongBuffer

public java.nio.LongBuffer readLongBuffer()

Description copied from interface: InputStream

Extracts a sequence of long values from the stream as a LongBuffer.

Specified by:

readLongBuffer in interface InputStream

Returns:

The LongBuffer wrapping the sequence.

readFloat

public float readFloat()

Description copied from interface: InputStream

Extracts a float value from the stream.

Specified by:

readFloat in interface InputStream

Returns:

The extracted float value.

readFloatSeq

public float[] readFloatSeq()

Description copied from interface: InputStream

Extracts a sequence of float values from the stream.

Specified by:

readFloatSeq in interface InputStream

Returns:

The extracted float sequence.

readFloatBuffer

public java.nio.FloatBuffer readFloatBuffer()

Description copied from interface: InputStream

Extracts a sequence of float values from the stream as a FloatBuffer.

Specified by:

readFloatBuffer in interface InputStream

Returns:

The FloatBuffer wrapping the sequence.

readDouble

public double readDouble()

Description copied from interface: InputStream

Extracts a double value from the stream.

Specified by:

readDouble in interface InputStream

Returns:

The extracted double value.

readDoubleSeq

public double[] readDoubleSeq()

Description copied from interface: InputStream

Extracts a sequence of double values from the stream.

Specified by:

readDoubleSeq in interface InputStream

Returns:

The extracted float sequence.

readDoubleBuffer

public java.nio.DoubleBuffer readDoubleBuffer()

Description copied from interface: InputStream

Extracts a sequence of double values from the stream as a DoubleBuffer.

Specified by:

readDoubleBuffer in interface InputStream

Returns:

The DoubleBuffer wrapping the sequence.

readString

public java.lang.String readString()

Description copied from interface: InputStream

Extracts a string from the stream.

Specified by:

readString in interface InputStream

Returns:

The extracted string.

readStringSeq

public java.lang.String[] readStringSeq()

Description copied from interface: InputStream

Extracts a string sequence from the stream.

Specified by:

readStringSeq in interface InputStream

Returns:

The extracted string sequence.

readSize

public int readSize()

Description copied from interface: InputStream

Extracts a size from the stream.

Specified by:

readSize in interface InputStream

Returns:

The extracted size.

readAndCheckSeqSize

public int readAndCheckSeqSize(int minWire)

Description copied from interface: InputStream

Extracts and check a sequence size from the stream. The check ensures not too much memory will be pre-allocated for the sequence.

Specified by:

readAndCheckSeqSize in interface InputStream

Parameters:

minWire - The minimum size of an element of the sequence.

Returns:

The extracted size.

readProxy

public ObjectPrx readProxy()

Description copied from interface: InputStream

Extracts a proxy from the stream.

Specified by:

readProxy in interface InputStream

Returns:

The extracted proxy.

readObject

public void readObject(ReadObjectCallback cb)

Description copied from interface: InputStream

Extracts the index of a Slice class from the stream.

Specified by:

readObject in interface InputStream

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

public int readEnum(int maxValue)

Description copied from interface: InputStream

Read an enumerated value.

Specified by:

readEnum in interface InputStream

Parameters:

maxValue - The maximum enumerator value in the definition.

Returns:

The enumerator.

throwException

public void throwException()
                    throws UserException

Description copied from interface: InputStream

Extracts a user exception from the stream and throws it.

Specified by:

throwException in interface InputStream

Throws:

UserException - The user exception that was unmarshaled.

throwException

public void throwException(UserExceptionReaderFactory factory)
                    throws UserException

Description copied from interface: InputStream

Extracts a user exception from the stream and throws it, using the supplied factory to instantiate a UserExceptionReader.

Specified by:

throwException in interface InputStream

Parameters:

factory - A factory that creates UserExceptionReader instances.

Throws:

UserException - The user exception that was unmarshaled.

startObject

public void startObject()

Description copied from interface: InputStream

Marks the start of an Ice object.

Specified by:

startObject in interface InputStream

endObject

public SlicedData endObject(boolean preserve)

Description copied from interface: InputStream

Marks the end of an Ice object.

Specified by:

endObject in interface InputStream

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

public void startException()

Description copied from interface: InputStream

Marks the start of a user exception.

Specified by:

startException in interface InputStream

endException

public SlicedData endException(boolean preserve)

Description copied from interface: InputStream

Marks the end of a user exception.

Specified by:

endException in interface InputStream

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

public java.lang.String startSlice()

Description copied from interface: InputStream

Reads the start of an object or exception slice.

Specified by:

startSlice in interface InputStream

Returns:

The Slice type ID for this slice.

endSlice

public void endSlice()

Description copied from interface: InputStream

Indicates that the end of an object or exception slice has been reached.

Specified by:

endSlice in interface InputStream

skipSlice

public void skipSlice()

Description copied from interface: InputStream

Skips over an object or exception slice.

Specified by:

skipSlice in interface InputStream

startEncapsulation

public EncodingVersion startEncapsulation()

Description copied from interface: InputStream

Reads the start of an encapsulation.

Specified by:

startEncapsulation in interface InputStream

Returns:

The encapsulation encoding version.

endEncapsulation

public void endEncapsulation()

Description copied from interface: InputStream

Indicates that the end of an encapsulation has been reached.

Specified by:

endEncapsulation in interface InputStream

skipEncapsulation

public EncodingVersion skipEncapsulation()

Description copied from interface: InputStream

Skips over an encapsulation.

Specified by:

skipEncapsulation in interface InputStream

Returns:

The encapsulation encoding version.

getEncoding

public EncodingVersion getEncoding()

Description copied from interface: InputStream

Determines the current encoding version.

Specified by:

getEncoding in interface InputStream

Returns:

The encoding version.

readPendingObjects

public void readPendingObjects()

Description copied from interface: InputStream

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.

Specified by:

readPendingObjects in interface InputStream

rewind

public void rewind()

Description copied from interface: InputStream

Resets the read position of the stream to the beginning.

Specified by:

rewind in interface InputStream

skip

public void skip(int sz)

Description copied from interface: InputStream

Skips ahead in the stream.

Specified by:

skip in interface InputStream

Parameters:

sz - The number of bytes to skip.

skipSize

public void skipSize()

Description copied from interface: InputStream

Skips over a size value.

Specified by:

skipSize in interface InputStream

readOptional

public boolean readOptional(int tag,
                            OptionalFormat format)

Description copied from interface: InputStream

Determine if an optional value is available for reading.

Specified by:

readOptional in interface InputStream

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

public int pos()

Specified by:

pos in interface InputStream

destroy

public void destroy()

Description copied from interface: InputStream

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.

Specified by:

destroy in interface InputStream