java::io::OutputStream Class Reference

This abstract class is the superclass of all classes representing an output stream of bytes. More...

#include <java_io_OutputStream.h>

Inheritance diagram for java::io::OutputStream:

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

[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::OutputStream >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::io::OutputStream > >	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 this 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.
	OutputStream (::xmog_dummy _use_java_ctor,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
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 from the specified byte array 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 abstract class is the superclass of all classes representing an output stream of bytes.

An output stream accepts output bytes and sends them to some sink.

Applications that need to define a subclass of OutputStream must always provide at least a method that writes one byte of output.

Author:

Arthur van Hoff

---

Constructor & Destructor Documentation

java::io::OutputStream::OutputStream (  ::xmog_dummy  _use_java_ctor, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Parameters: _use_java_ctor  indicates that you want to delegate to a Java constructor whose natural proxy conflicts with a C++ requirement. 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::OutputStream::close (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. The close method of OutputStream does nothing. 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 in java::io::FilterOutputStream, and java::io::PrintStream.

virtual void java::io::OutputStream::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. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. The flush method of OutputStream does nothing. 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 in java::io::FilterOutputStream, and java::io::PrintStream.

virtual void java::io::OutputStream::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 general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation. The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. 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 in java::io::FilterOutputStream, and java::io::PrintStream.

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

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length). Parameters: b  the data. 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 in java::io::FilterOutputStream.

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

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored. Subclasses of OutputStream must provide an implementation for this method. 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 in java::io::FilterOutputStream, and java::io::PrintStream.

---

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

• java_io_OutputStream.h

---