Module com.aoapps.encoding

Package com.aoapps.encoding

Class TextWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.lang.io.EncoderWriter

com.aoapps.encoding.MediaWriter

com.aoapps.encoding.WhitespaceWriter

com.aoapps.encoding.TextWriter

All Implemented Interfaces:

Encode, JavaScript, Json, LdJson, Mysql, Psql, Sh, Style, Text, Url, ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Whitespace, Xhtml, XhtmlAttribute, NoClose, Closeable, Flushable, Appendable, AutoCloseable

@ThreadSafe
public final class TextWriter
extends WhitespaceWriter
implements Xhtml, XhtmlAttribute, Style, JavaScript, Json, LdJson, Text, Url, Sh, Mysql, Psql

Streaming versions of media encoders.

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.Text

NBSP

Fields inherited from interface com.aoapps.encoding.Whitespace

INDENT_SPACES, NL, SPACE

Constructor Summary

Constructors

Constructor	Description
TextWriter(EncodingContext encodingContext, MediaEncoder encoder, Writer out)	Simplified constructor.
TextWriter(EncodingContext encodingContext, MediaEncoder encoder, Writer out, boolean outOptimized, Whitespace indentDelegate, Predicate<? super MediaWriter> isNoClose, IOConsumer<? super MediaWriter> closer)

Method Summary

