OpenJDK 1.23 · java.io.OutputStream · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	OutputStream() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public static OutputStream	Returns: an `OutputStream` which discards all bytes nullOutputStream() Returns a new `OutputStream` which discards all bytes.
public abstract void	write(int the `byte`. b) Writes the specified byte to this output stream.
public void	write(byte[] the data. b) Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

OutputStream	back to summary
public OutputStream() Constructor for subclasses to call.

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.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. Implementation Specification The `close` method of `OutputStream` does nothing. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Implements java.io.Closeable.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.

Implementation Specification

The close method of OutputStream does nothing.

Exceptions

IOException:: if an I/O error occurs.

flush back to summary

flush	back to summary
public void flush() throws IOException Implements java.io.Flushable.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. Implementation Specification The `flush` method of `OutputStream` does nothing. Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Implements java.io.Flushable.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.

Implementation Specification

The flush method of OutputStream does nothing.

Exceptions

IOException:: if an I/O error occurs.

nullOutputStream back to summary

nullOutputStream	back to summary
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 Since 11

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
Since: 11

write back to summary

write	back to summary
public abstract void write(int b) throws IOException 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. Parameters b:int the `byte`. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public abstract void write(int b) throws IOException

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.

Parameters

b:int: the byte.

Exceptions

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

write back to summary

write	back to summary
public void write(byte[] b) throws IOException 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. Exceptions IOException: if an I/O error occurs. See Also `java.io.OutputStream#write(byte[], int, int)`

public void write(byte[] b) throws IOException

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.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException 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. 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. Implementation Specification The `write` method of `OutputStream` calls the write method of one argument on each of the bytes to be written out. API Note Subclasses are encouraged to override this method and provide a more efficient implementation. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed. IndexOutOfBoundsException: If `off` is negative, `len` is negative, or `len` is greater than `b.length - off`

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

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.

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.

Implementation Specification

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out.

API Note

Subclasses are encouraged to override this method and provide a more efficient implementation.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
IndexOutOfBoundsException:: If off is negative, len is negative, or len is greater than b.length - off

public abstract Class OutputStream

Constructor Summary

Method Summary

Constructor Detail

Method Detail