public abstract class

OutputStream

extends Object
implements Closeable Flushable
java.lang.Object
   ↳ java.io.OutputStream
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The base class for all output streams. An output stream is a means of writing data to a target in a byte-wise manner. Most output streams expect the flush() method to be called before closing the stream, to ensure all data is actually written through.

This abstract class does not provide a fully working implementation, so it needs to be subclassed, and at least the write(int) method needs to be overridden. Overriding some of the non-abstract methods is also often advised, since it might result in higher efficiency.

Many specialized output streams for purposes like writing to a file already exist in this package.

See Also

Summary

Public Constructors
OutputStream()
Default constructor.
Public Methods
void close()
Closes this stream.
void flush()
Flushes this stream.
void write(byte[] buffer, int offset, int count)
Writes count bytes from the byte array buffer starting at position offset to this stream.
void write(byte[] buffer)
Writes the entire contents of the byte array buffer to this stream.
abstract void write(int oneByte)
Writes a single byte to this stream.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable

Public Constructors

public OutputStream ()

Since: API Level 1

Default constructor.

Public Methods

public void close ()

Since: API Level 1

Closes this stream. Implementations of this method should free any resources used by the stream. This implementation does nothing.

Throws
IOException if an error occurs while closing this stream.

public void flush ()

Since: API Level 1

Flushes this stream. Implementations of this method should ensure that any buffered data is written out. This implementation does nothing.

Throws
IOException if an error occurs while flushing this stream.

public void write (byte[] buffer, int offset, int count)

Since: API Level 1

Writes count bytes from the byte array buffer starting at position offset to this stream.

Parameters
buffer the buffer to be written.
offset the start position in buffer from where to get bytes.
count the number of bytes from buffer to write to this stream.
Throws
IOException if an error occurs while writing to this stream.
IndexOutOfBoundsException if offset < 0 or count < 0, or if offset + count is bigger than the length of buffer.

public void write (byte[] buffer)

Since: API Level 1

Writes the entire contents of the byte array buffer to this stream.

Parameters
buffer the buffer to be written.
Throws
IOException if an error occurs while writing to this stream.

public abstract void write (int oneByte)

Since: API Level 1

Writes a single byte to this stream. Only the least significant byte of the integer oneByte is written to the stream.

Parameters
oneByte the byte to be written.
Throws
IOException if an error occurs while writing to this stream.