Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: io ::

interface XOutputStream
Description
This is the basic interface to write data to a stream.

See the streaming document for further information on chaining and piping streams.


Methods' Summary
writeBytes writes the whole sequence to the stream. (blocking call)  
flush flushes out of the stream any data that may exist in buffers.  
closeOutput gets called to indicate that all data has been written.  
Methods' Details
writeBytes
void
writeBytes( [in] sequence< byte >  aData )
raises( NotConnectedException,
BufferSizeExceededException,
IOException );

Description
writes the whole sequence to the stream. (blocking call)
flush
void
flush()
raises( NotConnectedException,
BufferSizeExceededException,
IOException );

Description
flushes out of the stream any data that may exist in buffers.

The semantics of this method are rather vague. See XAsyncOutputMonitor::waitForCompletion for a similar method with very specific semantics, that is useful in certain scenarios.

closeOutput
void
closeOutput()
raises( NotConnectedException,
BufferSizeExceededException,
IOException );

Description
gets called to indicate that all data has been written.

If this method has not yet been called, no attached XInputStream receives an EOF signal. No further bytes may be written after this method has been called.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.