org.osgl.util

Class IO.WriteStageBase<SOURCE,STAGE extends IO.WriteStageBase>

java.lang.Object

org.osgl.util.IO.WriteStageBase<SOURCE,STAGE>

Type Parameters:

STAGE - type parameter specify the implementation class

Direct Known Subclasses:

IO.BufferedImageWriteStage, IO.CharSequenceWriteStage, IO.FileWriteStage, IO.InputStreamWriteStage, IO.ReaderWriteStage, IO.SObjectWriteStage, IO.UrlWriteStage, IO.XMLDocumentWriteStage

Enclosing class:

IO

public abstract static class IO.WriteStageBase<SOURCE,STAGE extends IO.WriteStageBase>
extends Object

A stage class support fluent IO write operations.

Examples:

IO.write(myFile).to(anotherFile);
IO.write("ABC").to(IO.file("abc.txt");

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset Used when there are reader/inputstream or writer/outputstream conversion,
protected boolean	closeSink Flag indicate if it shall close the target (output stream or writer) after written the source content into it.
protected SOURCE	source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriteStageBase(SOURCE source)

Method Summary

Modifier and Type	Method and Description
protected abstract int	doWriteTo(OutputStream sink) Sub class to implement the commit to a OutputStream logic.
protected abstract int	doWriteTo(Writer sink) Sub class to implement the commit to a Writer logic.
STAGE	encoding(Charset charset) Specify the encoding Charset when there are inputstream/reader or outputstream/writer conversion.
STAGE	ensureCloseSink() Specify that it shall close the target (output stream or writer) once the written operation finished.
protected STAGE	me()
int	to(File file) Commit this write stage into a File.
int	to(OutputStream sink) Commit this write stage to a OutputStream.
int	to(Writer sink) Commit the write stage to a Writer.

Methods inherited from class java.lang.Object

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

Field Detail

source

protected SOURCE source

closeSink

protected boolean closeSink

Flag indicate if it shall close the target (output stream or writer) after written the source content into it.

charset

protected Charset charset

Used when there are reader/inputstream or writer/outputstream conversion,

Constructor Detail

WriteStageBase

protected WriteStageBase(SOURCE source)

Method Detail

ensureCloseSink

public STAGE ensureCloseSink()

Specify that it shall close the target (output stream or writer) once the written operation finished.

Returns:

encoding

public STAGE encoding(Charset charset)

Specify the encoding Charset when there are inputstream/reader or outputstream/writer conversion.

Parameters:

charset - the charset to be used to encode byte array into string

Returns:

this write stage instance

to

public int to(Writer sink)

Commit the write stage to a Writer.

Parameters:

sink - the target writer to which this write stage is committed.

Returns:

the number of chars that has been written to the writer.

to

public int to(OutputStream sink)

Commit this write stage to a OutputStream.

Parameters:

sink - the target output stream to which this write stage is committed.

Returns:

the number of bytes that has been written to the output stream.

to

public int to(File file)

Commit this write stage into a File.

Parameters:

file - the target file to which this write stage is committed.

Returns:

the number of bytes that has been written to the file.

doWriteTo

protected abstract int doWriteTo(Writer sink)
                          throws IOException

Sub class to implement the commit to a Writer logic.

Parameters:

sink - the writer target to which this write stage committed.

Returns:

the number of chars written to the writer.

Throws:

IOException - in case IOException encountered.

doWriteTo

protected abstract int doWriteTo(OutputStream sink)
                          throws IOException

Sub class to implement the commit to a OutputStream logic.

Parameters:

sink - the output stream target to which this write stage committed.

Returns:

the number of bytes written to the output stream.

Throws:

IOException - in case IOException encountered.

me

protected final STAGE me()