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.
Public Member Functions inherited from decaf::io::Writer
	Writer ()
virtual	~Writer ()
virtual void	write (char v)
	Writes an single byte char value.
virtual void	write (const std::vector< char > &buffer)
	Writes an array of Chars.
virtual void	write (const char *buffer, int size)
	Writes a byte array to the output stream.
virtual void	write (const char *buffer, int size, int offset, int length)
	Writes a byte array to the output stream.
virtual void	write (const std::string &str)
	Writes a string.
virtual void	write (const std::string &str, int offset, int length)
	Writes a string.
virtual decaf::lang::Appendable &	append (char value)
	Appends the specified character to this Appendable.
virtual decaf::lang::Appendable &	append (const decaf::lang::CharSequence *csq)
	Appends the specified character sequence to this Appendable.
virtual decaf::lang::Appendable &	append (const decaf::lang::CharSequence *csq, int start, int end)
	Appends a subsequence of the specified character sequence to this Appendable.
Public Member Functions inherited from decaf::io::Closeable
virtual	~Closeable ()
virtual void	close ()=0
	Closes this object and deallocates the appropriate resources.
Public Member Functions inherited from decaf::io::Flushable
virtual	~Flushable ()
virtual void	flush ()=0
	Flushes this stream by writing any buffered output to the underlying stream.
Public Member Functions inherited from decaf::lang::Appendable
virtual	~Appendable ()
virtual Appendable &	append (char value)=0
	Appends the specified character to this Appendable.
virtual Appendable &	append (const CharSequence *csq)=0
	Appends the specified character sequence to this Appendable.
virtual Appendable &	append (const CharSequence *csq, int start, int end)=0
	Appends a subsequence of the specified character sequence to this Appendable.

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
Protected Member Functions inherited from decaf::io::Writer
virtual void	doWriteArrayBounded (const char *buffer, int size, int offset, int length)=0
	Override this method to customize the functionality of the method write( char* buffer, int size, int offset, int length ).
virtual void	doWriteChar (char v)
virtual void	doWriteVector (const std::vector< char > &buffer)
virtual void	doWriteArray (const char *buffer, int size)
virtual void	doWriteString (const std::string &str)
virtual void	doWriteStringBounded (const std::string &str, int offset, int length)
virtual decaf::lang::Appendable &	doAppendChar (char value)
virtual decaf::lang::Appendable &	doAppendCharSequence (const decaf::lang::CharSequence *csq)
virtual decaf::lang::Appendable &	doAppendCharSequenceStartEnd (const decaf::lang::CharSequence *csq, int start, int end)

Detailed Description

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

See also

InputStreamReader

Since

1.0

Constructor & Destructor Documentation

OutputStreamWriter()

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

Creates a new OutputStreamWriter.

Parameters

stream	The OutputStream to wrap. (cannot be NULL).
own	Indicates whether this instance own the given OutputStream. If true then the OutputStream is destroyed when this class is.

Exceptions

NullPointerException

if the stream is NULL.

~OutputStreamWriter()

virtual decaf::io::OutputStreamWriter::~OutputStreamWriter ( )

virtual

Member Function Documentation

checkClosed()

virtual void decaf::io::OutputStreamWriter::checkClosed ( ) const

protectedvirtual

close()

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

IOException

if an error occurs while closing.

Implements decaf::io::Closeable.

doWriteArrayBounded()

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

protectedvirtual

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.

flush()

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

virtual

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

Exceptions

IOException

if an I/O error occurs.

Implements decaf::io::Flushable.

---

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

• src/main/decaf/io/OutputStreamWriter.h