Summary: Ctors | Methods | Inherited Methods

OutputStream

public abstract class OutputStream
extends Object implements Closeable, Flushable

java.lang.Object
↳	java.io.OutputStream

Known direct subclasses

ByteArrayOutputStream, FileOutputStream, FilterOutputStream, ObjectOutputStream, PipedOutputStream

ByteArrayOutputStream	This class implements an output stream in which the data is written into a byte array.
FileOutputStream	A file output stream is an output stream for writing data to a `File` or to a `FileDescriptor`.
FilterOutputStream	This class is the superclass of all classes that filter output streams.
ObjectOutputStream	An ObjectOutputStream writes primitive data types and graphs of Java objects to an OutputStream.
PipedOutputStream	A piped output stream can be connected to a piped input stream to create a communications pipe.

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 `ParcelFileDescriptor.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	The class implements a buffered output stream.
CheckedOutputStream	An output stream that also maintains a checksum of the data being written.
CipherOutputStream	A CipherOutputStream is composed of an OutputStream and a Cipher so that write() methods first process the data before writing them out to the underlying OutputStream.
DataOutputStream	A data output stream lets an application write primitive Java data types to an output stream in a portable way.
DeflaterOutputStream	This class implements an output stream filter for compressing data in the "deflate" compression format.
DigestOutputStream	A transparent stream that updates the associated message digest using the bits going through the stream.
GZIPOutputStream	This class implements a stream filter for writing compressed data in the GZIP file format.
InflaterOutputStream	Implements an output stream filter for uncompressing data stored in the "deflate" compression format.
JarOutputStream	The `JarOutputStream` class is used to write the contents of a JAR file to any 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	A `PrintStream` adds functionality to another output stream, namely the ability to print representations of various data values conveniently.
ZipOutputStream	This class implements an output stream filter for writing files in the ZIP file format.

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.

See also:

Summary

Public constructors
`OutputStream()` Constructor for subclasses to call.

Public methods
`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
`static OutputStream`	`nullOutputStream()` Returns a new `OutputStream` which discards all bytes.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`abstract void`	`write(int b)` Writes the specified byte to this output stream.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface java.io.Closeable

abstract void

close()

Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush()

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

From interface java.lang.AutoCloseable

abstract void

close()

Closes this resource, relinquishing any underlying resources.

Public constructors

OutputStream

Added in API level 1

 public OutputStream ()

Constructor for subclasses to call.

Public methods

close

Added in API level 1

 public void close ()

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.

Throws
`IOException`	if an I/O error occurs.

flush

Added in API level 1

 public void flush ()

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.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

The flush method of OutputStream does nothing.

Throws
`IOException`	if an I/O error occurs.

nullOutputStream

Added in API level 33

 public static OutputStream nullOutputStream ()

Returns a new OutputStream which discards all bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.

While the stream is open, the write(int), write(byte[]), and write(byte[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException.

The flush() method does nothing.

Returns
`OutputStream`	an `OutputStream` which discards all bytes

write

Added in API level 1

 public void write (byte[] b)

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`	`byte`: the data.

Throws
`IOException`	if an I/O error occurs.

See also:

write(byte[], int, int)

write

Added in API level 1

 public void write (byte[] b, int off, int len)

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`	`byte`: the data.
`off`	`int`: the start offset in the data.
`len`	`int`: the number of bytes to write.

Throws
`IOException`	if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

write

Added in API level 1

 public abstract void write (int b)

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`	`int`: the `byte`.

Throws
`IOException`	if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.