jsimple.io

Class OutputStream

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.OutputStream

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ByteArrayOutputStream, JSimpleOutputStreamOnJavaStream

public abstract class OutputStream
extends AutoCloseable

This class was based on, and modified from, the Apache Harmony java.io.OutputStream class. Unlike the standard Java OutputStream class, this doesn't throw any checked exceptions.

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.

Since:

10/7/12 12:31 AM

See Also:

InputStream

Constructor Summary

Constructors

Constructor and Description
OutputStream()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream, freeing any resources associated with it and then calling the closedListener, if one is set.
protected abstract void	doClose() This is an internal method, implemented by subclasses to close any resources associated with the stream.
void	flush() Flushes this stream.
ClosedListener	getClosedListener()
void	setClosedListener(ClosedListener closedListener) A ClosedListener provides a way to be notified when the stream is closed.
void	write(byte[] buffer) Writes the entire contents of the byte array buffer to this stream.
void	write(byte[] buffer, int offset, int length) Writes count bytes from the byte array buffer starting at position offset to this stream.
void	write(ByteArrayRange byteArrayRange)
abstract void	write(int oneByte) Writes a single byte to this stream.
void	writeLatin1EncodedString(java.lang.String s) Write the string, assumed to contain only Latin1 characters (Unicode low 256 characters), to the stream.
void	writeUtf8EncodedString(java.lang.String s) Write the string to the stream using UTF-8 encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputStream

public OutputStream()

Method Detail

write

public void write(byte[] buffer)

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

write

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

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

length - the number of bytes from buffer to write to this stream

Throws:

IOException - if an error occurs while writing to this stream

write

public void write(ByteArrayRange byteArrayRange)

write

public abstract void write(int oneByte)

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:

java.io.IOException - if an error occurs while writing to this stream.

writeLatin1EncodedString

public void writeLatin1EncodedString(java.lang.String s)

Write the string, assumed to contain only Latin1 characters (Unicode low 256 characters), to the stream. A single byte is written for each character; this the most commonly used single byte encoding for text. If the string contains any non-Latin1 characters, an exception is thrown.

Parameters:

s - string to write

flush

public void flush()

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

writeUtf8EncodedString

public void writeUtf8EncodedString(java.lang.String s)

Write the string to the stream using UTF-8 encoding.

Parameters:

s - string to write

close

public final void close()

Closes this stream, freeing any resources associated with it and then calling the closedListener, if one is set. If the stream is closed multiple times, the closedListener is called exactly once, on the first close.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class AutoCloseable

Throws:

IOException - if an error occurs while closing this stream.

doClose

protected abstract void doClose()

This is an internal method, implemented by subclasses to close any resources associated with the stream. The external close() method calls this method, then calls all the closed listeners (if any), assuming this method didn't throw an exception, to notify of the stream being closed. Implementations of this method should free any resources used by the stream.

Throws:

IOException - if an error occurs while closing this stream.

getClosedListener

@Nullable
public ClosedListener getClosedListener()

setClosedListener

public void setClosedListener(@Nullable
                              ClosedListener closedListener)

A ClosedListener provides a way to be notified when the stream is closed.

Parameters:

closedListener -