Module com.aoapps.encoding

Package com.aoapps.encoding

Class JavaScriptWriter

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

All Implemented Interfaces:

Encode, JavaScript, Json, LdJson, Text, Url, ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Whitespace, NoClose, Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

JsonWriter

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

text

Methods inherited from interface com.aoapps.encoding.Url

url

Constructor Details

JavaScriptWriter

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

JavaScriptWriter

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

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

public JavaScriptWriter append(CharSequence csq)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class WhitespaceWriter

Throws:

IOException

append

public JavaScriptWriter 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 JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public JavaScriptWriter 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 Text

Specified by:

encode in interface Url

Overrides:

encode in class WhitespaceWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public <Ex extends Throwable> JavaScriptWriter 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 Text

Specified by:

encode in interface Url

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

Specified by:

encode in interface Url

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 Url

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

javascript

@Deprecated
public JavaScriptWriter javascript(char ch)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter javascript(char[] cbuf)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter javascript(char[] cbuf,
 int offset,
 int len)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter javascript(CharSequence csq)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter javascript(CharSequence csq,
 int start,
 int end)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter javascript(Object javascript)
                            throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter javascript(IOSupplierE<?,Ex> javascript)
                                                   throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter javascript(JavaScriptWritable<Ex> javascript)
                                                   throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

javascript

@Deprecated
public JavaScriptWriter javascript()
                            throws IOException

Deprecated.

Already writing JavaScript script

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

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

Does not perform any translation markups.

Specified by:

javascript in interface JavaScript

Returns:

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

Throws:

IOException

json

@Deprecated
public JavaScriptWriter json(char ch)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter json(char[] cbuf)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter json(char[] cbuf,
 int offset,
 int len)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter json(CharSequence csq)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter json(CharSequence csq,
 int start,
 int end)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter json(Object json)
                      throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter json(IOSupplierE<?,Ex> json)
                                             throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter json(JsonWritable<Ex> json)
                                             throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

json

@Deprecated
public JsonWriter json()
                throws IOException

Deprecated.

Already writing JavaScript script

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

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

Returns:

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

Throws:

IOException

ldJson

@Deprecated
public JavaScriptWriter ldJson(char ch)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter ldJson(char[] cbuf)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter ldJson(char[] cbuf,
 int offset,
 int len)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter ldJson(CharSequence csq)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter ldJson(CharSequence csq,
 int start,
 int end)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public JavaScriptWriter ldJson(Object ldJson)
                        throws IOException

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter ldJson(IOSupplierE<?,Ex> ldJson)
                                               throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

@Deprecated
public <Ex extends Throwable> JavaScriptWriter ldJson(LdJsonWritable<Ex> ldJson)
                                               throws IOException,
Ex

Deprecated.

Already writing JavaScript script

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

ldJson

@Deprecated
public LdJsonWriter ldJson()
                    throws IOException

Deprecated.

Already writing JavaScript script

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

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

Returns:

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

Throws:

IOException

nbsp

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