Module com.aoapps.encoding

Package com.aoapps.encoding

Class MediaWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.lang.io.EncoderWriter

com.aoapps.encoding.MediaWriter

All Implemented Interfaces:

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

Direct Known Subclasses:

UrlWriter, WhitespaceWriter

@ThreadSafe
public abstract class MediaWriter
extends EncoderWriter
implements ValidMediaFilter, Encode, NoClose

Streaming versions of media encoders.

Note: The specialized subclasses implement per-type interfaces precisely matching the supported encoders.

Author:

AO Industries, Inc.

See Also:

• MediaEncoder

Field Summary

Fields

Modifier and Type	Field	Description
static final IOConsumer<? super MediaWriter>	DEFAULT_CLOSER	The closer(MediaWriter) implementation used for methods where not specified, such as MediaType.newMediaWriter(com.aoapps.encoding.EncodingContext, com.aoapps.encoding.MediaEncoder, java.io.Writer).
static final Predicate<? super MediaWriter>	DEFAULT_IS_NO_CLOSE	The isNoClose(MediaWriter) implementation used for methods where not specified, such as MediaType.newMediaWriter(com.aoapps.encoding.EncodingContext, com.aoapps.encoding.MediaEncoder, java.io.Writer).

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method	Description
MediaWriter	append(char c)
MediaWriter	append(CharSequence csq)
MediaWriter	append(CharSequence csq, int start, int end)
boolean	canSkipValidation(MediaType outputType)	Checks if validation may be skipped when the characters being written to this validator is already known to be valid with the given media type.
final void	close()
MediaWriter	encode(MediaType contentType)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, char ch)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, char[] cbuf)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, char[] cbuf, int offset, int len)	Encodes the given nested type with proper encoding.
<Ex extends Throwable> MediaWriter	encode(MediaType contentType, MediaWritable<Ex> content)	Encodes the given nested type with proper encoding.
<Ex extends Throwable> MediaWriter	encode(MediaType contentType, IOSupplierE<?,Ex> content)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, CharSequence csq)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, CharSequence csq, int start, int end)	Encodes the given nested type with proper encoding.
MediaWriter	encode(MediaType contentType, Object content)	Encodes the given nested type with proper encoding.
MediaEncoder	getEncoder()
EncodingContext	getEncodingContext()
abstract MediaType	getValidMediaInputType()	Gets the input type.
MediaType	getValidMediaOutputType()	Gets the output type.
final boolean	isNoClose()
boolean	isValidatingMediaInputType(MediaType inputType)	Checks if this is validating the provided type, which allows one validator to be substituted in place of another.

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

Field Details

DEFAULT_IS_NO_CLOSE

public static final Predicate<? super MediaWriter> DEFAULT_IS_NO_CLOSE

The isNoClose(MediaWriter) implementation used for methods where not specified, such as MediaType.newMediaWriter(com.aoapps.encoding.EncodingContext, com.aoapps.encoding.MediaEncoder, java.io.Writer).

Defaults to (out instanceof NoClose) && ((NoClose)out).isNoClose()

DEFAULT_CLOSER

public static final IOConsumer<? super MediaWriter> DEFAULT_CLOSER

The closer(MediaWriter) implementation used for methods where not specified, such as MediaType.newMediaWriter(com.aoapps.encoding.EncodingContext, com.aoapps.encoding.MediaEncoder, java.io.Writer).

Defaults to mediaWriter.out.close()

Method Details

getEncodingContext

public EncodingContext getEncodingContext()

getEncoder

public MediaEncoder getEncoder()

Overrides:

getEncoder in class EncoderWriter

isNoClose

public final boolean isNoClose()

Specified by:

isNoClose in interface NoClose

Overrides:

isNoClose in class EncoderWriter

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface NoClose

Overrides:

close in class FilterWriter

Throws:

IOException

getValidMediaInputType

public abstract MediaType getValidMediaInputType()

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

isValidatingMediaInputType

public boolean isValidatingMediaInputType(MediaType inputType)

Description copied from interface: ValidMediaInput

Checks if this is validating the provided type, which allows one validator to be substituted in place of another. This is acceptable when this validator is equal to, or more strict, than the given inputType.

Please note that this validator only needs to block invalid characters for inputType. This validator does not need to let through all characters, just block the invalid. This is a one-way optimization.

This is almost the inverse operation of ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType), with the exception of characters only invalid due to nested encodings.

Specified by:

isValidatingMediaInputType in interface ValidMediaInput

Returns:

true when this validator will throw exceptions on all invalid characters from the given inputType

See Also:

• ValidMediaInput.canSkipValidation(com.aoapps.encoding.MediaType)

canSkipValidation

public boolean canSkipValidation(MediaType outputType)

Description copied from interface: ValidMediaInput

Checks if validation may be skipped when the characters being written to this validator is already known to be valid with the given media type. This may be done when every valid character for the given media type is also valid within this validator.

This is almost the inverse operation of ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType), with the exception of characters only invalid due to nested encodings.

Specified by:

canSkipValidation in interface ValidMediaInput

Returns:

true when all valid characters of the given outputType are also valid on this validator

See Also:

• ValidMediaInput.isValidatingMediaInputType(com.aoapps.encoding.MediaType)

getValidMediaOutputType

public MediaType getValidMediaOutputType()

Description copied from interface: ValidMediaOutput

Gets the output type.

Specified by:

getValidMediaOutputType in interface ValidMediaOutput

append

public MediaWriter append(char c)
                   throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class EncoderWriter

Throws:

IOException

append

public MediaWriter append(CharSequence csq)
                   throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class EncoderWriter

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class EncoderWriter

Throws:

IOException

encode

public MediaWriter encode(MediaType contentType,
 char ch)
                   throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Returns:

this writer

Throws:

IOException

encode

public MediaWriter encode(MediaType contentType,
 char[] cbuf)
                   throws IOException

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Returns:

this writer

Throws:

IOException

encode

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

Description copied from interface: Encode

Encodes the given nested type with proper encoding.

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

Specified by:

encode in interface Encode

Returns:

this writer

Throws:

IOException

encode

public MediaWriter encode(MediaType contentType,
 CharSequence csq)
                   throws IOException

Description copied from interface: Encode

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

Returns:

this writer

Throws:

IOException

encode

public MediaWriter encode(MediaType contentType,
 CharSequence csq,
 int start,
 int end)
                   throws IOException

Description copied from interface: Encode

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

Returns:

this writer

Throws:

IOException

encode

public MediaWriter encode(MediaType contentType,
 Object content)
                   throws IOException

Description copied from interface: Encode

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

Returns:

this writer

Throws:

IOException

encode

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

Description copied from interface: Encode

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

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

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

Description copied from interface: Encode

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

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

encode

public MediaWriter encode(MediaType contentType)
                   throws IOException

Description copied from interface: Encode

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

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 getValidMediaInputType() will be contentType.

Throws:

IOException