jsimple.io

Class JSimpleOutputStreamOnJavaStream

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.OutputStream

jsimple.io.JSimpleOutputStreamOnJavaStream

All Implemented Interfaces:

java.lang.AutoCloseable

public class JSimpleOutputStreamOnJavaStream
extends OutputStream

This class turns a java.io.OutputStream into a JSimple OutputStream. It's a straight pass through, except that checked exceptions are turned into similar platform independent unchecked exceptions.

Since:

10/7/12 12:12 AM

Constructor Summary

Constructors

Constructor and Description
JSimpleOutputStreamOnJavaStream(java.io.OutputStream javaOutputStream)
JSimpleOutputStreamOnJavaStream(java.io.OutputStream javaOutputStream, boolean ignoreClose) Create a JSimple stream that wraps the specified Java OutputStream.

Method Summary

Modifier and Type	Method and Description
protected void	doClose() This is an internal method, implemented by subclasses to close any resources associated with the stream.
void	flush() Flushes this stream.
void	write(byte[] b) Writes the entire contents of the byte array buffer to this stream.
void	write(byte[] b, int offset, int length) Writes count bytes from the byte array buffer starting at position offset to this stream.
void	write(int oneByte) Writes a single byte to this stream.

Methods inherited from class jsimple.io.OutputStream

close, getClosedListener, setClosedListener, write, writeLatin1EncodedString, writeUtf8EncodedString

Methods inherited from class java.lang.Object

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

Constructor Detail

JSimpleOutputStreamOnJavaStream

public JSimpleOutputStreamOnJavaStream(java.io.OutputStream javaOutputStream)

JSimpleOutputStreamOnJavaStream

public JSimpleOutputStreamOnJavaStream(java.io.OutputStream javaOutputStream,
                                       boolean ignoreClose)

Create a JSimple stream that wraps the specified Java OutputStream. If ignoreClose is true then calls to close() don't actually close the underlying stream--they don't do anything.

Parameters:

javaOutputStream - Java OutputStream

ignoreClose - whether or not to close the underlying stream when this stream is closed

Method Detail

write

public void write(int oneByte)

Description copied from class: OutputStream

Writes a single byte to this stream. Only the least significant byte of the integer oneByte is written to the stream.

Specified by:

write in class OutputStream

Parameters:

oneByte - the byte to be written.

write

public void write(byte[] b)

Description copied from class: OutputStream

Writes the entire contents of the byte array buffer to this stream.

Overrides:

write in class OutputStream

Parameters:

b - the buffer to be written

write

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

Description copied from class: OutputStream

Writes count bytes from the byte array buffer starting at position offset to this stream.

Overrides:

write in class OutputStream

Parameters:

b - 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

flush

public void flush()

Description copied from class: OutputStream

Flushes this stream. Implementations of this method should ensure that any buffered data is written out. This implementation does nothing.

Overrides:

flush in class OutputStream

doClose

protected void doClose()

Description copied from class: OutputStream

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.

Specified by:

doClose in class OutputStream