Module com.aoapps.encoding

Package com.aoapps.encoding

Class ValidateOnlyEncoder

java.lang.Object

com.aoapps.encoding.MediaEncoder

com.aoapps.encoding.ValidateOnlyEncoder

All Implemented Interfaces:

ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Encoder

@ThreadSafe
public class ValidateOnlyEncoder
extends MediaEncoder

Passes through all characters unaltered after validating with the given validator. This is useful when an encoder is needed for API requirements (such as required for MediaWriter), despite no character encoding needed.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
ValidateOnlyEncoder(MediaType contentType)	Writes through to the correct validator for the given content type, then discards all output.
ValidateOnlyEncoder(MediaValidator validator)	Writes through to the given validator.

Method Summary

Modifier and Type	Method	Description
ValidateOnlyEncoder	append(char c, Appendable out)
ValidateOnlyEncoder	append(CharSequence csq, int start, int end, Appendable out)
ValidateOnlyEncoder	append(CharSequence csq, Appendable out)
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.
MediaType	getValidMediaInputType()	Gets the input type.
MediaType	getValidMediaOutputType()	Gets the output type.
final boolean	isBuffered()
boolean	isValidatingMediaInputType(MediaType inputType)	Checks if this is validating the provided type, which allows one validator to be substituted in place of another.
void	write(char[] cbuf, int off, int len, Writer out)
void	write(char[] cbuf, Writer out)
void	write(int c, Writer out)
void	write(String str, int off, int len, Writer out)
void	write(String str, Writer out)
void	writeSuffixTo(Appendable out, boolean trim)

Methods inherited from class com.aoapps.encoding.MediaEncoder

getInstance, writePrefixTo, writeSuffixTo

Methods inherited from class java.lang.Object

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

Constructor Details

ValidateOnlyEncoder

public ValidateOnlyEncoder(MediaValidator validator)

Writes through to the given validator.

ValidateOnlyEncoder

public ValidateOnlyEncoder(MediaType contentType)

Writes through to the correct validator for the given content type, then discards all output.

See Also:

• MediaValidator.getMediaValidator(com.aoapps.encoding.MediaType, java.io.Writer)
• NullWriter.getInstance()

Method Details

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)

getValidMediaOutputType

public MediaType getValidMediaOutputType()

Description copied from interface: ValidMediaOutput

Gets the output type.

isBuffered

public final boolean isBuffered()

Returns:

The result of MediaValidator.isBuffered()

write

public void write(int c,
 Writer out)
           throws IOException

Specified by:

write in interface Encoder

Specified by:

write in class MediaEncoder

Throws:

IOException

write

public void write(char[] cbuf,
 Writer out)
           throws IOException

Specified by:

write in interface Encoder

Specified by:

write in class MediaEncoder

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len,
 Writer out)
           throws IOException

Specified by:

write in interface Encoder

Specified by:

write in class MediaEncoder

Throws:

IOException

write

public void write(String str,
 Writer out)
           throws IOException

Specified by:

write in interface Encoder

Specified by:

write in class MediaEncoder

Throws:

IOException

write

public void write(String str,
 int off,
 int len,
 Writer out)
           throws IOException

Specified by:

write in interface Encoder

Specified by:

write in class MediaEncoder

Throws:

IOException

append

public ValidateOnlyEncoder append(char c,
 Appendable out)
                           throws IOException

Specified by:

append in interface Encoder

Specified by:

append in class MediaEncoder

Throws:

IOException

append

public ValidateOnlyEncoder append(CharSequence csq,
 Appendable out)
                           throws IOException

Specified by:

append in interface Encoder

Specified by:

append in class MediaEncoder

Throws:

IOException

append

public ValidateOnlyEncoder append(CharSequence csq,
 int start,
 int end,
 Appendable out)
                           throws IOException

Specified by:

append in interface Encoder

Specified by:

append in class MediaEncoder

Throws:

IOException

writeSuffixTo

public void writeSuffixTo(Appendable out,
 boolean trim)
                   throws IOException

Description copied from class: MediaEncoder

This default implementation validates media types in assertion but writes nothing.

Specified by:

writeSuffixTo in interface Encoder

Overrides:

writeSuffixTo in class MediaEncoder

Throws:

IOException