IndentableStringBuilder (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.commons.tools.IndentableStringBuilder

All Implemented Interfaces:

Appendable
```
public class IndentableStringBuilder
extends Object
```
支持分级缩进的string builder。

Author:

renhui

Field Summary

Fields
Modifier and Type Field and Description

protected static char CR

protected static char LF

Fields
Modifier and Type	Field and Description
`protected static char`	`CR`
`protected static char`	`LF`

Constructor Summary

Constructors
Constructor and Description

IndentableStringBuilder()

IndentableStringBuilder(int indent)

Constructors
Constructor and Description
`IndentableStringBuilder()`
`IndentableStringBuilder(int indent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`append(char c)` `Appendable`接口方法。
`B`	`append(CharSequence csq)` `Appendable`接口方法。
`B`	`append(CharSequence csq, int start, int end)` `Appendable`接口方法。
`protected void`	`appendInternal(char c)` 子类通过此方法向内部buffer中添加内容。
`protected void`	`appendInternal(String s)` 子类通过此方法向内部buffer中添加内容。
`protected void`	`appendInternalNewLine()` 子类通过此方法向内部buffer中添加换行。
`void`	`clear()` 清除所有内容。
`int`	`currentIndent()` 取得当前缩进的数量。
`IndentableStringBuilder`	`end()` 结束一级缩进。注意，输出结果之前，须至少调用一次end()，以确保最后的换行可以被输出。
`boolean`	`endsWith(String testStr)` 判断buf是否以指定字符串结尾。
`boolean`	`endsWithNewLine()` 判断out是否以换行结尾，或者是空buffer。
`void`	`flush()` 确保最后一个换行被输出。
`int`	`length()` 取得buffer中内容的长度。
`int`	`lineLength()` 取得当前行的长度。
`IndentableStringBuilder`	`start()` 创建一级缩进。
`IndentableStringBuilder`	`start(int indent)` 创建一级缩进。
`IndentableStringBuilder`	`start(String beginQuote, String endQuote)` 创建一级缩进，使用指定的前后括弧。
`IndentableStringBuilder`	`start(String beginQuote, String endQuote, int indent)` 创建一级缩进，使用指定的前后括弧。
`IndentableStringBuilder`	`startHangingIndent()` 从下一个换行或start()开始悬挂缩进。
`IndentableStringBuilder`	`startHangingIndent(int indentOffset)` 从下一个换行或start()开始悬挂缩进。
`String`	`toString()`
`protected void`	`visit(char c)` 此处收到的字符中，所有 CR/LF/CRLF 均已被规格化成统一的LF了。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CR
```
protected static final char CR
```
    See Also:
    
    Constant Field Values
  - LF
```
protected static final char LF
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IndentableStringBuilder
```
public IndentableStringBuilder()
```
  - IndentableStringBuilder
```
public IndentableStringBuilder(int indent)
```
- Method Detail
  - clear
```
public void clear()
```
    清除所有内容。
  - visit
```
protected void visit(char c)
```
    此处收到的字符中，所有 CR/LF/CRLF 均已被规格化成统一的LF了。
  - start
```
public IndentableStringBuilder start()
```
    创建一级缩进。
  - start
```
public IndentableStringBuilder start(int indent)
```
    创建一级缩进。
  - start
```
public IndentableStringBuilder start(String beginQuote,
                                     String endQuote)
```
    创建一级缩进，使用指定的前后括弧。
  - start
```
public IndentableStringBuilder start(String beginQuote,
                                     String endQuote,
                                     int indent)
```
    创建一级缩进，使用指定的前后括弧。
  - startHangingIndent
```
public IndentableStringBuilder startHangingIndent()
```
    从下一个换行或start()开始悬挂缩进。
  - startHangingIndent
```
public IndentableStringBuilder startHangingIndent(int indentOffset)
```
    从下一个换行或start()开始悬挂缩进。
  - end
```
public IndentableStringBuilder end()
```
    结束一级缩进。注意，输出结果之前，须至少调用一次end()，以确保最后的换行可以被输出。
  - currentIndent
```
public int currentIndent()
```
    取得当前缩进的数量。
  - length
```
public final int length()
```
    取得buffer中内容的长度。
  - lineLength
```
public final int lineLength()
```
    取得当前行的长度。
  - append
```
public final B append(CharSequence csq)
```
    Appendable接口方法。
    
    Specified by:
    
    append in interface Appendable
  - append
```
public final B append(CharSequence csq,
                      int start,
                      int end)
```
    Appendable接口方法。
    
    Specified by:
    
    append in interface Appendable
  - append
```
public final B append(char c)
```
    Appendable接口方法。
    
    Specified by:
    
    append in interface Appendable
  - appendInternal
```
protected final void appendInternal(String s)
```
    子类通过此方法向内部buffer中添加内容。
  - appendInternal
```
protected final void appendInternal(char c)
```
    子类通过此方法向内部buffer中添加内容。
  - appendInternalNewLine
```
protected final void appendInternalNewLine()
```
    子类通过此方法向内部buffer中添加换行。
    子类必须通过此方法来换行，否则newLineStartIndex会不正确。
  - endsWith
```
public final boolean endsWith(String testStr)
```
    判断buf是否以指定字符串结尾。
  - endsWithNewLine
```
public final boolean endsWithNewLine()
```
    判断out是否以换行结尾，或者是空buffer。
  - flush
```
public final void flush()
```
    确保最后一个换行被输出。
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class IndentableStringBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CR

LF

Constructor Detail

IndentableStringBuilder

IndentableStringBuilder

Method Detail

clear

visit

start

start

start

start

startHangingIndent

startHangingIndent

end

currentIndent

length

lineLength

append

append

append

appendInternal

appendInternal

appendInternalNewLine

endsWith

endsWithNewLine

flush

toString