com.goldencode.p2j.io

Class IndentHandler

java.lang.Object

com.goldencode.p2j.io.IndentHandler

All Implemented Interfaces:

Indentable

public class IndentHandler
extends java.lang.Object
implements Indentable

Provides management of indention state.

The 0 indent level is equivalent to no indents. For each positive indent level, the number of space characters written will be equivalent to the indent level times the width of a single indent level (which defaults to 3 spaces).

So at the 0 indent level, no spaces are written. At the 1 indent level, 3 spaces (by default) are written. At the 2 indent level, 6 spaces (by default) are written and so on. By changing the width and indent level, the exact indent results can be completely controlled.

This class is not thread-safe.

Author:

GES

Field Summary

Fields

Modifier and Type	Field and Description
private int	indent Current indent level (defaults to 0).
private java.lang.StringBuilder	pad Current pad inserted between newlines and subsequent bytes.
private int	width Width of each indent level (defaults to 3 space characters).

Constructor Summary

Constructors

Constructor and Description
IndentHandler()

Method Summary

Modifier and Type	Method and Description
void	decrement() Decrements the indent level by 1.
int	getIndent() Accesses the current indent level.
java.lang.String	getPad() Get the current pad.
int	getWidth() Accesses the number of spaces in a single indent level.
void	increment() Increments the indent level by 1.
private void	pad(int sz) Create a pad string containing sz space characters.
void	setIndent(int indent) Sets the current indent level.
void	setPad(int indent, int width) Sets both the indent level and the number of spaces in a single indent level.
void	setWidth(int width) Sets the number of spaces in a single indent level.

Methods inherited from class java.lang.Object

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

Field Detail

indent

private int indent

Current indent level (defaults to 0).

width

private int width

Width of each indent level (defaults to 3 space characters).

pad

private java.lang.StringBuilder pad

Current pad inserted between newlines and subsequent bytes.

Constructor Detail

IndentHandler

public IndentHandler()

Method Detail

getIndent

public int getIndent()

Accesses the current indent level.

Specified by:

getIndent in interface Indentable

Returns:

Indent level.

setIndent

public void setIndent(int indent)

Sets the current indent level.

Specified by:

setIndent in interface Indentable

Parameters:

indent - New indent level.

increment

public void increment()

Increments the indent level by 1.

Specified by:

increment in interface Indentable

decrement

public void decrement()

Decrements the indent level by 1.

Specified by:

decrement in interface Indentable

getWidth

public int getWidth()

Accesses the number of spaces in a single indent level.

Specified by:

getWidth in interface Indentable

Returns:

Width of each indent level.

setWidth

public void setWidth(int width)

Sets the number of spaces in a single indent level.

Specified by:

setWidth in interface Indentable

Parameters:

width - New indent width.

setPad

public void setPad(int indent,
                   int width)

Sets both the indent level and the number of spaces in a single indent level. This is a convenience function to avoid 2 separate calls and the small amount of shared overhead that would have been incurred in those calls.

Specified by:

setPad in interface Indentable

Parameters:

indent - New indent level.

width - New indent width.

getPad

public java.lang.String getPad()

Get the current pad.

Specified by:

getPad in interface Indentable

Returns:

The pad string for the next line of output.

pad

private void pad(int sz)

Create a pad string containing sz space characters.

Parameters:

sz - The number of spaces to put into the pad string.