com.github.mangstadt.vinnie.io

Class FoldedLineWriter

java.lang.Object

java.io.Writer

com.github.mangstadt.vinnie.io.FoldedLineWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class FoldedLineWriter
extends Writer

Automatically folds lines as they are written.

Author:

Michael Angstadt

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
FoldedLineWriter(Writer writer) Creates a folded line writer.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
void	flush() Flushes the writer.
String	getIndent() Gets the string that is prepended to each folded line (defaults to a single space character).
Integer	getLineLength() Gets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).
Writer	getWriter() Gets the wrapped Writer object.
void	setIndent(String indent) Sets the string that is prepended to each folded line (defaults to a single space character).
void	setLineLength(Integer lineLength) Sets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(char[] cbuf, int off, int len, boolean quotedPrintable, Charset charset) Writes a portion of an array of characters.
void	write(CharSequence str, boolean quotedPrintable, Charset charset) Writes a string.
void	writeln() Writes a newline.

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldedLineWriter

public FoldedLineWriter(Writer writer)

Creates a folded line writer.

Parameters:

writer - the writer object to wrap

Method Detail

writeln

public void writeln()
             throws IOException

Writes a newline.

Throws:

IOException - if there's a problem writing to the output stream

write

public void write(CharSequence str,
                  boolean quotedPrintable,
                  Charset charset)
           throws IOException

Writes a string.

Parameters:

str - the string to write

quotedPrintable - true to encode the string in quoted-printable encoding, false not to

charset - the character set to use when encoding the string into quoted-printable

Throws:

IOException - if there's a problem writing to the output stream

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

Writes a portion of an array of characters.

Specified by:

write in class Writer

Parameters:

cbuf - the array of characters

off - the offset from which to start writing characters

len - the number of characters to write

Throws:

IOException - if there's a problem writing to the output stream

write

public void write(char[] cbuf,
                  int off,
                  int len,
                  boolean quotedPrintable,
                  Charset charset)
           throws IOException

Writes a portion of an array of characters.

Parameters:

cbuf - the array of characters

off - the offset from which to start writing characters

len - the number of characters to write

quotedPrintable - true to encode the string in quoted-printable encoding, false not to

charset - the character set to use when encoding the string into quoted-printable

Throws:

IOException - if there's a problem writing to the output stream

getLineLength

public Integer getLineLength()

Gets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).

Returns:

the line length or null if folding is disabled

setLineLength

public void setLineLength(Integer lineLength)

Sets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).

Parameters:

lineLength - the line length or null to disable folding

Throws:

IllegalArgumentException - if the line length is less than or equal to zero, or the line length is less than the length of the indent string

getIndent

public String getIndent()

Gets the string that is prepended to each folded line (defaults to a single space character).

Returns:

the indent string

setIndent

public void setIndent(String indent)

Sets the string that is prepended to each folded line (defaults to a single space character).

Parameters:

indent - the indent string (cannot be empty, may only contain tabs and spaces). Note that data streams using SyntaxStyle.NEW syntax MUST use an indent string that contains EXACTLY ONE character.

Throws:

IllegalArgumentException - if the indent string is empty, or the length of the indent string is greater than the max line length, or the indent string contains illegal characters

getWriter

public Writer getWriter()

Gets the wrapped Writer object.

Returns:

the writer object

close

public void close()
           throws IOException

Closes the writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the writer.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException