Module com.aoapps.encoding

Package com.aoapps.encoding

Class WhitespaceWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.lang.io.EncoderWriter

com.aoapps.encoding.MediaWriter

com.aoapps.encoding.WhitespaceWriter

All Implemented Interfaces:

Encode, ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Whitespace, NoClose, Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

JavaScriptWriter, MysqlWriter, PsqlWriter, ShWriter, StyleWriter, TextWriter, XhtmlAttributeWriter, XhtmlWriter

@ThreadSafe
public abstract class WhitespaceWriter
extends MediaWriter
implements Whitespace

Streaming versions of media encoders that can write whitespace.

Author:

AO Industries, Inc.

See Also:

• MediaEncoder

Field Summary

Fields inherited from class com.aoapps.encoding.MediaWriter

DEFAULT_CLOSER, DEFAULT_IS_NO_CLOSE

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Fields inherited from interface com.aoapps.encoding.Whitespace

INDENT_SPACES, NL, SPACE

Method Summary

Modifier and Type	Method	Description
WhitespaceWriter	append(char c)
WhitespaceWriter	append(CharSequence csq)
WhitespaceWriter	append(CharSequence csq, int start, int end)
WhitespaceWriter	decDepth()	Decrements the indentation depth, if enabled.
WhitespaceWriter	encode(MediaType contentType, char ch)	Encodes the given nested type with proper encoding.
WhitespaceWriter	encode(MediaType contentType, char[] cbuf)	Encodes the given nested type with proper encoding.
WhitespaceWriter	encode(MediaType contentType, char[] cbuf, int offset, int len)	Encodes the given nested type with proper encoding.
<Ex extends Throwable> WhitespaceWriter	encode(MediaType contentType, MediaWritable<Ex> content)	Encodes the given nested type with proper encoding.
<Ex extends Throwable> WhitespaceWriter	encode(MediaType contentType, IOSupplierE<?,Ex> content)	Encodes the given nested type with proper encoding.
WhitespaceWriter	encode(MediaType contentType, CharSequence csq)	Encodes the given nested type with proper encoding.
WhitespaceWriter	encode(MediaType contentType, CharSequence csq, int start, int end)	Encodes the given nested type with proper encoding.
WhitespaceWriter	encode(MediaType contentType, Object content)	Encodes the given nested type with proper encoding.
int	getDepth()	Gets the current indentation depth, which begins at zero.
boolean	getIndent()	Gets if indentation is currently enabled, off by default.
WhitespaceWriter	incDepth()	Increments the indentation depth, if enabled.
WhitespaceWriter	indent()	Writes the current indentation when indentation enabled.
WhitespaceWriter	indent(int depthOffset)	Writes the current indentation with a depth offset when indentation enabled.
WhitespaceWriter	nl()	Writes a newline.
WhitespaceWriter	nli()	Writes a newline, followed by current indentation when indentation enabled.
WhitespaceWriter	nli(int depthOffset)	Writes a newline, followed by current indentation with a depth offset when indentation enabled.
WhitespaceWriter	setDepth(int depth)	Sets the indentation depth.
WhitespaceWriter	setIndent(boolean indent)	Enables or disabled indentation.
WhitespaceWriter	sp()	Writes one space character.
WhitespaceWriter	sp(int count)	Writes the given number of space characters.

Methods inherited from class com.aoapps.encoding.MediaWriter

canSkipValidation, close, encode, getEncoder, getEncodingContext, getValidMediaInputType, getValidMediaOutputType, isNoClose, isValidatingMediaInputType

Methods inherited from class com.aoapps.lang.io.EncoderWriter

getOut, write, write, write, write, write, writePrefix, writeSuffix, writeSuffix

Methods inherited from class java.io.FilterWriter

flush

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Method Details

append

public WhitespaceWriter append(char c)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

append

public WhitespaceWriter append(CharSequence csq)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

append

public WhitespaceWriter append(CharSequence csq,
 int start,
 int end)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 char ch)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 char[] cbuf)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 char[] cbuf,
 int offset,
 int len)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 CharSequence csq)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 CharSequence csq,
 int start,
 int end)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public WhitespaceWriter encode(MediaType contentType,
 Object content)
                        throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

public <Ex extends Throwable> WhitespaceWriter encode(MediaType contentType,
 IOSupplierE<?,Ex> content)
                                               throws IOException,
Ex

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

public <Ex extends Throwable> WhitespaceWriter encode(MediaType contentType,
 MediaWritable<Ex> content)
                                               throws IOException,
Ex

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

Adds prefixes and suffixes by media type, such as "…".

Does not perform any translation markups.

Specified by:

encode in interface Encode

Overrides:

encode in class MediaWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

nl

public WhitespaceWriter nl()
                    throws IOException

Description copied from interface: Whitespace

Writes a newline.

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

Specified by:

nl in interface Whitespace

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.NL
• Whitespace.nli()
• Whitespace.nli(int)

nli

public WhitespaceWriter nli()
                     throws IOException

Description copied from interface: Whitespace

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.

Specified by:

nli in interface Whitespace

Returns:

this writer

Throws:

IOException

See Also:

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

nli

public WhitespaceWriter nli(int depthOffset)
                     throws IOException

Description copied from interface: Whitespace

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.

Specified by:

nli in interface Whitespace

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:

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

indent

public WhitespaceWriter indent()
                        throws IOException

Description copied from interface: Whitespace

Writes the current indentation when indentation enabled.

Specified by:

indent in interface Whitespace

Returns:

this writer

Throws:

IOException

See Also:

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

indent

public WhitespaceWriter indent(int depthOffset)
                        throws IOException

Description copied from interface: Whitespace

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

Specified by:

indent in interface Whitespace

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:

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

getIndent

public boolean getIndent()

Description copied from interface: Whitespace

Gets if indentation is currently enabled, off by default.

Specified by:

getIndent in interface Whitespace

setIndent

public WhitespaceWriter setIndent(boolean indent)

Description copied from interface: Whitespace

Enables or disabled indentation.

Specified by:

setIndent in interface Whitespace

Returns:

this writer

getDepth

public int getDepth()

Description copied from interface: Whitespace

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

Specified by:

getDepth in interface Whitespace

setDepth

public WhitespaceWriter setDepth(int depth)

Description copied from interface: Whitespace

Sets the indentation depth.

Specified by:

setDepth in interface Whitespace

Returns:

this writer

incDepth

public WhitespaceWriter incDepth()

Description copied from interface: Whitespace

Increments the indentation depth, if enabled.

Specified by:

incDepth in interface Whitespace

Returns:

this writer

decDepth

public WhitespaceWriter decDepth()

Description copied from interface: Whitespace

Decrements the indentation depth, if enabled.

Specified by:

decDepth in interface Whitespace

Returns:

this writer

sp

public WhitespaceWriter sp()
                    throws IOException

Description copied from interface: Whitespace

Writes one space character.

Specified by:

sp in interface Whitespace

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp(int)
• Whitespace.SPACE

sp

public WhitespaceWriter sp(int count)
                    throws IOException

Description copied from interface: Whitespace

Writes the given number of space characters.

Specified by:

sp in interface Whitespace

Parameters:

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

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp()
• Whitespace.SPACE