Module com.aoapps.encoding

Package com.aoapps.encoding

Class UrlWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.lang.io.EncoderWriter

com.aoapps.encoding.MediaWriter

com.aoapps.encoding.UrlWriter

All Implemented Interfaces:

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

@ThreadSafe
public final class UrlWriter
extends MediaWriter
implements 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

Constructor Summary

Constructors

Constructor	Description
UrlWriter(EncodingContext encodingContext, MediaEncoder encoder, Writer out)	Simplified constructor.
UrlWriter(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
UrlWriter	append(char c)
UrlWriter	append(CharSequence csq)
UrlWriter	append(CharSequence csq, int start, int end)
MediaWriter	encode(MediaType contentType)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
UrlWriter	encode(MediaType contentType, char ch)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
UrlWriter	encode(MediaType contentType, char[] cbuf)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
UrlWriter	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> UrlWriter	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> UrlWriter	encode(MediaType contentType, IOSupplierE<?,Ex> content)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
UrlWriter	encode(MediaType contentType, CharSequence csq)	Deprecated. Encoding of arbitrary content types is not expected since all supported types have per-type methods.
UrlWriter	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.
UrlWriter	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.
UrlWriter	url()	Deprecated. Already writing URL
UrlWriter	url(char ch)	Deprecated. Already writing URL
UrlWriter	url(char[] cbuf)	Deprecated. Already writing URL
UrlWriter	url(char[] cbuf, int offset, int len)	Deprecated. Already writing URL
<Ex extends Throwable> UrlWriter	url(UrlWritable<Ex> url)	Deprecated. Already writing URL
<Ex extends Throwable> UrlWriter	url(IOSupplierE<?,Ex> url)	Deprecated. Already writing URL
UrlWriter	url(CharSequence csq)	Deprecated. Already writing URL
UrlWriter	url(CharSequence csq, int start, int end)	Deprecated. Already writing URL
UrlWriter	url(Object url)	Deprecated. Already writing URL

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

Constructor Details

UrlWriter

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

UrlWriter

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

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

append

public UrlWriter append(CharSequence csq)
                 throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class MediaWriter

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Returns:

this writer

Throws:

IOException

encode

@Deprecated
public <Ex extends Throwable> UrlWriter 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 Url

Overrides:

encode in class MediaWriter

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

@Deprecated
public <Ex extends Throwable> UrlWriter 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 Url

Overrides:

encode in class MediaWriter

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

url

@Deprecated
public UrlWriter url(char ch)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public UrlWriter url(char[] cbuf)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public UrlWriter url(char[] cbuf,
 int offset,
 int len)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public UrlWriter url(CharSequence csq)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public UrlWriter url(CharSequence csq,
 int start,
 int end)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public UrlWriter url(Object url)
              throws IOException

Deprecated.

Already writing 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

@Deprecated
public <Ex extends Throwable> UrlWriter url(IOSupplierE<?,Ex> url)
                                     throws IOException,
Ex

Deprecated.

Already writing 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

@Deprecated
public <Ex extends Throwable> UrlWriter url(UrlWritable<Ex> url)
                                     throws IOException,
Ex

Deprecated.

Already writing 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

url

@Deprecated
public UrlWriter url()
              throws IOException

Deprecated.

Already writing URL

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

url in interface Url

Returns:

A new writer that may be used for arbitrary RFC 3986 URI or RFC 3987 IRI. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

Throws:

IOException