OutputStream (ice 3.6.5 API)

All Known Implementing Classes:

OutputStreamI
```
public interface OutputStream
```
Interface for output streams used to write Slice types to a sequence of bytes.

See Also:

InputStream

Method Summary

All Methods Instance Methods Abstract 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 ex)` 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 `writeObject(Ice.Object)` to the stream.
`void`	`writeProxy(ObjectPrx v)` Writes a proxy to the stream.
`void`	`writeSerializable(java.io.Serializable o)` 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.

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

Method Summary

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