Package nl.talsmasoftware.umldoclet.rendering.indent

Class IndentingPrintWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class IndentingPrintWriter
extends PrintWriter

PrintWriter implementation that will indent each new line with a specified number of whitespace characters. The writing itself can be delegated to any other Writer implementation.

Care was taken to ensure that not only lines ended by calls to PrintWriter.println() methods trigger indentation, but any other newline characters as well.

Author:

Sjoerd Talsma

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IndentingPrintWriter(Appendable writer, Indentation indentation)

Method Summary

Modifier and Type	Method	Description
IndentingPrintWriter	append(char c)
IndentingPrintWriter	append(CharSequence csq)
IndentingPrintWriter	append(CharSequence csq, int start, int end)
protected IndentingWriter	getDelegate()
IndentingPrintWriter	indent()
IndentingPrintWriter	newline()
String	toString()
IndentingPrintWriter	unindent()
IndentingPrintWriter	whitespace()
static IndentingPrintWriter	wrap(Appendable delegate, Indentation indentation)	Returns an indenting printwriter around the given delegate.

Methods inherited from class java.io.PrintWriter

checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

IndentingPrintWriter

protected IndentingPrintWriter(Appendable writer,
 Indentation indentation)

Method Details

wrap

public static IndentingPrintWriter wrap(Appendable delegate,
 Indentation indentation)

Returns an indenting printwriter around the given delegate. If the delegate printwriter is already an indenting printwriter, it will simply be returned as-is. If the delegate printwriter is not yet an indending printwriter, a new indenting printwriter class will be created to wrap the delegate using the specified indentation.

Parameters:

delegate - The delegate to turn into an indenting printwriter.

indentation - The indentation to use for the indenting printwriter (optional, specify null to use the default indentation).

Returns:

The indenting delegate writer.

See Also:

• Indentation.DEFAULT

getDelegate

protected IndentingWriter getDelegate()

indent

public IndentingPrintWriter indent()

unindent

public IndentingPrintWriter unindent()

whitespace

public IndentingPrintWriter whitespace()

newline

public IndentingPrintWriter newline()

append

public IndentingPrintWriter append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

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

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public IndentingPrintWriter append(char c)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

toString

public String toString()

Overrides:

toString in class Object