OutputStreamI (ice 3.6.5 API)

java.lang.Object
- Ice.OutputStreamI

All Implemented Interfaces:: OutputStream

public class OutputStreamI
extends java.lang.Object
implements OutputStream

Constructor Summary

Constructors
Constructor and Description
`OutputStreamI(Communicator communicator)`
`OutputStreamI(Communicator communicator, BasicStream os)`
`OutputStreamI(Communicator communicator, EncodingVersion v)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Communicator`	`communicator()` Returns the communicator for this output stream.
`void`	`destroy()` Destroys the stream and its associated resources.
`void`	`endEncapsulation()` Ends the previous encapsulation.
`void`	`endException()` Marks the end of a user exception.
`void`	`endObject()` Marks the end of an Ice object.
`void`	`endSize(int pos)` Computes the amount of data written since the previous call to startSize and writes that value at the saved position.
`void`	`endSlice()` Marks the end of a slice for an Ice object or user exception.
`byte[]`	`finished()` Indicates that marshaling of a request or reply is finished.
`EncodingVersion`	`getEncoding()` Determines the current encoding version.
`int`	`pos()` Determines the current position in the stream.
`void`	`reset(boolean clearBuffer)` Resets this output stream.
`void`	`rewrite(int sz, int pos)` Inserts a fixed 32-bit size value into the stream at the given position.
`void`	`startEncapsulation()` Writes the start of an encapsulation to the stream.
`void`	`startEncapsulation(EncodingVersion encoding, FormatType format)` Writes the start of an encapsulation to the stream.
`void`	`startException(SlicedData slicedData)` Marks the start of a user exception.
`void`	`startObject(SlicedData slicedData)` Marks the start of an Ice object.
`int`	`startSize()` Returns the current position and allocates four bytes for a fixed-length (32-bit) size value.
`void`	`startSlice(java.lang.String typeId, int compactId, boolean last)` Marks the start of a new slice for an Ice object or user exception.
`void`	`writeBool(boolean v)` Writes a boolean to the stream.
`void`	`writeBoolSeq(boolean[] v)` Writes a sequence of booleans to the stream.
`void`	`writeByte(byte v)` Writes a byte to the stream.
`void`	`writeByteBuffer(java.nio.ByteBuffer v)` Writes a ByteBuffer to the stream.
`void`	`writeByteSeq(byte[] v)` Writes a sequence of bytes to the stream.
`void`	`writeDouble(double v)` Writes a double to the stream.
`void`	`writeDoubleBuffer(java.nio.DoubleBuffer v)` Writes a DoubleBuffer to the stream.
`void`	`writeDoubleSeq(double[] v)` Writes a sequence of doubles to the stream.
`void`	`writeEnum(int v, int maxValue)` Write an enumerated value.
`void`	`writeException(UserException v)` Writes a user exception to the stream.
`void`	`writeFloat(float v)` Writes a float to the stream.
`void`	`writeFloatBuffer(java.nio.FloatBuffer v)` Writes a FloatBuffer to the stream.
`void`	`writeFloatSeq(float[] v)` Writes a sequence of floats to the stream.
`void`	`writeInt(int v)` Writes an integer to the stream.
`void`	`writeIntBuffer(java.nio.IntBuffer v)` Writes a IntBuffer to the stream.
`void`	`writeIntSeq(int[] v)` Writes a sequence of integers to the stream.
`void`	`writeLong(long v)` Writes a long to the stream.
`void`	`writeLongBuffer(java.nio.LongBuffer v)` Writes a LongBuffer to the stream.
`void`	`writeLongSeq(long[] v)` Writes a sequence of longs to the stream.
`void`	`writeObject(Object v)` Writes a Slice class to the stream.
`boolean`	`writeOptional(int tag, OptionalFormat format)` Write the header information for an optional value.
`void`	`writePendingObjects()` Writes the state of Slice classes whose index was previously written with `OutputStream.writeObject(Ice.Object)` to the stream.
`void`	`writeProxy(ObjectPrx v)` Writes a proxy to the stream.
`void`	`writeSerializable(java.io.Serializable v)` Writes a serializable Java object to the stream.
`void`	`writeShort(short v)` Writes a short to the stream.
`void`	`writeShortBuffer(java.nio.ShortBuffer v)` Writes a ShortBuffer to the stream.
`void`	`writeShortSeq(short[] v)` Writes a sequence of shorts to the stream.
`void`	`writeSize(int sz)` Writes a size to the stream.
`void`	`writeString(java.lang.String v)` Writes a string to the stream.
`void`	`writeStringSeq(java.lang.String[] v)` Writes a sequence of strings to the stream.

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

- Constructor Detail
  - OutputStreamI
```
public OutputStreamI(Communicator communicator)
```
  - OutputStreamI
```
public OutputStreamI(Communicator communicator,
                     EncodingVersion v)
```
  - OutputStreamI
```
public OutputStreamI(Communicator communicator,
                     BasicStream os)
```
- Method Detail
  - communicator
```
public Communicator communicator()
```
    Description copied from interface: OutputStream
    
    Returns the communicator for this output stream.
    
    Specified by:
    
    communicator in interface OutputStream
    
    Returns:
    
    The communicator.
  - writeBool
```
public void writeBool(boolean v)
```
    Description copied from interface: OutputStream
    
    Writes a boolean to the stream.
    
    Specified by:
    
    writeBool in interface OutputStream
    
    Parameters:
    
    v - The boolean to write to the stream.
  - writeBoolSeq
```
public void writeBoolSeq(boolean[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of booleans to the stream.
    
    Specified by:
    
    writeBoolSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of booleans to write. Passing null causes an empty sequence to be written to the stream.
  - writeByte
```
public void writeByte(byte v)
```
    Description copied from interface: OutputStream
    
    Writes a byte to the stream.
    
    Specified by:
    
    writeByte in interface OutputStream
    
    Parameters:
    
    v - The byte to write to the stream.
  - writeByteSeq
```
public void writeByteSeq(byte[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of bytes to the stream.
    
    Specified by:
    
    writeByteSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of bytes to write. Passing null causes an empty sequence to be written to the stream.
  - writeByteBuffer
```
public void writeByteBuffer(java.nio.ByteBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a ByteBuffer to the stream.
    
    Specified by:
    
    writeByteBuffer in interface OutputStream
    
    Parameters:
    
    v - The ByteBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeSerializable
```
public void writeSerializable(java.io.Serializable v)
```
    Description copied from interface: OutputStream
    
    Writes a serializable Java object to the stream.
    
    Specified by:
    
    writeSerializable in interface OutputStream
    
    Parameters:
    
    v - The serializable object to write.
  - writeShort
```
public void writeShort(short v)
```
    Description copied from interface: OutputStream
    
    Writes a short to the stream.
    
    Specified by:
    
    writeShort in interface OutputStream
    
    Parameters:
    
    v - The short to write to the stream.
  - writeShortSeq
```
public void writeShortSeq(short[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of shorts to the stream.
    
    Specified by:
    
    writeShortSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of shorts to write. Passing null causes an empty sequence to be written to the stream.
  - writeShortBuffer
```
public void writeShortBuffer(java.nio.ShortBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a ShortBuffer to the stream.
    
    Specified by:
    
    writeShortBuffer in interface OutputStream
    
    Parameters:
    
    v - The ShortBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeInt
```
public void writeInt(int v)
```
    Description copied from interface: OutputStream
    
    Writes an integer to the stream.
    
    Specified by:
    
    writeInt in interface OutputStream
    
    Parameters:
    
    v - The integer to write to the stream.
  - writeIntSeq
```
public void writeIntSeq(int[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of integers to the stream.
    
    Specified by:
    
    writeIntSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of integers to write. Passing null causes an empty sequence to be written to the stream.
  - writeIntBuffer
```
public void writeIntBuffer(java.nio.IntBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a IntBuffer to the stream.
    
    Specified by:
    
    writeIntBuffer in interface OutputStream
    
    Parameters:
    
    v - The IntBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeLong
```
public void writeLong(long v)
```
    Description copied from interface: OutputStream
    
    Writes a long to the stream.
    
    Specified by:
    
    writeLong in interface OutputStream
    
    Parameters:
    
    v - The long to write to the stream.
  - writeLongSeq
```
public void writeLongSeq(long[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of longs to the stream.
    
    Specified by:
    
    writeLongSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of longs to write. Passing null causes an empty sequence to be written to the stream.
  - writeLongBuffer
```
public void writeLongBuffer(java.nio.LongBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a LongBuffer to the stream.
    
    Specified by:
    
    writeLongBuffer in interface OutputStream
    
    Parameters:
    
    v - The LongBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeFloat
```
public void writeFloat(float v)
```
    Description copied from interface: OutputStream
    
    Writes a float to the stream.
    
    Specified by:
    
    writeFloat in interface OutputStream
    
    Parameters:
    
    v - The float to write to the stream.
  - writeFloatSeq
```
public void writeFloatSeq(float[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of floats to the stream.
    
    Specified by:
    
    writeFloatSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of floats to write. Passing null causes an empty sequence to be written to the stream.
  - writeFloatBuffer
```
public void writeFloatBuffer(java.nio.FloatBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a FloatBuffer to the stream.
    
    Specified by:
    
    writeFloatBuffer in interface OutputStream
    
    Parameters:
    
    v - The FloatBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeDouble
```
public void writeDouble(double v)
```
    Description copied from interface: OutputStream
    
    Writes a double to the stream.
    
    Specified by:
    
    writeDouble in interface OutputStream
    
    Parameters:
    
    v - The double to write to the stream.
  - writeDoubleSeq
```
public void writeDoubleSeq(double[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of doubles to the stream.
    
    Specified by:
    
    writeDoubleSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of doubles to write. Passing null causes an empty sequence to be written to the stream.
  - writeDoubleBuffer
```
public void writeDoubleBuffer(java.nio.DoubleBuffer v)
```
    Description copied from interface: OutputStream
    
    Writes a DoubleBuffer to the stream.
    
    Specified by:
    
    writeDoubleBuffer in interface OutputStream
    
    Parameters:
    
    v - The DoubleBuffer to write. Passing null causes an empty sequence to be written to the stream.
  - writeString
```
public void writeString(java.lang.String v)
```
    Description copied from interface: OutputStream
    
    Writes a string to the stream.
    
    Specified by:
    
    writeString in interface OutputStream
    
    Parameters:
    
    v - The string to write to the stream. Passing null causes an empty string to be written to the stream.
  - writeStringSeq
```
public void writeStringSeq(java.lang.String[] v)
```
    Description copied from interface: OutputStream
    
    Writes a sequence of strings to the stream.
    
    Specified by:
    
    writeStringSeq in interface OutputStream
    
    Parameters:
    
    v - The sequence of strings to write. Passing null causes an empty sequence to be written to the stream.
  - writeSize
```
public void writeSize(int sz)
```
    Description copied from interface: OutputStream
    
    Writes a size to the stream.
    
    Specified by:
    
    writeSize in interface OutputStream
    
    Parameters:
    
    sz - The size to write.
  - writeProxy
```
public void writeProxy(ObjectPrx v)
```
    Description copied from interface: OutputStream
    
    Writes a proxy to the stream.
    
    Specified by:
    
    writeProxy in interface OutputStream
    
    Parameters:
    
    v - The proxy to write.
  - writeObject
```
public void writeObject(Object v)
```
    Description copied from interface: OutputStream
    
    Writes a Slice class to the stream.
    
    Specified by:
    
    writeObject in interface OutputStream
    
    Parameters:
    
    v - The class to write. This method writes the index of a Slice class; the state of the class is written once OutputStream.writePendingObjects() is called.
  - writeEnum
```
public void writeEnum(int v,
                      int maxValue)
```
    Description copied from interface: OutputStream
    
    Write an enumerated value.
    
    Specified by:
    
    writeEnum in interface OutputStream
    
    Parameters:
    
    v - The enumerator.
    
    maxValue - The maximum enumerator value in the definition.
  - writeException
```
public void writeException(UserException v)
```
    Description copied from interface: OutputStream
    
    Writes a user exception to the stream.
    
    Specified by:
    
    writeException in interface OutputStream
    
    Parameters:
    
    v - The user exception to write.
  - startObject
```
public void startObject(SlicedData slicedData)
```
    Description copied from interface: OutputStream
    
    Marks the start of an Ice object.
    
    Specified by:
    
    startObject in interface OutputStream
    
    Parameters:
    
    slicedData - Preserved slices for this object, or null.
  - endObject
```
public void endObject()
```
    Description copied from interface: OutputStream
    
    Marks the end of an Ice object.
    
    Specified by:
    
    endObject in interface OutputStream
  - startException
```
public void startException(SlicedData slicedData)
```
    Description copied from interface: OutputStream
    
    Marks the start of a user exception.
    
    Specified by:
    
    startException in interface OutputStream
    
    Parameters:
    
    slicedData - Preserved slices for this exception, or null.
  - endException
```
public void endException()
```
    Description copied from interface: OutputStream
    
    Marks the end of a user exception.
    
    Specified by:
    
    endException in interface OutputStream
  - startSlice
```
public void startSlice(java.lang.String typeId,
                       int compactId,
                       boolean last)
```
    Description copied from interface: OutputStream
    
    Marks the start of a new slice for an Ice object or user exception.
    
    Specified by:
    
    startSlice in interface OutputStream
    
    Parameters:
    
    typeId - The Slice type ID corresponding to this slice.
    
    compactId - The Slice compact type ID corresponding to this slice or -1 if no compact ID is defined for the type ID.
    
    last - True if this is the last slice, false otherwise.
  - endSlice
```
public void endSlice()
```
    Description copied from interface: OutputStream
    
    Marks the end of a slice for an Ice object or user exception.
    
    Specified by:
    
    endSlice in interface OutputStream
  - startEncapsulation
```
public void startEncapsulation(EncodingVersion encoding,
                               FormatType format)
```
    Description copied from interface: OutputStream
    
    Writes the start of an encapsulation to the stream.
    
    Specified by:
    
    startEncapsulation in interface OutputStream
    
    Parameters:
    
    encoding - The encoding version of the encapsulation.
    
    format - Specify the compact or sliced format.
  - startEncapsulation
```
public void startEncapsulation()
```
    Description copied from interface: OutputStream
    
    Writes the start of an encapsulation to the stream.
    
    Specified by:
    
    startEncapsulation in interface OutputStream
  - endEncapsulation
```
public void endEncapsulation()
```
    Description copied from interface: OutputStream
    
    Ends the previous encapsulation.
    
    Specified by:
    
    endEncapsulation in interface OutputStream
  - getEncoding
```
public EncodingVersion getEncoding()
```
    Description copied from interface: OutputStream
    
    Determines the current encoding version.
    
    Specified by:
    
    getEncoding in interface OutputStream
    
    Returns:
    
    The encoding version.
  - writePendingObjects
```
public void writePendingObjects()
```
    Description copied from interface: OutputStream
    
    Writes the state of Slice classes whose index was previously written with OutputStream.writeObject(Ice.Object) to the stream.
    
    Specified by:
    
    writePendingObjects in interface OutputStream
  - writeOptional
```
public boolean writeOptional(int tag,
                             OptionalFormat format)
```
    Description copied from interface: OutputStream
    
    Write the header information for an optional value.
    
    Specified by:
    
    writeOptional in interface OutputStream
    
    Parameters:
    
    tag - The numeric tag associated with the value.
    
    format - The optional format of the value.
    
    Returns:
    
    True if the current encoding supports optionals, false otherwise.
  - pos
```
public int pos()
```
    Description copied from interface: OutputStream
    
    Determines the current position in the stream.
    
    Specified by:
    
    pos in interface OutputStream
    
    Returns:
    
    The current position.
  - rewrite
```
public void rewrite(int sz,
                    int pos)
```
    Description copied from interface: OutputStream
    
    Inserts a fixed 32-bit size value into the stream at the given position.
    
    Specified by:
    
    rewrite in interface OutputStream
    
    Parameters:
    
    sz - The 32-bit size value.
    
    pos - The position at which to write the value.
  - startSize
```
public int startSize()
```
    Description copied from interface: OutputStream
    
    Returns the current position and allocates four bytes for a fixed-length (32-bit) size value.
    
    Specified by:
    
    startSize in interface OutputStream
    
    Returns:
    
    The current position.
  - endSize
```
public void endSize(int pos)
```
    Description copied from interface: OutputStream
    
    Computes the amount of data written since the previous call to startSize and writes that value at the saved position.
    
    Specified by:
    
    endSize in interface OutputStream
    
    Parameters:
    
    pos - The saved position.
  - finished
```
public byte[] finished()
```
    Description copied from interface: OutputStream
    
    Indicates that marshaling of a request or reply is finished.
    
    Specified by:
    
    finished in interface OutputStream
    
    Returns:
    
    The byte sequence containing the encoded request or reply.
  - reset
```
public void reset(boolean clearBuffer)
```
    Description copied from interface: OutputStream
    
    Resets this output stream. This method allows the stream to be reused, to avoid creating unnecessary garbage.
    
    Specified by:
    
    reset in interface OutputStream
    
    Parameters:
    
    clearBuffer - If true, the stream's internal buffer becomes eligible for garbage collection; if false, the stream's internal buffer is retained, to avoid creating unnecessary garbage. If retained, the internal buffer may be resized to a smaller capacity. Either way, reset resets the stream's writing position to zero.
  - destroy
```
public void destroy()
```
    Description copied from interface: OutputStream
    
    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 OutputStream

Class OutputStreamI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutputStreamI

OutputStreamI

OutputStreamI

Method Detail

communicator

writeBool

writeBoolSeq

writeByte

writeByteSeq

writeByteBuffer

writeSerializable

writeShort

writeShortSeq

writeShortBuffer

writeInt

writeIntSeq

writeIntBuffer

writeLong

writeLongSeq

writeLongBuffer

writeFloat

writeFloatSeq

writeFloatBuffer

writeDouble

writeDoubleSeq

writeDoubleBuffer

writeString

writeStringSeq

writeSize

writeProxy

writeObject

writeEnum

writeException

startObject

endObject

startException

endException

startSlice

endSlice

startEncapsulation

startEncapsulation

endEncapsulation

getEncoding

writePendingObjects

writeOptional

pos

rewrite

startSize

endSize

finished

reset

destroy