org.pfsw.bif.text

Interface IIndentedTextWriter<T extends IIndentedTextWriter>

All Superinterfaces:

IExtensibleFluentApi<T>

All Known Implementing Classes:

FormattedTextWriter

public interface IIndentedTextWriter<T extends IIndentedTextWriter>
extends IExtensibleFluentApi<T>

A generic interface for writing text with indentation support.

Method Summary

Modifier and Type	Method and Description
int	getIndentSize() Returns the number of spaces for one level of indentation.
T	indent() Increments the indentation level.
T	outdent() Decrements the indentation level.
T	setIndentSize(int indentSize) Sets the number of spaces for one level of indentation.
T	writeAll(java.lang.Object... arguments) Writes all given arguments to the output target.
T	writelnAll(java.lang.Object... arguments) Writes all given arguments to the output target and finally appends a new line.
T	writelnText(java.lang.String text) Writes the given text.
T	writeText(java.lang.String text) Writes the given text.

Methods inherited from interface org.pfsw.bif.IExtensibleFluentApi

self

Method Detail

getIndentSize

int getIndentSize()

Returns the number of spaces for one level of indentation.

setIndentSize

T setIndentSize(int indentSize)

Sets the number of spaces for one level of indentation. If not set explicitly here, the default 2 is used.

indent

T indent()

Increments the indentation level. That means, that all succeeding write output will be indented one level more at the beginning of each line.

outdent

T outdent()

Decrements the indentation level. That means, that all succeeding write output will be indented one level less at the beginning of each line.

writeAll

T writeAll(java.lang.Object... arguments)

Writes all given arguments to the output target. If at the beginning of a new line the indentation will be written first.

writelnAll

T writelnAll(java.lang.Object... arguments)

Writes all given arguments to the output target and finally appends a new line. If at the beginning of a new line the indentation will be written first.

writeText

T writeText(java.lang.String text)

Writes the given text. It will be written line by line respecting the current indentation. That is, indentation spaces will be inserted on the beginning of each line.

writelnText

T writelnText(java.lang.String text)

Writes the given text. It will be written line by line respecting the current indentation. That is, indentation spaces will be inserted on the beginning of each line. After the last line a new line will be written.