Modifier and Type	Method	Description
TextWriter	append(char c)
TextWriter	append(CharSequence csq)
TextWriter	append(CharSequence csq, int start, int end)
TextWriter	decDepth()	Decrements the indentation depth, if enabled.
MediaWriter	encode(MediaType contentType)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, char ch)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, char[] cbuf)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, char[] cbuf, int offset, int len)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
<Ex extends Throwable> TextWriter	encode(MediaType contentType, MediaWritable<Ex> content)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
<Ex extends Throwable> TextWriter	encode(MediaType contentType, IOSupplierE<?,Ex> content)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, CharSequence csq)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, CharSequence csq, int start, int end)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
TextWriter	encode(MediaType contentType, Object content)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
MediaType	getValidMediaInputType()	Gets the input type.
TextWriter	incDepth()	Increments the indentation depth, if enabled.
TextWriter	indent()	Writes the current indentation when indentation enabled.
TextWriter	indent(int depthOffset)	Writes the current indentation with a depth offset when indentation enabled.
TextWriter	javascript(char ch)	Writes the given JavaScript with proper encoding.
TextWriter	javascript(char[] cbuf)	Writes the given JavaScript with proper encoding.
TextWriter	javascript(char[] cbuf, int offset, int len)	Writes the given JavaScript with proper encoding.
<Ex extends Throwable> TextWriter	javascript(JavaScriptWritable<Ex> javascript)	Writes the given JavaScript with proper encoding.
<Ex extends Throwable> TextWriter	javascript(IOSupplierE<?,Ex> javascript)	Writes the given JavaScript with proper encoding.
TextWriter	javascript(CharSequence csq)	Writes the given JavaScript with proper encoding.
TextWriter	javascript(CharSequence csq, int start, int end)	Writes the given JavaScript with proper encoding.
TextWriter	javascript(Object javascript)	Writes the given JavaScript with proper encoding.
TextWriter	json(char ch)	Writes the given JSON object graph with proper encoding.
TextWriter	json(char[] cbuf)	Writes the given JSON object graph with proper encoding.
TextWriter	json(char[] cbuf, int offset, int len)	Writes the given JSON object graph with proper encoding.
<Ex extends Throwable> TextWriter	json(JsonWritable<Ex> json)	Writes the given JSON object graph with proper encoding.
<Ex extends Throwable> TextWriter	json(IOSupplierE<?,Ex> json)	Writes the given JSON object graph with proper encoding.
TextWriter	json(CharSequence csq)	Writes the given JSON object graph with proper encoding.
TextWriter	json(CharSequence csq, int start, int end)	Writes the given JSON object graph with proper encoding.
TextWriter	json(Object json)	Writes the given JSON object graph with proper encoding.
TextWriter	ldJson(char ch)	Writes the given JSON linked data with proper encoding.
TextWriter	ldJson(char[] cbuf)	Writes the given JSON linked data with proper encoding.
TextWriter	ldJson(char[] cbuf, int offset, int len)	Writes the given JSON linked data with proper encoding.
<Ex extends Throwable> TextWriter	ldJson(LdJsonWritable<Ex> ldJson)	Writes the given JSON linked data with proper encoding.
<Ex extends Throwable> TextWriter	ldJson(IOSupplierE<?,Ex> ldJson)	Writes the given JSON linked data with proper encoding.
TextWriter	ldJson(CharSequence csq)	Writes the given JSON linked data with proper encoding.
TextWriter	ldJson(CharSequence csq, int start, int end)	Writes the given JSON linked data with proper encoding.
TextWriter	ldJson(Object ldJson)	Writes the given JSON linked data with proper encoding.
TextWriter	mysql(char ch)	Writes the given mysql command input with proper encoding.
TextWriter	mysql(char[] cbuf)	Writes the given mysql command input with proper encoding.
TextWriter	mysql(char[] cbuf, int offset, int len)	Writes the given mysql command input with proper encoding.
<Ex extends Throwable> TextWriter	mysql(MysqlWritable<Ex> mysql)	Writes the given mysql command input with proper encoding.
<Ex extends Throwable> TextWriter	mysql(IOSupplierE<?,Ex> mysql)	Writes the given mysql command input with proper encoding.
TextWriter	mysql(CharSequence csq)	Writes the given mysql command input with proper encoding.
TextWriter	mysql(CharSequence csq, int start, int end)	Writes the given mysql command input with proper encoding.
TextWriter	mysql(Object mysql)	Writes the given mysql command input with proper encoding.
TextWriter	nbsp()	Writes one non-breaking space character.
TextWriter	nbsp(int count)	Writes the given number of non-breaking space characters.
TextWriter	nl()	Writes a newline.
TextWriter	nli()	Writes a newline, followed by current indentation when indentation enabled.
TextWriter	nli(int depthOffset)	Writes a newline, followed by current indentation with a depth offset when indentation enabled.
TextWriter	psql(char ch)	Writes the given psql command input with proper encoding.
TextWriter	psql(char[] cbuf)	Writes the given psql command input with proper encoding.
TextWriter	psql(char[] cbuf, int offset, int len)	Writes the given psql command input with proper encoding.
<Ex extends Throwable> TextWriter	psql(PsqlWritable<Ex> psql)	Writes the given psql command input with proper encoding.
<Ex extends Throwable> TextWriter	psql(IOSupplierE<?,Ex> psql)	Writes the given psql command input with proper encoding.
TextWriter	psql(CharSequence csq)	Writes the given psql command input with proper encoding.
TextWriter	psql(CharSequence csq, int start, int end)	Writes the given psql command input with proper encoding.
TextWriter	psql(Object psql)	Writes the given psql command input with proper encoding.
TextWriter	setDepth(int depth)	Sets the indentation depth.
TextWriter	setIndent(boolean indent)	Enables or disabled indentation.
TextWriter	sh(char ch)	Writes the given shell script with proper encoding.
TextWriter	sh(char[] cbuf)	Writes the given shell script with proper encoding.
TextWriter	sh(char[] cbuf, int offset, int len)	Writes the given shell script with proper encoding.
<Ex extends Throwable> TextWriter	sh(ShWritable<Ex> sh)	Writes the given shell script with proper encoding.
<Ex extends Throwable> TextWriter	sh(IOSupplierE<?,Ex> sh)	Writes the given shell script with proper encoding.
TextWriter	sh(CharSequence csq)	Writes the given shell script with proper encoding.
TextWriter	sh(CharSequence csq, int start, int end)	Writes the given shell script with proper encoding.
TextWriter	sh(Object sh)	Writes the given shell script with proper encoding.
TextWriter	sp()	Writes one space character.
TextWriter	sp(int count)	Writes the given number of space characters.
TextWriter	style(char ch)	Writes the given CSS stylesheet with proper encoding.
TextWriter	style(char[] cbuf)	Writes the given CSS stylesheet with proper encoding.
TextWriter	style(char[] cbuf, int offset, int len)	Writes the given CSS stylesheet with proper encoding.
<Ex extends Throwable> TextWriter	style(StyleWritable<Ex> style)	Writes the given CSS stylesheet with proper encoding.
<Ex extends Throwable> TextWriter	style(IOSupplierE<?,Ex> style)	Writes the given CSS stylesheet with proper encoding.
TextWriter	style(CharSequence csq)	Writes the given CSS stylesheet with proper encoding.
TextWriter	style(CharSequence csq, int start, int end)	Writes the given CSS stylesheet with proper encoding.
TextWriter	style(Object style)	Writes the given CSS stylesheet with proper encoding.
TextWriter	text()	Deprecated. Already writing text
TextWriter	text(char ch)	Deprecated. Already writing text
TextWriter	text(char[] cbuf)	Deprecated. Already writing text
TextWriter	text(char[] cbuf, int offset, int len)	Deprecated. Already writing text
<Ex extends Throwable> TextWriter	text(TextWritable<Ex> text)	Deprecated. Already writing text
<Ex extends Throwable> TextWriter	text(IOSupplierE<?,Ex> text)	Deprecated. Already writing text
TextWriter	text(CharSequence csq)	Deprecated. Already writing text
TextWriter	text(CharSequence csq, int start, int end)	Deprecated. Already writing text
TextWriter	text(Object text)	Deprecated. Already writing text
TextWriter	url(char ch)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	url(char[] cbuf)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	url(char[] cbuf, int offset, int len)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
<Ex extends Throwable> TextWriter	url(UrlWritable<Ex> url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
<Ex extends Throwable> TextWriter	url(IOSupplierE<?,Ex> url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	url(CharSequence csq)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	url(CharSequence csq, int start, int end)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	url(Object url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
TextWriter	xhtml(char ch)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtml(char[] cbuf)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtml(char[] cbuf, int offset, int len)	Writes the given (X)HTML with proper encoding.
<Ex extends Throwable> TextWriter	xhtml(XhtmlWritable<Ex> xhtml)	Writes the given (X)HTML with proper encoding.
<Ex extends Throwable> TextWriter	xhtml(IOSupplierE<?,Ex> xhtml)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtml(CharSequence csq)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtml(CharSequence csq, int start, int end)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtml(Object xhtml)	Writes the given (X)HTML with proper encoding.
TextWriter	xhtmlAttribute(char ch)	Writes the given (X)HTML Attribute with proper encoding.
TextWriter	xhtmlAttribute(char[] cbuf)	Writes the given (X)HTML Attribute with proper encoding.
TextWriter	xhtmlAttribute(char[] cbuf, int offset, int len)	Writes the given (X)HTML Attribute with proper encoding.
<Ex extends Throwable> TextWriter	xhtmlAttribute(XhtmlAttributeWritable<Ex> xhtmlAttribute)	Writes the given (X)HTML Attribute with proper encoding.
<Ex extends Throwable> TextWriter	xhtmlAttribute(IOSupplierE<?,Ex> xhtmlAttribute)	Writes the given (X)HTML Attribute with proper encoding.
TextWriter	xhtmlAttribute(CharSequence csq)	Writes the given (X)HTML Attribute with proper encoding.
TextWriter	xhtmlAttribute(CharSequence csq, int start, int end)	Writes the given (X)HTML Attribute with proper encoding.
TextWriter	xhtmlAttribute(Object xhtmlAttribute)	Writes the given (X)HTML Attribute with proper encoding.

Methods inherited from class com.aoapps.encoding.WhitespaceWriter

getDepth, getIndent

Methods inherited from class com.aoapps.encoding.MediaWriter

canSkipValidation, close, getEncoder, getEncodingContext, 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

Methods inherited from interface com.aoapps.encoding.JavaScript

javascript

Methods inherited from interface com.aoapps.encoding.Json

json

Methods inherited from interface com.aoapps.encoding.LdJson

ldJson

Methods inherited from interface com.aoapps.encoding.Mysql

mysql

Methods inherited from interface com.aoapps.encoding.Psql

psql

Methods inherited from interface com.aoapps.encoding.Sh

sh

Methods inherited from interface com.aoapps.encoding.Style

style

Methods inherited from interface com.aoapps.encoding.Url

url

Methods inherited from interface com.aoapps.encoding.Xhtml

xhtml

Methods inherited from interface com.aoapps.encoding.XhtmlAttribute

xhtmlAttribute

Constructor Details

TextWriter

public TextWriter(EncodingContext encodingContext,
 MediaEncoder encoder,
 Writer out,
 boolean outOptimized,
 Whitespace indentDelegate,
 Predicate<? super MediaWriter> isNoClose,
 IOConsumer<? super MediaWriter> closer)

Parameters:

out - Conditionally passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)

outOptimized - Is out already known to have been passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)?

indentDelegate - When non-null, indentation depth is get/set on the provided Whitespace, otherwise tracks directly on this writer. This allows the indentation to be coordinated between nested content types.

isNoClose - Called to determine result of MediaWriter.isNoClose()

closer - Called on MediaWriter.close(), which may optionally perform final suffix write and/or close the underlying writer, will only be called to be idempotent, implementation can assume will only be called once.

TextWriter

public TextWriter(EncodingContext encodingContext,
 MediaEncoder encoder,
 Writer out)

Simplified constructor.

Parameters:

out - Passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)

