java::io::FilterOutputStream Class Reference

This class is the superclass of all classes that filter output streams. More...

#include <java_io_FilterOutputStream.h>

Inheritance diagram for java::io::FilterOutputStream:

[legend]Collaboration diagram for java::io::FilterOutputStream:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::io::FilterOutputStream >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::io::FilterOutputStream > >	array2D
Public Member Functions
virtual void	close (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Closes this output stream and releases any system resources associated with the stream.
	FilterOutputStream (const ::java::io::OutputStream &out,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates an output stream filter built on top of the specified underlying output stream.
virtual void	flush (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Flushes this output stream and forces any buffered output bytes to be written out to the stream.
virtual void	write (const ::xmog_java_byte_array &b, jint off, jint len,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes len bytes from the specified byte array starting at offset off to this output stream.
virtual void	write (const ::xmog_java_byte_array &b,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes b.length bytes to this output stream.
virtual void	write (jint b,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Writes the specified byte to this output stream.

---

Detailed Description

This class is the superclass of all classes that filter output streams.

These streams sit on top of an already existing output stream (the underlying output stream) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality.

The class FilterOutputStream itself simply overrides all methods of OutputStream with versions that pass all requests to the underlying output stream. Subclasses of FilterOutputStream may further override some of these methods as well as provide additional methods and fields.

Author:

Jonathan Payne

---

Constructor & Destructor Documentation

java::io::FilterOutputStream::FilterOutputStream (  const ::java::io::OutputStream &  out, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates an output stream filter built on top of the specified underlying output stream. Parameters: out  the underlying output stream to be assigned to the field this.out for later use, or null if this instance is to be created without an underlying stream. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

virtual void java::io::FilterOutputStream::close (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Closes this output stream and releases any system resources associated with the stream. The close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::io::OutputStream. Reimplemented in java::io::PrintStream.

virtual void java::io::FilterOutputStream::flush (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Flushes this output stream and forces any buffered output bytes to be written out to the stream. The flush method of FilterOutputStream calls the flush method of its underlying output stream. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::io::OutputStream. Reimplemented in java::io::PrintStream.

virtual void java::io::FilterOutputStream::write (  const ::xmog_java_byte_array &  b, jint  off, jint  len, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes len bytes from the specified byte array starting at offset off to this output stream. The write method of FilterOutputStream calls the write method of one argument on each byte to output. Note that this method does not call the write method of its underlying input stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method. Parameters: b  the data. off  the start offset in the data. len  the number of bytes to write. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::io::OutputStream. Reimplemented in java::io::PrintStream.

virtual void java::io::FilterOutputStream::write (  const ::xmog_java_byte_array &  b, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes b.length bytes to this output stream. The write method of FilterOutputStream calls its write method of three arguments with the arguments b, 0, and b.length. Note that this method does not call the one-argument write method of its underlying stream with the single argument b. Parameters: b  the data to be written. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::io::OutputStream.

virtual void java::io::FilterOutputStream::write (  jint  b, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Writes the specified byte to this output stream. The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b). Implements the abstract write method of OutputStream. Parameters: b  the byte. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::io::OutputStream. Reimplemented in java::io::PrintStream.

---

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

• java_io_FilterOutputStream.h

---