org.osgl.util

Class OutputStreamOutput

java.lang.Object

org.osgl.util.OutputStreamOutput

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, Output

public class OutputStreamOutput
extends Object
implements Output

Nested Class Summary

Nested classes/interfaces inherited from interface org.osgl.util.Output

Output.Adaptors, Output.Buffer

Constructor Summary

Constructors

Constructor and Description
OutputStreamOutput(OutputStream os)

Method Summary

Methods

Modifier and Type	Method and Description
Output	append(byte b) Appends a byte to this Output.
Output	append(byte[] bytes) Appends a byte array to this Output.
Output	append(byte[] bytes, int start, int end) Appends a subsequence of the specified byte array to this Output.
Output	append(ByteBuffer buffer) Appends the specified buffer into this Appendable.
Output	append(char c) Appends the specified character to this Output.
Output	append(CharSequence csq) Appends the specified character sequence to this Output.
Output	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this Output.
OutputStream	asOutputStream() Create an OutputStream based on this Output instance.
Writer	asWriter() Create an Writer based on this Output instance.
void	close() Close this Output instance.
void	flush() Flushes the output.
void	open() Prepare this Output instance for appending.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStreamOutput

public OutputStreamOutput(OutputStream os)

Method Detail

open

public void open()

Description copied from interface: Output

Prepare this Output instance for appending. If any append method is called before calling open(), then open() will be called implicitly before appending happens.

Specified by:

open in interface Output

close

public void close()

Description copied from interface: Output

Close this Output instance. Call to any append method after the Output is closed will result in IllegalStateException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Output

flush

public void flush()

Description copied from interface: Output

Flushes the output. If the output has saved any characters from the various append() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this output 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.

Specified by:

flush in interface Flushable

Specified by:

flush in interface Output

append

public Output append(CharSequence csq)

Description copied from interface: Output

Appends the specified character sequence to this Output.

Depending on which class implements the character sequence csq, the entire sequence may not be appended. For instance, if csq is a CharBuffer then the subsequence to append is defined by the buffer’s position and limit.

Specified by:

append in interface Appendable

Specified by:

append in interface Output

Parameters:

csq - The character sequence to append. If csq is null, then nothing will be appended

Returns:

A reference to this Output

append

public Output append(CharSequence csq,
            int start,
            int end)

Description copied from interface: Output

Appends a subsequence of the specified character sequence to this Output.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

    out.append(csq.subSequence(start, end)) 

Specified by:

append in interface Appendable

Specified by:

append in interface Output

Parameters:

csq - The character sequence from which a subsequence will be appended. If csq is null, then nothing will be appended.

start - The index of the first character in the subsequence

end - The index of the character following the last character in the subsequence

Returns:

A reference to this Output

append

public Output append(char c)

Description copied from interface: Output

Appends the specified character to this Output.

Specified by:

append in interface Appendable

Specified by:

append in interface Output

Parameters:

c - The character to append

Returns:

A reference to this Output

append

public Output append(byte[] bytes)

Description copied from interface: Output

Appends a byte array to this Output.

Specified by:

append in interface Output

Parameters:

bytes - The byte array will be appended.

Returns:

A reference to this Output

append

public Output append(byte[] bytes,
            int start,
            int end)

Description copied from interface: Output

Appends a subsequence of the specified byte array to this Output.

An invocation of this method of the form out.append(bytes, start, end) when bytes is not null, behaves in exactly the same way as the invocation

    out.append(csq.subSequence(start, end)) 

Specified by:

append in interface Output

Parameters:

bytes - The byte array from which a subsequence will be appended. If bytes is null, then nothing will be appended.

start - The index of the first character in the subsequence

end - The index of the character following the last character in the subsequence

Returns:

A reference to this Output

append

public Output append(byte b)

Description copied from interface: Output

Appends a byte to this Output.

Specified by:

append in interface Output

Parameters:

b - A byte will be appended.

Returns:

A reference to this Output.

append

public Output append(ByteBuffer buffer)

Description copied from interface: Output

Appends the specified buffer into this Appendable.

Specified by:

append in interface Output

Parameters:

buffer - The buffer to append.

Returns:

A reference to this Output

asOutputStream

public OutputStream asOutputStream()

Description copied from interface: Output

Create an OutputStream based on this Output instance.

Calling to this method before calling to any other method including asOutputStream() itself will result in IllegalStateException.

Specified by:

asOutputStream in interface Output

Returns:

an OutputStream reference backed by this Output.

asWriter

public Writer asWriter()

Description copied from interface: Output

Create an Writer based on this Output instance.

Calling to this method before calling to any other method including asOutputStream() itself will result in IllegalStateException.

Specified by:

asWriter in interface Output

Returns:

an Writer reference backed by this Output.