net.markenwerk.utils.text.indentation

Interface Indentation

All Known Implementing Classes:

AbstractIndentation, InvisibleIndentation, WhitespaceIndentation

public interface Indentation

An Indentation represents all strings necessary to perform consistent indentation of structured strings.

An Indentation may choose to have no visible effect, in which case calling any other method of the Indentation has no effect.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields

Modifier and Type	Field and Description
static Indentation	DEFAULT A WhitespaceIndentation, using single tab character, to default to, if no specific Indentation is given.

Method Summary

Modifier and Type	Method and Description
void	appendTo(Appendable appendable, int level) Appends the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level, to the given Appendable
void	appendTo(Appendable appendable, int level, boolean includeLineBreak) Appends the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level or the string that needs to be appended at the end of a line, with the result that the next line is indented by the given level, including the necessary line break characters, to the given Appendable.
String	get(int level) Returns the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level.
String	get(int level, boolean includeLineBreak) Returns the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level or the string that needs to be appended at the end of a line, with the result that the next line is indented by the given level, including the necessary line break characters.
String	getLineBreak() returns the line break string used by this Indentation.
boolean	isVisible() Returns whether this Indentation has any visible effect or if every indentation string is the empty string.

Field Detail

DEFAULT

static final Indentation DEFAULT

A WhitespaceIndentation, using single tab character, to default to, if no specific Indentation is given.

Method Detail

isVisible

boolean isVisible()

Returns whether this Indentation has any visible effect or if every indentation string is the empty string.

Returns:

Whether this Indentation has any visible effect.

getLineBreak

String getLineBreak()

returns the line break string used by this Indentation.

Returns:

The line break string used by this Indentation.

get

String get(int level)
    throws IllegalArgumentException

Returns the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level.

The result is never null, even if this Indentation is not visible.

Parameters:

level - The indentation level.

Returns:

The indentation string.

Throws:

IllegalArgumentException - If the given level is negative.

get

String get(int level,
           boolean includeLineBreak)
    throws IllegalArgumentException

Returns the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level or the string that needs to be appended at the end of a line, with the result that the next line is indented by the given level, including the necessary line break characters.

The line break characters are omitted, if this Indentation is not visible.

The result is never null, even if this Indentation is not visible.

Parameters:

level - The indentation level.

includeLineBreak - Whether to include the line break characters.

Returns:

The indentation string.

Throws:

IllegalArgumentException - If the given level is negative.

appendTo

void appendTo(Appendable appendable,
              int level)
       throws IllegalArgumentException,
              IOException

Appends the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level, to the given Appendable

Parameters:

appendable - The Appendable to be used.

level - The indentation level.

Throws:

IllegalArgumentException - If the given Appendable is null or if the given level is negative.

IOException - If appending to the given Appendable failed.

appendTo

void appendTo(Appendable appendable,
              int level,
              boolean includeLineBreak)
       throws IllegalArgumentException,
              IOException

Appends the string that needs to be appended at the beginning of a line, with the result that the the line is indented by the given level or the string that needs to be appended at the end of a line, with the result that the next line is indented by the given level, including the necessary line break characters, to the given Appendable.

The line break characters are omitted, if this Indentation is not visible.

Parameters:

appendable - The Appendable to be used.

level - The indentation level.

includeLineBreak - Whether to include the line break characters.

Throws:

IllegalArgumentException - If the given Appendable is null or if the given level is negative.

IOException - If appending to the given Appendable failed.