Module org.refcodes.io

Package org.refcodes.io

Class LineBreakOutputStream

java.lang.Object

java.io.OutputStream

org.refcodes.io.LineBreakOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LineBreakOutputStream
extends OutputStream

A LineBreakOutputStream wraps an OutputStream for adding line breaks after a given number of bytes being written.

Constructor Summary

Constructors

Constructor	Description
LineBreakOutputStream(OutputStream aOutputStream, int aLineWidth)	Constructs a LineBreakOutputStream with the given arguments used for configuration.
LineBreakOutputStream(OutputStream aOutputStream, int aLineWidth, boolean isFlushLineBreak)	Constructs a LineBreakOutputStream with the given arguments used for configuration.
LineBreakOutputStream(OutputStream aOutputStream, int aLineWidth, String aLineBreak)	Constructs a LineBreakOutputStream with the given arguments used for configuration.
LineBreakOutputStream(OutputStream aOutputStream, int aLineWidth, String aLineBreak, boolean isFlushLineBreak)	Constructs a LineBreakOutputStream with the given arguments used for configuration.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	write(int aByte)

Methods inherited from class java.io.OutputStream

nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

LineBreakOutputStream

public LineBreakOutputStream(OutputStream aOutputStream,
 int aLineWidth,
 String aLineBreak)

Constructs a LineBreakOutputStream with the given arguments used for configuration.

Parameters:

aOutputStream - The OutputStream to be wrapped.

aLineWidth - The line width after which to insert a line break, a line width of -1 does not insert any line breaks at all.

aLineBreak - The line break chars to use.

LineBreakOutputStream

public LineBreakOutputStream(OutputStream aOutputStream,
 int aLineWidth)

Constructs a LineBreakOutputStream with the given arguments used for configuration. The line break characters used are the ones used by the underlying operating system.

Parameters:

aOutputStream - The OutputStream to be wrapped.

aLineWidth - The line width after which to insert a line break, a line width of -1 does not insert any line breaks at all.

LineBreakOutputStream

public LineBreakOutputStream(OutputStream aOutputStream,
 int aLineWidth,
 String aLineBreak,
 boolean isFlushLineBreak)

Constructs a LineBreakOutputStream with the given arguments used for configuration.

Parameters:

aOutputStream - The OutputStream to be wrapped.

aLineWidth - The line width after which to insert a line break, a line width of -1 does not insert any line breaks at all.

aLineBreak - The line break chars to use.

isFlushLineBreak - When true, then a line break is also inserted upon a flush() operation.

LineBreakOutputStream

public LineBreakOutputStream(OutputStream aOutputStream,
 int aLineWidth,
 boolean isFlushLineBreak)

Constructs a LineBreakOutputStream with the given arguments used for configuration. The line break characters used are the ones used by the underlying operating system.

Parameters:

aOutputStream - The OutputStream to be wrapped.

aLineWidth - The line width after which to insert a line break, a line width of -1 does not insert any line breaks at all.

isFlushLineBreak - When true, then a line break is also inserted upon a flush() operation.

Method Details

write

public void write(int aByte)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException