Package com.mapr.utils

Class PrettyStringBuilder

java.lang.Object

com.mapr.utils.IndentingStringBuilder

com.mapr.utils.PrettyStringBuilder

public class PrettyStringBuilder
extends IndentingStringBuilder

Implementation of IndentingStringBuilder that honors indentation and space requests for debugging purposes.

Field Summary

Fields inherited from class com.mapr.utils.IndentingStringBuilder

sb

Constructor Summary

Constructors

Constructor	Description
PrettyStringBuilder(java.lang.StringBuilder sb, int indentSpaces)	Constructor.

Method Summary

Modifier and Type	Method	Description
IndentingStringBuilder	addComment(java.lang.String comment)	Add a c-style comment.
IndentingStringBuilder	nextLine()	Emit a newline, along with any necessary indentation.
IndentingStringBuilder	popIndent()	Remove a level of indentation.
IndentingStringBuilder	pushIndent()	Add a new level of indentation.

Methods inherited from class com.mapr.utils.IndentingStringBuilder

append, append, append, length, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyStringBuilder

public PrettyStringBuilder(java.lang.StringBuilder sb,
                           int indentSpaces)

Constructor.

Parameters:

sb - the StringBuilder to write to

indentSpaces - how many spaces to use for indentation

Method Detail

nextLine

public IndentingStringBuilder nextLine()

Description copied from class: IndentingStringBuilder

Emit a newline, along with any necessary indentation.

Specified by:

nextLine in class IndentingStringBuilder

Returns:

this

pushIndent

public IndentingStringBuilder pushIndent()

Description copied from class: IndentingStringBuilder

Add a new level of indentation. This has no effect until the next call to IndentingStringBuilder.nextLine().

Specified by:

pushIndent in class IndentingStringBuilder

Returns:

this

popIndent

public IndentingStringBuilder popIndent()

Description copied from class: IndentingStringBuilder

Remove a level of indentation. This has no effect until the next call to IndentingStringBuilder.nextLine(). It is an error to unindent when there are no levels of indentation active; this is indicated with a call to IndentingStringBuilder.addComment(String) with a warning that the caller has unindented too much.

Specified by:

popIndent in class IndentingStringBuilder

Returns:

this

addComment

public IndentingStringBuilder addComment(java.lang.String comment)

Description copied from class: IndentingStringBuilder

Add a c-style comment. The provided text is emitted surrounded by "/o " and " o/" (where the o's are asterisks). The comment will only appear in "pretty text." For plain text, this emits a single blank.

Specified by:

addComment in class IndentingStringBuilder

Parameters:

comment - the comment

Returns: