Module com.aoapps.encoding

Package com.aoapps.encoding

Class TextInXhtmlEncoder

java.lang.Object

com.aoapps.encoding.MediaEncoder

com.aoapps.encoding.TextInXhtmlEncoder

All Implemented Interfaces:

ValidMediaFilter, ValidMediaInput, ValidMediaOutput, Encoder

@ThreadSafe
@Immutable
public final class TextInXhtmlEncoder
extends MediaEncoder

Encodes arbitrary text into XHTML. Minimal conversion is performed, just encoding of necessary values and throwing an IOException when any character is found that cannot be converted to XHTML entities.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final TextInXhtmlEncoder	textInXhtmlEncoder	Singleton instance intended for static import.

Method Summary

Modifier and Type	Method	Description
TextInXhtmlEncoder	append(char c, Appendable out)
TextInXhtmlEncoder	append(CharSequence csq, int start, int end, Appendable out)
TextInXhtmlEncoder	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.
static void	encodeTextInXhtml(char[] cbuf, int off, int len, Writer out)	See http://www.w3.org/TR/REC-xml/#charsets.
static void	encodeTextInXhtml(char[] cbuf, Writer out)	See http://www.w3.org/TR/REC-xml/#charsets.
static void	encodeTextInXhtml(char ch, Appendable out)	See http://www.w3.org/TR/REC-xml/#charsets.
static void	encodeTextInXhtml(CharSequence cs, int start, int end, Appendable out)	See http://www.w3.org/TR/REC-xml/#charsets.
static void	encodeTextInXhtml(CharSequence cs, Appendable out)	See http://www.w3.org/TR/REC-xml/#charsets.
static void	encodeTextInXhtml(Object value, Appendable out)	See http://www.w3.org/TR/REC-xml/#charsets.
MediaType	getValidMediaInputType()	Gets the input type.
MediaType	getValidMediaOutputType()	Gets the output type.
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)

Methods inherited from class com.aoapps.encoding.MediaEncoder

getInstance, writePrefixTo, writeSuffixTo, writeSuffixTo

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

isBuffered

Field Details

textInXhtmlEncoder

public static final TextInXhtmlEncoder textInXhtmlEncoder

Singleton instance intended for static import.

Method Details

encodeTextInXhtml

public static void encodeTextInXhtml(char ch,
 Appendable out)
                              throws IOException

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

encodeTextInXhtml

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

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

encodeTextInXhtml

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

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

encodeTextInXhtml

public static void encodeTextInXhtml(CharSequence cs,
 Appendable out)
                              throws IOException

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

encodeTextInXhtml

public static void encodeTextInXhtml(CharSequence cs,
 int start,
 int end,
 Appendable out)
                              throws IOException

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

encodeTextInXhtml

public static void encodeTextInXhtml(Object value,
 Appendable out)
                              throws IOException

See http://www.w3.org/TR/REC-xml/#charsets.

Throws:

IOException

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.

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 TextInXhtmlEncoder append(char c,
 Appendable out)
                          throws IOException

Specified by:

append in interface Encoder

Specified by:

append in class MediaEncoder

Throws:

IOException

append

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

Specified by:

append in interface Encoder

Specified by:

append in class MediaEncoder

Throws:

IOException

append

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