See Also:

• MediaWriter.DEFAULT_IS_NO_CLOSE
• MediaWriter.DEFAULT_CLOSER

Method Details

getValidMediaInputType

public MediaType getValidMediaInputType()

Description copied from class: MediaWriter

Gets the input type.

Gets the media type this specific type of media writer represents. This is a one-to-one relationship: every media type has a specific writer.

Specified by:

getValidMediaInputType in interface ValidMediaInput

Specified by:

getValidMediaInputType in class MediaWriter

append

public TextWriter append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

public TextWriter append(CharSequence csq)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

encode

@Deprecated
public TextWriter encode(MediaType contentType,
 char ch)
                  throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public TextWriter encode(MediaType contentType,
 char[] cbuf)
                  throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

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

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public TextWriter encode(MediaType contentType,
 CharSequence csq)
                  throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

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

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public TextWriter encode(MediaType contentType,
 CharSequence csq,
 int start,
 int end)
                  throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

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

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public TextWriter encode(MediaType contentType,
 Object content)
                  throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

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

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

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

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

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

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

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

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

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

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

@Deprecated
public MediaWriter encode(MediaType contentType)
                   throws IOException

Deprecated.

Encoding of arbitrary content types is not expected since all supported types have per-type methods.

Encodes the given nested type with proper encoding. This is well suited for use in a try-with-resources block.

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

