net.markenwerk.utils.text.indentation

Class AbstractIndentation

java.lang.Object

net.markenwerk.utils.text.indentation.AbstractIndentation

All Implemented Interfaces:

Indentation

Direct Known Subclasses:

WhitespaceIndentation

public abstract class AbstractIndentation
extends Object
implements Indentation

An AbstractIndentation is an Indentation that repeats a given indentation string.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Field Summary

Fields inherited from interface net.markenwerk.utils.text.indentation.Indentation

DEFAULT, INVISIBLE

Constructor Summary

Constructors

Constructor and Description
AbstractIndentation(String indentationString, LineBreak lineBreak) Creates a new AbstractIndentation.
AbstractIndentation(String indentationString, String lineBreakString) Creates a new AbstractIndentation.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIndentation

public AbstractIndentation(String indentationString,
                           LineBreak lineBreak)

Creates a new AbstractIndentation.

Parameters:

indentationString - The indentation string to be used.

lineBreak - The line break string to be used.

Throws:

IllegalArgumentException - If the given indentation string is null or if the given LineBreak is null.

AbstractIndentation

public AbstractIndentation(String indentationString,
                           String lineBreakString)
                    throws IllegalArgumentException

Creates a new AbstractIndentation.

Parameters:

indentationString - The indentation string to be used.

lineBreakString - The line break string to be used.

Throws:

IllegalArgumentException - If the given indentation string is null or if the given line break string is null.

Method Detail

getLineBreak

public String getLineBreak()

Description copied from interface: Indentation

returns the line break string used by this Indentation.

Specified by:

getLineBreak in interface Indentation

Returns:

The line break string used by this Indentation.

isVisible

public final boolean isVisible()

Description copied from interface: Indentation

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

Specified by:

isVisible in interface Indentation

Returns:

Whether this Indentation has any visible effect.

get

public String get(int level)
           throws IllegalArgumentException

Description copied from interface: Indentation

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.

Specified by:

get in interface Indentation

Parameters:

level - The indentation level.

Returns:

The indentation string.

Throws:

IllegalArgumentException - If the given level is negative.

get

public String get(int level,
                  boolean includeLineBreak)
           throws IllegalArgumentException

Description copied from interface: Indentation

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.

Specified by:

get in interface Indentation

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

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

Description copied from interface: Indentation

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

Specified by:

appendTo in interface Indentation

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

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

Description copied from interface: Indentation

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.

Specified by:

appendTo in interface Indentation

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.