to top

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Since: API Level 1

public abstract class

OutputStream

extends Object
implements Closeable Flushable

java.lang.Object
↳	java.io.OutputStream

Known Direct Subclasses

ByteArrayOutputStream, ChunkedOutputStream, ContentLengthOutputStream, FileOutputStream, FilterOutputStream, IdentityOutputStream, ObjectOutputStream, PipedOutputStream

Known Indirect Subclasses

AssetFileDescriptor.AutoCloseOutputStream, Base64OutputStream, BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, GZIPOutputStream, InflaterOutputStream, JarOutputStream, ParcelFileDescriptor.AutoCloseOutputStream, PrintStream, ZipOutputStream

AssetFileDescriptor.AutoCloseOutputStream	An OutputStream you can create on a ParcelFileDescriptor, which will take care of calling `ParcelFileDescritor.close()` for you when the stream is closed.
Base64OutputStream	An OutputStream that does Base64 encoding on the data written to it, writing the resulting data to another OutputStream.
BufferedOutputStream	Wraps an existing `OutputStream` and buffers the output.
CheckedOutputStream	The `CheckedOutputStream` class is used to maintain a running checksum of all data written to a stream.
CipherOutputStream	This class wraps an output stream and a cipher so that `write` methods send the data through the cipher before writing them to the underlying output stream.
DataOutputStream	Wraps an existing `OutputStream` and writes big-endian typed data to it.
DeflaterOutputStream	This class provides an implementation of `FilterOutputStream` that compresses data using the DEFLATE algorithm.
DigestOutputStream	`DigestOutputStream` is a `FilterOutputStream` which maintains an associated message digest.
GZIPOutputStream	The `GZIPOutputStream` class is used to write data to a stream in the GZIP storage format.
InflaterOutputStream	An `OutputStream` filter to decompress data.
JarOutputStream	The `JarOutputStream` is used to write data in the `JarFile` format to an arbitrary output stream
ParcelFileDescriptor.AutoCloseOutputStream	An OutputStream you can create on a ParcelFileDescriptor, which will take care of calling `ParcelFileDescriptor.close()` for you when the stream is closed.
PrintStream	Wraps an existing `OutputStream` and provides convenience methods for writing common data types in a human readable format.
ZipOutputStream	This class provides an implementation of `FilterOutputStream` that compresses data entries into a ZIP-archive output stream.

Class Overview

A writable sink for bytes.

Most clients will use output streams that write data to the file system (FileOutputStream), the network (getOutputStream()/getOutputStream()), or to an in-memory byte array (ByteArrayOutputStream).

Use OutputStreamWriter to adapt a byte stream like this one into a character stream.

Most clients should wrap their output stream with BufferedOutputStream. Callers that do only bulk writes may omit buffering.

Subclassing OutputStream

Subclasses that decorate another output stream should consider subclassing FilterOutputStream, which delegates all calls to the target output stream.

All output stream subclasses should override both write(int) and write(byte[],int,int). The three argument overload is necessary for bulk access to the data. This is much more efficient than byte-by-byte access.

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) Equivalent to `write(buffer, 0, buffer.length)`.
abstract void	write(int oneByte) Writes a single byte to this stream.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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

Equivalent to write(buffer, 0, buffer.length).

Throws

IOException

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.

Results

Interfaces

Classes

Exceptions

Errors

OutputStream

Class Overview

Subclassing OutputStream

See Also

Summary

Public Constructors

public OutputStream ()

Public Methods

public void close ()

Throws

public void flush ()

Throws

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

Parameters

Throws

public void write (byte[] buffer)

Throws

public abstract void write (int oneByte)

Parameters

Throws