Does not perform any translation markups.

Specified by:

encode in interface Encode

Specified by:

encode in interface JavaScript

Specified by:

encode in interface Json

Specified by:

encode in interface LdJson

Specified by:

encode in interface Mysql

Specified by:

encode in interface Psql

Specified by:

encode in interface Sh

Specified by:

encode in interface Style

Specified by:

encode in interface Url

Specified by:

encode in interface Xhtml

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class MediaWriter

Returns:

A new writer that may be used for the given content type. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

The returned writer will be of the specific subclass of MediaWriter matching contentType (see MediaType.getMediaWriterClass(). This means MediaWriter.getValidMediaInputType() will be contentType.

Throws:

IOException

nl

public TextWriter 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

Overrides:

nl in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

See Also:

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

nli

public TextWriter 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

Overrides:

nli in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

See Also:

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

nli

public TextWriter 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

Overrides:

nli in class WhitespaceWriter

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 TextWriter indent()
                  throws IOException

Description copied from interface: Whitespace

Writes the current indentation when indentation enabled.

Specified by:

indent in interface Whitespace

Overrides:

indent in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

See Also:

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

indent

public TextWriter 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

Overrides:

indent in class WhitespaceWriter

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)

setIndent

public TextWriter setIndent(boolean indent)

Description copied from interface: Whitespace

Enables or disabled indentation.

Specified by:

setIndent in interface Whitespace

Overrides:

setIndent in class WhitespaceWriter

Returns:

this writer

setDepth

public TextWriter setDepth(int depth)

Description copied from interface: Whitespace

Sets the indentation depth.

Specified by:

setDepth in interface Whitespace

Overrides:

setDepth in class WhitespaceWriter

Returns:

this writer

incDepth

public TextWriter incDepth()

