com.google.template.soy.base.internal

Class IndentedLinesBuilder

java.lang.Object

com.google.template.soy.base.internal.IndentedLinesBuilder

All Implemented Interfaces:

Appendable, CharSequence

public class IndentedLinesBuilder
extends Object
implements CharSequence, Appendable

A wrapped StringBuilder used for building text with indented lines.

Important: Do not use outside of Soy code (treat as superpackage-private).

The maximum indent length is 24.

Constructor Summary

Constructors

Constructor and Description
IndentedLinesBuilder(int indentIncrementLen) Constructor with initial indent length of 0.
IndentedLinesBuilder(int indentIncrementLen, int initialIndentLen) Constructor with a specified initial indent length.

Method Summary

Modifier and Type	Method and Description
IndentedLinesBuilder	append(char c)
IndentedLinesBuilder	append(CharSequence csq)
IndentedLinesBuilder	append(CharSequence csq, int start, int end)
void	appendLine(Object... parts) Appends a line.
IndentedLinesBuilder	appendLineEnd(Object... parts) Appends the given strings, then a newline.
IndentedLinesBuilder	appendLineStart(Object... parts) Appends the current indent, then the given strings.
IndentedLinesBuilder	appendParts(Object... parts) Appends some parts to the current line.
char	charAt(int index)
void	decreaseIndent() Decreases the indent by one stop.
void	decreaseIndent(int numStops) Decreases the indent by the given number of stops.
int	getCurrIndentLen() Returns the current indent length.
int	getIndentIncrementLen() Returns the number of spaces between indent stops.
void	increaseIndent() Increases the indent by one stop.
void	increaseIndent(int numStops) Increases the indent by the given number of stops.
int	length()
StringBuilder	sb() Gets the internal StringBuilder for this instance.
CharSequence	subSequence(int start, int end)
String	toString() Returns the current content as a string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

IndentedLinesBuilder

public IndentedLinesBuilder(int indentIncrementLen)

Constructor with initial indent length of 0.

Parameters:

indentIncrementLen - The number of spaces between indent stops.

IndentedLinesBuilder

public IndentedLinesBuilder(int indentIncrementLen,
                            int initialIndentLen)

Constructor with a specified initial indent length.

Parameters:

indentIncrementLen - The number of spaces between indent stops.

initialIndentLen - The inital indent length.

Method Detail

sb

public StringBuilder sb()

Gets the internal StringBuilder for this instance. You may directly add content to it as long as you only add complete lines (i.e. the last character you add must be '\n').

getIndentIncrementLen

public int getIndentIncrementLen()

Returns the number of spaces between indent stops.

getCurrIndentLen

public int getCurrIndentLen()

Returns the current indent length.

increaseIndent

public void increaseIndent()

Increases the indent by one stop.

increaseIndent

public void increaseIndent(int numStops)

Increases the indent by the given number of stops.

decreaseIndent

public void decreaseIndent()

Decreases the indent by one stop.

decreaseIndent

public void decreaseIndent(int numStops)

Decreases the indent by the given number of stops.

appendLine

public void appendLine(Object... parts)

Appends a line. The indent at the start is automatically added whenever the line is nonempty (nonzero number of params). The newline char at the end is always added.

Parameters:

parts - The parts that make up the line.

appendParts

public IndentedLinesBuilder appendParts(Object... parts)

Appends some parts to the current line.

Parameters:

parts - The parts to append.

Returns:

This object.

appendLineStart

public IndentedLinesBuilder appendLineStart(Object... parts)

Appends the current indent, then the given strings.

Parameters:

parts - The parts to append.

Returns:

This object.

appendLineEnd

public IndentedLinesBuilder appendLineEnd(Object... parts)

Appends the given strings, then a newline.

Parameters:

parts - The parts to append.

Returns:

This object.

toString

public String toString()

Returns the current content as a string.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

append

public IndentedLinesBuilder append(CharSequence csq)

Specified by:

append in interface Appendable

append

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

Specified by:

append in interface Appendable

append

public IndentedLinesBuilder append(char c)

Specified by:

append in interface Appendable