Module com.aoapps.encoding

Package com.aoapps.encoding

Class BufferedValidator

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.aoapps.encoding.MediaValidator

com.aoapps.encoding.BufferedValidator

All Implemented Interfaces:

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

Direct Known Subclasses:

UrlValidator

@ThreadSafe
public abstract class BufferedValidator
extends MediaValidator

Buffers the content to perform final validation.

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
final BufferedValidator	append(char c)	The default implementation of this append method in Writer calls the write(int) method for backward-compatibility.
final BufferedValidator	append(CharSequence csq)	The default implementation of this append method in Writer converts to a String for backward-compatibility.
final BufferedValidator	append(CharSequence csq, int start, int end)	The default implementation of this append method in Writer converts to a String for backward-compatibility.
final boolean	isBuffered()	Is this validator buffered?
final void	validate(boolean trim)	Performs final validation and clears the buffer for reuse.
final void	write(char[] cbuf)
final void	write(char[] cbuf, int off, int len)
final void	write(int c)
final void	write(String str)
final void	write(String str, int off, int len)

Methods inherited from class com.aoapps.encoding.MediaValidator

getMediaValidator, getOut, getValidMediaOutputType, isNoClose

Methods inherited from class java.io.FilterWriter

close, 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.lang.io.NoClose

close

Methods inherited from interface com.aoapps.encoding.ValidMediaInput

canSkipValidation, getValidMediaInputType, isValidatingMediaInputType

Method Details

isBuffered

public final boolean isBuffered()

Is this validator buffered? A buffered validator may delay validation until MediaValidator.validate(boolean). Furthermore, a buffered validator should not be bypassed before any buffered data has been written via MediaValidator.validate(boolean). An example of encoder bypassing is performing direct output on the writer from EncoderWriter.getOut().

Overrides:

isBuffered in class MediaValidator

Returns:

true since buffered

See Also:

• Encoder.isBuffered()
• BufferedEncoder.isBuffered()
• ValidateOnlyEncoder.isBuffered()
• isBuffered()
• EncoderWriter.getOut()
• EncoderWriter.getOut()

write

public final void write(int c)

Overrides:

write in class FilterWriter

write

public final void write(char[] cbuf)

Overrides:

write in class Writer

write

public final void write(char[] cbuf,
 int off,
 int len)

Overrides:

write in class FilterWriter

write

public final void write(String str)

Overrides:

write in class Writer

write

public final void write(String str,
 int off,
 int len)

Overrides:

write in class FilterWriter

append

public final BufferedValidator append(char c)

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

append

public final BufferedValidator append(CharSequence csq)

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

append

public final BufferedValidator append(CharSequence csq,
 int start,
 int end)

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

validate

public final void validate(boolean trim)
                    throws IOException

Performs final validation and clears the buffer for reuse.

Overrides:

validate in class MediaValidator

Parameters:

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

Throws:

IOException