Module com.aoapps.encoding

Package com.aoapps.encoding

Class NoCloseMediaValidator

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.encoding.MediaValidator

com.aoapps.encoding.NoCloseMediaValidator

All Implemented Interfaces:

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

@ThreadSafe
public final class NoCloseMediaValidator
extends MediaValidator

Wraps a MediaValidator while doing nothing on FilterWriter.close().

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method	Description
NoCloseMediaValidator	append(char c)	The default implementation of this append method in Writer calls the write(int) method for backward-compatibility.
NoCloseMediaValidator	append(CharSequence csq)	The default implementation of this append method in Writer converts to a String for backward-compatibility.
NoCloseMediaValidator	append(CharSequence csq, int start, int end)	The default implementation of this append method in Writer converts to a String for backward-compatibility.
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.
void	close()	Does not close the wrapped validator.
Writer	getOut()	Gets the wrapped writer, which has been optimized: First, passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) (with encoder = null).
MediaType	getValidMediaInputType()	Gets the input type.
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.
void	validate(boolean trim)	Performs final validation and resets the validator for reuse.
static MediaValidator	wrap(MediaValidator out)	Returns out when it is already a MediaValidator.isNoClose(), otherwise returns a new NoCloseMediaValidator wrapping out.
static <W extends Writer & NoClose> W	wrap(Writer out)	Dispatches to wrap(com.aoapps.encoding.MediaValidator) when out is a MediaValidator, otherwise dispatches to NoCloseWriter.wrap(java.io.Writer).

Methods inherited from class com.aoapps.encoding.MediaValidator

getMediaValidator, getValidMediaOutputType, isBuffered

Methods inherited from class java.io.FilterWriter

flush, write, write, write

Methods inherited from class java.io.Writer

nullWriter, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

wrap

public static MediaValidator wrap(MediaValidator out)

Returns out when it is already a MediaValidator.isNoClose(), otherwise returns a new NoCloseMediaValidator wrapping out.

wrap

public static <W extends Writer & NoClose> W wrap(Writer out)

Dispatches to wrap(com.aoapps.encoding.MediaValidator) when out is a MediaValidator, otherwise dispatches to NoCloseWriter.wrap(java.io.Writer).

See Also:

• wrap(com.aoapps.encoding.MediaValidator)
• NoCloseWriter.wrap(java.io.Writer)

getValidMediaInputType

public MediaType getValidMediaInputType()

Description copied from interface: ValidMediaInput

Gets the input type.

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.

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.

Returns:

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

See Also:

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

getOut

public Writer getOut()

Gets the wrapped writer, which has been optimized: First, passed through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) (with encoder = null). Second, passed through wrap(java.io.Writer) when out is NoClose and NoClose.isNoClose().

Overrides:

getOut in class MediaValidator

Returns:

the wrapped writer passed through wrap(java.io.Writer) or wrap(com.aoapps.encoding.MediaValidator).

append

public NoCloseMediaValidator append(CharSequence csq)
                             throws IOException

Description copied from class: MediaValidator

The default implementation of this append method in Writer converts to a String for backward-compatibility. This passes the append directly to the wrapped Writer.

Specified by:

append in interface Appendable

Overrides:

append in class MediaValidator

Throws:

IOException

append

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

Description copied from class: MediaValidator

The default implementation of this append method in Writer converts to a String for backward-compatibility. This passes the append directly to the wrapped Writer.

Specified by:

append in interface Appendable

Overrides:

append in class MediaValidator

Throws:

IOException

append

public NoCloseMediaValidator append(char c)
                             throws IOException

Description copied from class: MediaValidator

The default implementation of this append method in Writer calls the write(int) method for backward-compatibility. This passes the append directly to the wrapped Writer.

Specified by:

append in interface Appendable

Overrides:

append in class MediaValidator

Throws:

IOException

validate

public void validate(boolean trim)
              throws IOException

Description copied from class: MediaValidator

Performs final validation and resets the validator for reuse.

Overrides:

validate in class MediaValidator

Parameters:

trim - Requests that the buffer be trimmed, if buffered and trim supported.

Throws:

IOException

isNoClose

public boolean isNoClose()

Specified by:

isNoClose in interface NoClose

Overrides:

isNoClose in class MediaValidator

Returns:

true since this is always no-close.

close

public void close()

Does not close the wrapped validator.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface NoClose

Overrides:

close in class FilterWriter