Description copied from interface: Whitespace

Increments the indentation depth, if enabled.

Specified by:

incDepth in interface Whitespace

Overrides:

incDepth in class WhitespaceWriter

Returns:

this writer

decDepth

public TextWriter decDepth()

Description copied from interface: Whitespace

Decrements the indentation depth, if enabled.

Specified by:

decDepth in interface Whitespace

Overrides:

decDepth in class WhitespaceWriter

Returns:

this writer

sp

public TextWriter sp()
              throws IOException

Description copied from interface: Whitespace

Writes one space character.

Specified by:

sp in interface Whitespace

Overrides:

sp in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp(int)
• Whitespace.SPACE

sp

public TextWriter sp(int count)
              throws IOException

Description copied from interface: Whitespace

Writes the given number of space characters.

Specified by:

sp in interface Whitespace

Overrides:

sp in class WhitespaceWriter

Parameters:

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

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp()
• Whitespace.SPACE

xhtml

public TextWriter xhtml(char ch)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public TextWriter xhtml(char[] cbuf)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public TextWriter xhtml(char[] cbuf,
 int offset,
 int len)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public TextWriter xhtml(CharSequence csq)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public TextWriter xhtml(CharSequence csq,
 int start,
 int end)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public TextWriter xhtml(Object xhtml)
                 throws IOException

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtml in interface Xhtml

Returns:

this writer

Throws:

IOException

xhtml

public <Ex extends Throwable> TextWriter xhtml(IOSupplierE<?,Ex> xhtml)
                                        throws IOException,
Ex

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtml in interface Xhtml

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

xhtml

public <Ex extends Throwable> TextWriter xhtml(XhtmlWritable<Ex> xhtml)
                                        throws IOException,
Ex

Description copied from interface: Xhtml

Writes the given (X)HTML with proper encoding.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

xhtml in interface Xhtml

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

xhtmlAttribute

public TextWriter xhtmlAttribute(char ch)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public TextWriter xhtmlAttribute(char[] cbuf)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public TextWriter xhtmlAttribute(char[] cbuf,
 int offset,
 int len)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public TextWriter xhtmlAttribute(CharSequence csq)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public TextWriter xhtmlAttribute(CharSequence csq,
 int start,
 int end)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public TextWriter xhtmlAttribute(Object xhtmlAttribute)
                          throws IOException

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

this writer

Throws:

IOException

xhtmlAttribute

public <Ex extends Throwable> TextWriter xhtmlAttribute(IOSupplierE<?,Ex> xhtmlAttribute)
                                                 throws IOException,
Ex

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

xhtmlAttribute

public <Ex extends Throwable> TextWriter xhtmlAttribute(XhtmlAttributeWritable<Ex> xhtmlAttribute)
                                                 throws IOException,
Ex

Description copied from interface: XhtmlAttribute

Writes the given (X)HTML Attribute with proper encoding.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

style

public TextWriter style(char ch)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public TextWriter style(char[] cbuf)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public TextWriter style(char[] cbuf,
 int offset,
 int len)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public TextWriter style(CharSequence csq)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

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

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public TextWriter style(CharSequence csq,
 int start,
 int end)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

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

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public TextWriter style(Object style)
                 throws IOException

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

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

Specified by:

style in interface Style

Returns:

this writer

Throws:

IOException

style

public <Ex extends Throwable> TextWriter style(IOSupplierE<?,Ex> style)
                                        throws IOException,
Ex

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

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

Specified by:

style in interface Style

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

style

public <Ex extends Throwable> TextWriter style(StyleWritable<Ex> style)
                                        throws IOException,
Ex

Description copied from interface: Style

Writes the given CSS stylesheet with proper encoding.

Adds prefixes and suffixes by media type, such as <style>…</style>.

Does not perform any translation markups.

Specified by:

style in interface Style

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

javascript

public TextWriter javascript(char ch)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public TextWriter javascript(char[] cbuf)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public TextWriter javascript(char[] cbuf,
 int offset,
 int len)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public TextWriter javascript(CharSequence csq)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

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

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public TextWriter javascript(CharSequence csq,
 int start,
 int end)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

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

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public TextWriter javascript(Object javascript)
                      throws IOException

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

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

