co.codewizards.cloudstore.core.io

Interface IOutputStream

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

IByteArrayOutputStream

All Known Implementing Classes:

ByteArrayOutputStream, NoCloseOutputStream

public interface IOutputStream
extends AutoCloseable

OutputStream-representing interface to be used in API contracts.

Interfaces modelling API should always use IOutputStream instead of OutputStream, because this facilitates the usage of proxies. Proxies are needed to use APIs accross local-server/-client boundaries.

To convert between OutputStream and IOutputStream, use StreamUtil.castStream(IOutputStream) or StreamUtil.castStream(OutputStream).

It is recommended that you statically import StreamUtil.* whenever you need a castStream(...). Also, you should register this in your IDE as a favorite for static method imports.

Important note about the naming: We usually never use the "I-for-interface" naming scheme! It sucks! But due to the fact that we already have "OutputStream" rather than "OutputStreamImpl", we exceptionally use the "I"-prefix here.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

See Also:

StreamUtil

Method Summary

Modifier and Type	Method and Description
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.
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.
void	write(int b) Writes the specified byte to this output stream.

Method Detail

write

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.

Subclasses of IOutputStream must provide an implementation for this method.

Parameters:

b - the byte.

Throws:

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

write

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 - the data.

Throws:

IOException - if an I/O error occurs.

See Also:

OutputStream.write(byte[], int, int)

write

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.

The write method of IOutputStream 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.

Throws:

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

flush

void flush()
    throws IOException

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 IOutputStream does nothing.

Throws:

IOException - if an I/O error occurs.

close

void close()
    throws IOException

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 IOutputStream does nothing.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs.