Module com.aoapps.encoding

Package com.aoapps.encoding

Class JsonWriter

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

com.aoapps.encoding.JsonWriter

All Implemented Interfaces:

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

Direct Known Subclasses:

LdJsonWriter

@ThreadSafe
public class JsonWriter
extends JavaScriptWriter

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

JsonWriter

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

JsonWriter

public JsonWriter(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

Overrides:

getValidMediaInputType in class JavaScriptWriter

append

public JsonWriter append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class JavaScriptWriter

Throws:

IOException

append

public JsonWriter append(CharSequence csq)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class JavaScriptWriter

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class JavaScriptWriter

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Returns:

this writer

Throws:

IOException

encode

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

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

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

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 JavaScriptWriter

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

Returns:

this writer

Throws:

IOException

See Also:

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

nli

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

Returns:

this writer

Throws:

IOException

See Also:

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

nli

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

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

Returns:

this writer

Throws:

IOException

See Also:

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

indent

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

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 JsonWriter setIndent(boolean indent)

Description copied from interface: Whitespace

Enables or disabled indentation.

Specified by:

setIndent in interface Whitespace

Overrides:

setIndent in class JavaScriptWriter

Returns:

this writer

setDepth

public JsonWriter setDepth(int depth)

Description copied from interface: Whitespace

Sets the indentation depth.

Specified by:

setDepth in interface Whitespace

Overrides:

setDepth in class JavaScriptWriter

Returns:

this writer

incDepth

public JsonWriter incDepth()

Description copied from interface: Whitespace

Increments the indentation depth, if enabled.

Specified by:

incDepth in interface Whitespace

Overrides:

incDepth in class JavaScriptWriter

Returns:

this writer

decDepth

public JsonWriter decDepth()

Description copied from interface: Whitespace

Decrements the indentation depth, if enabled.

Specified by:

decDepth in interface Whitespace

Overrides:

decDepth in class JavaScriptWriter

Returns:

this writer

sp

public JsonWriter sp()
              throws IOException

Description copied from interface: Whitespace

Writes one space character.

Specified by:

sp in interface Whitespace

Overrides:

sp in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp(int)
• Whitespace.SPACE

sp

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

Parameters:

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

Returns:

this writer

Throws:

IOException

See Also:

• Whitespace.sp()
• Whitespace.SPACE

javascript

@Deprecated
public JsonWriter javascript(char ch)
                      throws IOException

Deprecated.

Already writing JSON object graph

Writes the given JavaScript with proper encoding.

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

Specified by:

javascript in interface JavaScript

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

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

Deprecated.

Already writing JSON object graph

Writes the given JavaScript with proper encoding.

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

Specified by:

javascript in interface JavaScript

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

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

Deprecated.

Already writing JSON object graph

Writes the given JavaScript with proper encoding.

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

Specified by:

javascript in interface JavaScript

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

@Deprecated
public JsonWriter javascript(CharSequence csq)
                      throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

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

Deprecated.

Already writing JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

@Deprecated
public JsonWriter javascript(Object javascript)
                      throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

javascript

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

Deprecated.

Already writing JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

javascript

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

Deprecated.

Already writing JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

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 JSON object graph

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

Overrides:

javascript in class JavaScriptWriter

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 JsonWriter json(char ch)
                throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

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

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

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

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

@Deprecated
public JsonWriter json(CharSequence csq)
                throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

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

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

@Deprecated
public JsonWriter json(Object json)
                throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

json

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

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

json

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

Deprecated.

Already writing JSON object graph

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

Overrides:

json in class JavaScriptWriter

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 JSON object graph

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

Overrides:

json in class JavaScriptWriter

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 JsonWriter ldJson(char ch)
                  throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

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

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

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

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

@Deprecated
public JsonWriter ldJson(CharSequence csq)
                  throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

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

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

@Deprecated
public JsonWriter ldJson(Object ldJson)
                  throws IOException

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

ldJson

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

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

ldJson

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

Deprecated.

Already writing JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

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 JSON object graph

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

Overrides:

ldJson in class JavaScriptWriter

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

Overrides:

nbsp in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

See Also:

• Text.nbsp(int)
• Text.NBSP

nbsp

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

Overrides:

nbsp in class JavaScriptWriter

Parameters:

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

Returns:

this writer

Throws:

IOException

See Also:

• Text.nbsp()
• Text.NBSP

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

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

Overrides:

text in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

text

public <Ex extends Throwable> JsonWriter 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

Overrides:

text in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

text

public <Ex extends Throwable> JsonWriter 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

Overrides:

text in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

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

Overrides:

url in class JavaScriptWriter

Returns:

this writer

Throws:

IOException

url

public <Ex extends Throwable> JsonWriter 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

Overrides:

url in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

url

public <Ex extends Throwable> JsonWriter 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

Overrides:

url in class JavaScriptWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex