Module com.aoapps.encoding

Package com.aoapps.encoding

Class XhtmlAttributeWriter

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

All Implemented Interfaces:

Encode, JavaScript, Style, Text, Url, ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Whitespace, XhtmlAttribute, NoClose, Closeable, Flushable, Appendable, AutoCloseable

@ThreadSafe
public final class XhtmlAttributeWriter
extends WhitespaceWriter
implements XhtmlAttribute, Style, JavaScript, Text, Url

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
XhtmlAttributeWriter(EncodingContext encodingContext, MediaEncoder encoder, Writer out)	Simplified constructor.
XhtmlAttributeWriter(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
XhtmlAttributeWriter	append(char c)
XhtmlAttributeWriter	append(CharSequence csq)
XhtmlAttributeWriter	append(CharSequence csq, int start, int end)
XhtmlAttributeWriter	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.
XhtmlAttributeWriter	encode(MediaType contentType, char ch)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
XhtmlAttributeWriter	encode(MediaType contentType, char[] cbuf)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
XhtmlAttributeWriter	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> XhtmlAttributeWriter	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> XhtmlAttributeWriter	encode(MediaType contentType, IOSupplierE<?,Ex> content)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
XhtmlAttributeWriter	encode(MediaType contentType, CharSequence csq)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
XhtmlAttributeWriter	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.
XhtmlAttributeWriter	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.
XhtmlAttributeWriter	incDepth()	Increments the indentation depth, if enabled.
XhtmlAttributeWriter	indent()	Writes the current indentation when indentation enabled.
XhtmlAttributeWriter	indent(int depthOffset)	Writes the current indentation with a depth offset when indentation enabled.
XhtmlAttributeWriter	javascript(char ch)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	javascript(char[] cbuf)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	javascript(char[] cbuf, int offset, int len)	Writes the given JavaScript with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	javascript(JavaScriptWritable<Ex> javascript)	Writes the given JavaScript with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	javascript(IOSupplierE<?,Ex> javascript)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	javascript(CharSequence csq)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	javascript(CharSequence csq, int start, int end)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	javascript(Object javascript)	Writes the given JavaScript with proper encoding.
XhtmlAttributeWriter	nbsp()	Writes one non-breaking space character.
XhtmlAttributeWriter	nbsp(int count)	Writes the given number of non-breaking space characters.
XhtmlAttributeWriter	nl()	Writes a newline.
XhtmlAttributeWriter	nli()	Writes a newline, followed by current indentation when indentation enabled.
XhtmlAttributeWriter	nli(int depthOffset)	Writes a newline, followed by current indentation with a depth offset when indentation enabled.
XhtmlAttributeWriter	setDepth(int depth)	Sets the indentation depth.
XhtmlAttributeWriter	setIndent(boolean indent)	Enables or disabled indentation.
XhtmlAttributeWriter	sp()	Writes one space character.
XhtmlAttributeWriter	sp(int count)	Writes the given number of space characters.
XhtmlAttributeWriter	style(char ch)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	style(char[] cbuf)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	style(char[] cbuf, int offset, int len)	Writes the given CSS stylesheet with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	style(StyleWritable<Ex> style)	Writes the given CSS stylesheet with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	style(IOSupplierE<?,Ex> style)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	style(CharSequence csq)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	style(CharSequence csq, int start, int end)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	style(Object style)	Writes the given CSS stylesheet with proper encoding.
XhtmlAttributeWriter	text(char ch)	Writes the given text with proper encoding.
XhtmlAttributeWriter	text(char[] cbuf)	Writes the given text with proper encoding.
XhtmlAttributeWriter	text(char[] cbuf, int offset, int len)	Writes the given text with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	text(TextWritable<Ex> text)	Writes the given text with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	text(IOSupplierE<?,Ex> text)	Writes the given text with proper encoding.
XhtmlAttributeWriter	text(CharSequence csq)	Writes the given text with proper encoding.
XhtmlAttributeWriter	text(CharSequence csq, int start, int end)	Writes the given text with proper encoding.
XhtmlAttributeWriter	text(Object text)	Writes the given text with proper encoding.
XhtmlAttributeWriter	url(char ch)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	url(char[] cbuf)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	url(char[] cbuf, int offset, int len)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	url(UrlWritable<Ex> url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
<Ex extends Throwable> XhtmlAttributeWriter	url(IOSupplierE<?,Ex> url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	url(CharSequence csq)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	url(CharSequence csq, int start, int end)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	url(Object url)	Writes the given RFC 3986 URI or RFC 3987 IRI with proper encoding.
XhtmlAttributeWriter	xhtmlAttribute()	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(char ch)	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(char[] cbuf)	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(char[] cbuf, int offset, int len)	Deprecated. Already writing XHTML attribute
<Ex extends Throwable> XhtmlAttributeWriter	xhtmlAttribute(XhtmlAttributeWritable<Ex> xhtmlAttribute)	Deprecated. Already writing XHTML attribute
<Ex extends Throwable> XhtmlAttributeWriter	xhtmlAttribute(IOSupplierE<?,Ex> xhtmlAttribute)	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(CharSequence csq)	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(CharSequence csq, int start, int end)	Deprecated. Already writing XHTML attribute
XhtmlAttributeWriter	xhtmlAttribute(Object xhtmlAttribute)	Deprecated. Already writing XHTML attribute

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

style

Methods inherited from interface com.aoapps.encoding.Text

text

Methods inherited from interface com.aoapps.encoding.Url

url

Constructor Details

XhtmlAttributeWriter

public XhtmlAttributeWriter(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.

XhtmlAttributeWriter

public XhtmlAttributeWriter(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 XhtmlAttributeWriter append(char c)
                            throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

public XhtmlAttributeWriter append(CharSequence csq)
                            throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

public XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

Specified by:

encode in interface XhtmlAttribute

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public <Ex extends Throwable> XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

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> XhtmlAttributeWriter 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 Style

Specified by:

encode in interface Text

Specified by:

encode in interface Url

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 Style

Specified by:

encode in interface Url

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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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 XhtmlAttributeWriter 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

xhtmlAttribute

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(char ch)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(char[] cbuf)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(char[] cbuf,
 int offset,
 int len)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(CharSequence csq)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(CharSequence csq,
 int start,
 int end)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute(Object xhtmlAttribute)
                                    throws IOException

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public <Ex extends Throwable> XhtmlAttributeWriter xhtmlAttribute(IOSupplierE<?,Ex> xhtmlAttribute)
                                                           throws IOException,
Ex

Deprecated.

Already writing XHTML attribute

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

@Deprecated
public <Ex extends Throwable> XhtmlAttributeWriter xhtmlAttribute(XhtmlAttributeWritable<Ex> xhtmlAttribute)
                                                           throws IOException,
Ex

Deprecated.

Already writing XHTML attribute

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

xhtmlAttribute

@Deprecated
public XhtmlAttributeWriter xhtmlAttribute()
                                    throws IOException

Deprecated.

Already writing XHTML attribute

Writes the given (X)HTML Attribute with proper encoding. This is well suited for use in a try-with-resources block.

Adds prefixes and suffixes by media type.

Does not perform any translation markups.

Specified by:

xhtmlAttribute in interface XhtmlAttribute

Returns:

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

Throws:

IOException

style

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

nbsp

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

public XhtmlAttributeWriter text(char ch)
                          throws IOException

Description copied from interface: 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

public XhtmlAttributeWriter text(char[] cbuf)
                          throws IOException

Description copied from interface: 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

public XhtmlAttributeWriter text(char[] cbuf,
 int offset,
 int len)
                          throws IOException

Description copied from interface: 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

public XhtmlAttributeWriter text(CharSequence csq)
                          throws IOException

Description copied from interface: 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

public XhtmlAttributeWriter text(CharSequence csq,
 int start,
 int end)
                          throws IOException

Description copied from interface: 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

public XhtmlAttributeWriter text(Object text)
                          throws IOException

Description copied from interface: 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

public <Ex extends Throwable> XhtmlAttributeWriter text(IOSupplierE<?,Ex> text)
                                                 throws IOException,
Ex

Description copied from interface: 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

public <Ex extends Throwable> XhtmlAttributeWriter text(TextWritable<Ex> text)
                                                 throws IOException,
Ex

Description copied from interface: 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

url

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