Module com.aoapps.encoding

Package com.aoapps.encoding

Interface Whitespace

All Known Implementing Classes:

JavaScriptWriter, JsonWriter, LdJsonWriter, MysqlWriter, PsqlWriter, ShWriter, StyleWriter, TextWriter, WhitespaceWriter, XhtmlAttributeWriter, XhtmlWriter

@ThreadSafe
public interface Whitespace

See 3.2.5 Content models / ASCII whitespace.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INDENT_SPACES	The number of space characters per indentation level.
static final char	NL	The character used for newlines.
static final char	SPACE	The character used for space, which is ' '.

Method Summary

Modifier and Type	Method	Description
Whitespace	decDepth()	Decrements the indentation depth, if enabled.
int	getDepth()	Gets the current indentation depth, which begins at zero.
boolean	getIndent()	Gets if indentation is currently enabled, off by default.
Whitespace	incDepth()	Increments the indentation depth, if enabled.
default Whitespace	indent()	Writes the current indentation when indentation enabled.
default Whitespace	indent(int depthOffset)	Writes the current indentation with a depth offset when indentation enabled.
Whitespace	nl()	Writes a newline.
default Whitespace	nli()	Writes a newline, followed by current indentation when indentation enabled.
default Whitespace	nli(int depthOffset)	Writes a newline, followed by current indentation with a depth offset when indentation enabled.
Whitespace	setDepth(int depth)	Sets the indentation depth.
Whitespace	setIndent(boolean indent)	Enables or disabled indentation.
default Whitespace	sp()	Writes one space character.
Whitespace	sp(int count)	Writes the given number of space characters.

Field Details

NL

static final char NL

The character used for newlines.

This is '\n' on all platforms. If a different newline is required, such as "\r\n" for email, filter the output.

See Also:

• Constant Field Values

INDENT_SPACES

static final int INDENT_SPACES

The number of space characters per indentation level.

See Also:

• Constant Field Values

SPACE

static final char SPACE

The character used for space, which is ' '.

See Also:

• Constant Field Values

Method Details

nl

Whitespace nl()
       throws IOException

Writes a newline.

This is '\n' on all platforms. If a different newline is required, such as "\r\n" for email, filter the output.

Returns:

this writer

Throws:

IOException

See Also:

• NL
• nli()
• nli(int)

nli

default Whitespace nli()
                throws IOException

Writes a newline, followed by current indentation when indentation enabled.

This is '\n' on all platforms. If a different newline is required, such as "\r\n" for email, filter the output.

Returns:

this writer

Throws:

IOException

See Also:

• nli(int)
• nl()
• indent()
• getIndent()
• setIndent(boolean)

nli

default Whitespace nli(int depthOffset)
                throws IOException

Writes a newline, followed by current indentation with a depth offset when indentation enabled.

This is '\n' on all platforms. If a different newline is required, such as "\r\n" for email, filter the output.

Parameters:

depthOffset - A value added to the current indentation depth. For example, pass -1 when performing a newline before a closing tag or ending curly brace.

Returns:

this writer

Throws:

IOException

See Also:

• nli()
• nl()
• indent(int)
• getIndent()
• setIndent(boolean)

indent

default Whitespace indent()
                   throws IOException

Writes the current indentation when indentation enabled.

Returns:

this writer

Throws:

IOException

See Also:

• indent(int)
• INDENT_SPACES
• nli()
• getIndent()
• setIndent(boolean)

indent

default Whitespace indent(int depthOffset)
                   throws IOException

Writes the current indentation with a depth offset when indentation enabled.

Parameters:

depthOffset - A value added to the current indentation depth. For example, pass -1 when performing a newline before a closing tag or ending curly brace.

Returns:

this writer

Throws:

IOException

See Also:

• indent()
• INDENT_SPACES
• nli(int)
• getIndent()
• setIndent(boolean)

getIndent

boolean getIndent()

Gets if indentation is currently enabled, off by default.

setIndent

Whitespace setIndent(boolean indent)

Enables or disabled indentation.

Returns:

this writer

getDepth

int getDepth()

Gets the current indentation depth, which begins at zero. This value is not updated when indentation is disabled. Not all tags will trigger indentation.

setDepth

Whitespace setDepth(int depth)

Sets the indentation depth.

Returns:

this writer

incDepth

Whitespace incDepth()

Increments the indentation depth, if enabled.

Returns:

this writer

decDepth

Whitespace decDepth()

Decrements the indentation depth, if enabled.

Returns:

this writer

sp

default Whitespace sp()
               throws IOException

Writes one space character.

Returns:

this writer

Throws:

IOException

See Also:

• sp(int)
• SPACE

sp

Whitespace sp(int count)
       throws IOException

Writes the given number of space characters.

Parameters:

count - When count <= 0, nothing is written.

Returns:

this writer

Throws:

IOException

See Also:

• sp()
• SPACE