Specified by:

javascript in interface JavaScript

Returns:

this writer

Throws:

IOException

javascript

public <Ex extends Throwable> TextWriter javascript(IOSupplierE<?,Ex> javascript)
                                             throws IOException,
Ex

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

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

Specified by:

javascript in interface JavaScript

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

javascript

public <Ex extends Throwable> TextWriter javascript(JavaScriptWritable<Ex> javascript)
                                             throws IOException,
Ex

Description copied from interface: JavaScript

Writes the given JavaScript with proper encoding.

Adds prefixes and suffixes by media type, such as <script>…</script>.

Does not perform any translation markups.

Specified by:

javascript in interface JavaScript

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

json

public TextWriter json(char ch)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public TextWriter json(char[] cbuf)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public TextWriter json(char[] cbuf,
 int offset,
 int len)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public TextWriter json(CharSequence csq)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

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

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public TextWriter json(CharSequence csq,
 int start,
 int end)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

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

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public TextWriter json(Object json)
                throws IOException

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

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

Specified by:

json in interface Json

Returns:

this writer

Throws:

IOException

json

public <Ex extends Throwable> TextWriter json(IOSupplierE<?,Ex> json)
                                       throws IOException,
Ex

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

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

Specified by:

json in interface Json

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

json

public <Ex extends Throwable> TextWriter json(JsonWritable<Ex> json)
                                       throws IOException,
Ex

Description copied from interface: Json

Writes the given JSON object graph with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/json">…</script>.

Does not perform any translation markups.

Specified by:

json in interface Json

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

ldJson

public TextWriter ldJson(char ch)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public TextWriter ldJson(char[] cbuf)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public TextWriter ldJson(char[] cbuf,
 int offset,
 int len)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public TextWriter ldJson(CharSequence csq)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

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

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public TextWriter ldJson(CharSequence csq,
 int start,
 int end)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

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

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public TextWriter ldJson(Object ldJson)
                  throws IOException

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

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

Specified by:

ldJson in interface LdJson

Returns:

this writer

Throws:

IOException

ldJson

public <Ex extends Throwable> TextWriter ldJson(IOSupplierE<?,Ex> ldJson)
                                         throws IOException,
Ex

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

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

Specified by:

ldJson in interface LdJson

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

ldJson

public <Ex extends Throwable> TextWriter ldJson(LdJsonWritable<Ex> ldJson)
                                         throws IOException,
Ex

Description copied from interface: LdJson

Writes the given JSON linked data with proper encoding.

Adds prefixes and suffixes by media type, such as <script type="application/ld+json">…</script>.

Does not perform any translation markups.

Specified by:

ldJson in interface LdJson

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

nbsp

public TextWriter nbsp()
                throws IOException

Description copied from interface: Text

Writes one non-breaking space character.

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

Specified by:

nbsp in interface Text

Returns:

this writer

Throws:

IOException

See Also:

• Text.nbsp(int)
• Text.NBSP

nbsp

public TextWriter nbsp(int count)
                throws IOException

Description copied from interface: Text

Writes the given number of non-breaking space characters.

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

Specified by:

nbsp in interface Text

Parameters:

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

Returns:

this writer

Throws:

IOException

See Also:

• Text.nbsp()
• Text.NBSP

text

@Deprecated
public TextWriter text(char ch)
                throws IOException

Deprecated.

Already writing text

Writes the given text with proper encoding.

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

Specified by:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public TextWriter text(char[] cbuf)
                throws IOException

Deprecated.

Already writing text

Writes the given text with proper encoding.

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

Specified by:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public TextWriter text(char[] cbuf,
 int offset,
 int len)
                throws IOException

Deprecated.

Already writing text

Writes the given text with proper encoding.

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

Specified by:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public TextWriter text(CharSequence csq)
                throws IOException

Deprecated.

Already writing text

Writes the given text 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:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public TextWriter text(CharSequence csq,
 int start,
 int end)
                throws IOException

Deprecated.

Already writing text

Writes the given text 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:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public TextWriter text(Object text)
                throws IOException

Deprecated.

Already writing text

Writes the given text 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:

text in interface Text

Returns:

this writer

Throws:

IOException

text

@Deprecated
public <Ex extends Throwable> TextWriter text(IOSupplierE<?,Ex> text)
                                       throws IOException,
Ex

Deprecated.

Already writing text

Writes the given text 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:

text in interface Text

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

text

@Deprecated
public <Ex extends Throwable> TextWriter text(TextWritable<Ex> text)
                                       throws IOException,
Ex

Deprecated.

Already writing text

Writes the given text with proper encoding.

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

Does not perform any translation markups.

Specified by:

text in interface Text

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

text

@Deprecated
public TextWriter text()
                throws IOException

Deprecated.

Already writing text

Writes the given text with proper encoding. This is well suited for use in a try-with-resources block.

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

Does not perform any translation markups.

Specified by:

text in interface Text

Returns:

A new writer that may be used for arbitrary text. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

Throws:

IOException

url

public TextWriter url(char ch)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.

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

Specified by:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public TextWriter url(char[] cbuf)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.

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

Specified by:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public TextWriter url(char[] cbuf,
 int offset,
 int len)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.

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

Specified by:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public TextWriter url(CharSequence csq)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI 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:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public TextWriter url(CharSequence csq,
 int start,
 int end)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI 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:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public TextWriter url(Object url)
               throws IOException

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI 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:

url in interface Url

Returns:

this writer

Throws:

IOException

url

public <Ex extends Throwable> TextWriter url(IOSupplierE<?,Ex> url)
                                      throws IOException,
Ex

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI 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:

url in interface Url

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

url

public <Ex extends Throwable> TextWriter url(UrlWritable<Ex> url)
                                      throws IOException,
Ex

Description copied from interface: Url

Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.

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

Does not perform any translation markups.

Specified by:

url in interface Url

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

sh

public TextWriter sh(char ch)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public TextWriter sh(char[] cbuf)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public TextWriter sh(char[] cbuf,
 int offset,
 int len)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public TextWriter sh(CharSequence csq)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public TextWriter sh(CharSequence csq,
 int start,
 int end)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public TextWriter sh(Object sh)
              throws IOException

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

sh in interface Sh

Returns:

this writer

Throws:

IOException

sh

public <Ex extends Throwable> TextWriter sh(IOSupplierE<?,Ex> sh)
                                     throws IOException,
Ex

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

sh in interface Sh

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

sh

public <Ex extends Throwable> TextWriter sh(ShWritable<Ex> sh)
                                     throws IOException,
Ex

Description copied from interface: Sh

Writes the given shell script with proper encoding.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

sh in interface Sh

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

mysql

public TextWriter mysql(char ch)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public TextWriter mysql(char[] cbuf)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public TextWriter mysql(char[] cbuf,
 int offset,
 int len)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public TextWriter mysql(CharSequence csq)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public TextWriter mysql(CharSequence csq,
 int start,
 int end)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public TextWriter mysql(Object mysql)
                 throws IOException

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

mysql in interface Mysql

Returns:

this writer

Throws:

IOException

mysql

public <Ex extends Throwable> TextWriter mysql(IOSupplierE<?,Ex> mysql)
                                        throws IOException,
Ex

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

mysql in interface Mysql

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

mysql

public <Ex extends Throwable> TextWriter mysql(MysqlWritable<Ex> mysql)
                                        throws IOException,
Ex

Description copied from interface: Mysql

Writes the given mysql command input with proper encoding.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

mysql in interface Mysql

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

psql

public TextWriter psql(char ch)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public TextWriter psql(char[] cbuf)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public TextWriter psql(char[] cbuf,
 int offset,
 int len)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public TextWriter psql(CharSequence csq)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public TextWriter psql(CharSequence csq,
 int start,
 int end)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public TextWriter psql(Object psql)
                throws IOException

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

psql in interface Psql

Returns:

this writer

Throws:

IOException

psql

public <Ex extends Throwable> TextWriter psql(IOSupplierE<?,Ex> psql)
                                       throws IOException,
Ex

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

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

Specified by:

psql in interface Psql

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

psql

public <Ex extends Throwable> TextWriter psql(PsqlWritable<Ex> psql)
                                       throws IOException,
Ex

Description copied from interface: Psql

Writes the given psql command input with proper encoding.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

psql in interface Psql

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex