com.mapr.utils

Class PrependingStringBuilder

java.lang.Object

com.mapr.utils.IndentingStringBuilder

com.mapr.utils.PrependingStringBuilder

Direct Known Subclasses:

ParentheticalStringBuilder

public class PrependingStringBuilder
extends IndentingStringBuilder

An IndentingStringBuilder with a trigger: If any non-whitespace output is added, the trigger will go off and prepend a provided string exactly once. Once the trigger has gone off, the prepend string won't be written again. One use for this is to virtually prepend a connecting string when it is unknown yet whether or not that string will be needed. For example: final IndentingStringBuilder isb = ...; // emit a conditional expression to isb...; final PrependingStringBuilder psb = new PrependingStringBuilder(isb, " and "); possiblyAppendMoreConditions(psb); In this example, we need to call a function that might append more conditions, after we have already added some. But we don't know in advance whether the call will add anything or not, and this function already does other work such that it doesn't want to have a "prepend an 'and'" option. If possiblyAppendMoreConditions() doesn't write anything, then the extra " and " isn't written.

Field Summary

Fields inherited from class com.mapr.utils.IndentingStringBuilder

sb

Constructor Summary

Constructors

Constructor and Description
PrependingStringBuilder(IndentingStringBuilder isb, java.lang.String prependString) Constructor.

Method Summary

Modifier and Type	Method and Description
IndentingStringBuilder	addComment(java.lang.String comment) Add a c-style comment.
IndentingStringBuilder	append(char v) Append a char.
IndentingStringBuilder	append(long v) Append a long value, as text.
IndentingStringBuilder	append(java.lang.String v) Append a String.
int	length() Return the length of the String written so far.
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.
java.lang.String	toString()
boolean	triggered() Determine whether or not the prepender has fired.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrependingStringBuilder

public PrependingStringBuilder(IndentingStringBuilder isb,
                               java.lang.String prependString)

Constructor.

Parameters:

isb - the IndentingStringBuilder to write to

prependString - the string to prepend

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class IndentingStringBuilder

length

public int length()

Description copied from class: IndentingStringBuilder

Return the length of the String written so far.

Overrides:

length in class IndentingStringBuilder

Returns:

the length of the String written so far

triggered

public boolean triggered()

Determine whether or not the prepender has fired.

Returns:

append

public IndentingStringBuilder append(java.lang.String v)

Description copied from class: IndentingStringBuilder

Append a String.

Overrides:

append in class IndentingStringBuilder

Parameters:

v - the string to append

Returns:

the IndentingStringBuilder

append

public IndentingStringBuilder append(char v)

Description copied from class: IndentingStringBuilder

Append a char.

Overrides:

append in class IndentingStringBuilder

Parameters:

v - the char to append

Returns:

the IndentingStringBuilder

append

public IndentingStringBuilder append(long v)

Description copied from class: IndentingStringBuilder

Append a long value, as text.

Overrides:

append in class IndentingStringBuilder

Parameters:

v - the long to append

Returns:

the IndentingStringBuilder

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: