activemq-cpp-3.4.0

decaf::io::OutputStreamWriter Class Reference

A class for turning a character stream into a byte stream. More...

#include <src/main/decaf/io/OutputStreamWriter.h>

Inheritance diagram for decaf::io::OutputStreamWriter:

Public Member Functions

 OutputStreamWriter (OutputStream *stream, bool own=false)
 Creates a new OutputStreamWriter.
virtual ~OutputStreamWriter ()
virtual void close ()
 Closes this object and deallocates the appropriate resources.
virtual void flush ()
 Flushes this stream by writing any buffered output to the underlying stream.

Protected Member Functions

virtual void doWriteArrayBounded (const char *buffer, int size, int offset, int length)
 Override this method to customize the functionality of the method write( char* buffer, int size, int offset, int length ).
virtual void checkClosed () const

Detailed Description

A class for turning a character stream into a byte stream.

See also:
InputStreamReader
Since:
1.0

Constructor & Destructor Documentation

decaf::io::OutputStreamWriter::OutputStreamWriter ( OutputStream stream,
bool  own = false 
)

Creates a new OutputStreamWriter.

Parameters:
streamThe OutputStream to wrap. (cannot be NULL).
ownIndicates whether this instance own the given OutputStream. If true then the OutputStream is destroyed when this class is.
Exceptions:
NullPointerExceptionif the stream is NULL.
virtual decaf::io::OutputStreamWriter::~OutputStreamWriter ( ) [virtual]

Member Function Documentation

virtual void decaf::io::OutputStreamWriter::checkClosed ( ) const [protected, virtual]
virtual void decaf::io::OutputStreamWriter::close ( ) [virtual]

Closes this object and deallocates the appropriate resources.

The object is generally no longer usable after calling close.

Exceptions:
IOExceptionif an error occurs while closing.

Implements decaf::io::Closeable.

virtual void decaf::io::OutputStreamWriter::doWriteArrayBounded ( const char *  buffer,
int  size,
int  offset,
int  length 
) [protected, virtual]

Override this method to customize the functionality of the method write( char* buffer, int size, int offset, int length ).

All subclasses must override this method to provide the basic Writer functionality.

Implements decaf::io::Writer.

virtual void decaf::io::OutputStreamWriter::flush ( ) [virtual]

Flushes this stream by writing any buffered output to the underlying stream.

Exceptions:
IOExceptionif an I/O error occurs.

Implements decaf::io::Flushable.


The documentation for this class was generated from the following file: