com.bluegosling.util

Class IndentingPrintWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

com.bluegosling.util.IndentingPrintWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class IndentingPrintWriter
extends PrintWriter

A utility for printing indented content. Indentation level can be increased or decreased and all text written will be properly indented by that amount. Any time a newline is written to this printer, the subsequent line is automatically indented.

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
IndentingPrintWriter(OutputStream out, Charset charset, int indentSize) Creates a new printer that sends all output to the specified stream.
IndentingPrintWriter(OutputStream out, int indentSize) Creates a new printer that sends all output to the specified stream.
IndentingPrintWriter(Writer writer, int indentSize) Creates a new printer that sends all output to the specified writer.

Method Summary

Modifier and Type	Method and Description
int	getIndentLevel() Gets the current level of indentation.
void	indent() Increases the current level of indentation by one.
void	outdent() Decreases the current level of indentation by one.
void	println()
void	write(char[] buf, int offs, int len)
void	write(int ch)
void	write(String s, int offs, int len)

Methods inherited from class java.io.PrintWriter

append, append, append, 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, setError, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

IndentingPrintWriter

public IndentingPrintWriter(Writer writer,
                            int indentSize)

Creates a new printer that sends all output to the specified writer.

Parameters:

writer - the writer to which printed output is written

indentSize - the number of spaces in a single level of indentation

IndentingPrintWriter

public IndentingPrintWriter(OutputStream out,
                            int indentSize)

Creates a new printer that sends all output to the specified stream.

Parameters:

out - the stream to which printed output is written using UTF8 for character encoding

indentSize - the number of spaces in a single level of indentation

IndentingPrintWriter

public IndentingPrintWriter(OutputStream out,
                            Charset charset,
                            int indentSize)

Creates a new printer that sends all output to the specified stream.

Parameters:

out - the stream to which printed output is written

charset - the character set used to encode output

indentSize - the number of spaces in a single level of indentation

Method Detail

println

public void println()

Overrides:

println in class PrintWriter

write

public void write(char[] buf,
                  int offs,
                  int len)

Overrides:

write in class PrintWriter

write

public void write(int ch)

Overrides:

write in class PrintWriter

write

public void write(String s,
                  int offs,
                  int len)

Overrides:

write in class PrintWriter

getIndentLevel

public int getIndentLevel()

Gets the current level of indentation.

Returns:

the current level of indentation

indent

public void indent()

Increases the current level of indentation by one.

outdent

public void outdent()

Decreases the current level of indentation by one.