net.proteusframework.core.io

Class EntityUtilWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

net.proteusframework.core.io.EntityUtilWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class EntityUtilWriter
extends PrintWriter

PrintWriter with added methods for outputting entity encoded data.

Author:

Russ Tennant (russ@i2rd.com)

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
EntityUtilWriter(File file) Constructor.
EntityUtilWriter(File file, String csn) Constructor.
EntityUtilWriter(OutputStream output) Constructor.
EntityUtilWriter(OutputStream output, boolean autoFlush) Constructor.
EntityUtilWriter(String fileName) Constructor.
EntityUtilWriter(String fileName, String csn) Constructor.
EntityUtilWriter(Writer output) Constructor.
EntityUtilWriter(Writer output, boolean autoFlush) Constructor.

Method Summary

Modifier and Type	Method and Description
EntityUtilWriter	append(char c)
EntityUtilWriter	append(CharSequence csq)
EntityUtilWriter	append(CharSequence csq, int start, int end)
EntityUtilWriter	append(TextSource textSource, Object... args) Append the TextSource if setLocaleContext(LocaleContext) has been called.
EntityUtilWriter	appendEmptyTagClose() Print out close for an empty tag.
EntityUtilWriter	appendEscapedAttribute(CharSequence name, CharSequence value) Append an Attribute.
EntityUtilWriter	appendEscapedAttribute(String name, TextSource value, Object... args) Append the TextSource for Attribute.
EntityUtilWriter	appendEscapedData(CharSequence cdata) Append escaped character data.
EntityUtilWriter	appendEscapedData(TextSource textSource, Object... args) Append escaped TextSource.
EntityUtilWriter	appendEscapedDataWithBreak(CharSequence cdata) Append escaped character data with newlines converted to BR tags.
EntityUtilWriter	appendEscapedDataWithBreak(TextSource textSource, Object... args) Append escaped TextSource with newlines converted to BR tags.
EntityUtilWriter	appendHTMLAttribute(CharSequence name, CharSequence value) Append an HTML Attribute.
EntityUtilWriter	appendHTMLData(CharSequence cdata) Append HTML character data.
EntityUtilWriter	appendHTMLDataWithBreak(CharSequence cdata) Append HTML character data.
EntityUtilWriter	appendXHTMLData(CharSequence cdata) Append XHTML character data.
EntityUtilWriter	appendXHTMLDataWithBreak(CharSequence cdata) Append XHTML character data.
String	escapeAttribute(CharSequence characters) Escape characters for attributes.
String	escapeData(CharSequence characters) Escape characters for HTML/XHTML based on isXHTML().
String	escapeDataWithBreak(CharSequence characters) Escape characters for HTML/XHTML based on isXHTML() with newlines replaced with BR tags.
String	escapeHTML(CharSequence characters) Escape characters for HTML.
String	escapeHTMLWithBreak(CharSequence characters) Escape characters for HTML with newlines replaced with BR tags.
String	escapeXHTML(CharSequence characters) Escape characters for XHTML.
String	escapeXHTMLWithBreak(CharSequence characters) Escape characters for XHTML with newlines replaced with BR tags.
EntityUtilWriter	format(Locale l, String format, Object... args)
EntityUtilWriter	format(String format, Object... args)
EntityUtilWriter	formatEscapedData(CharSequence format, Object... args) Format XHTML character data.
EntityUtilWriter	formatEscapedDataWithBreak(CharSequence format, Object... args) Format XHTML character data.
EntityUtilWriter	formatHTMLData(CharSequence format, Object... args) Format HTML character data.
EntityUtilWriter	formatHTMLDataWithBreak(CharSequence format, Object... args) Format HTML character data.
EntityUtilWriter	formatXHTMLData(CharSequence format, Object... args) Format escaped character data.
EntityUtilWriter	formatXHTMLDataWithBreak(CharSequence format, Object... args) Format XHTML character data.
EntityUtil	getAttributeEscapeUtil() Get the attribute escaper used by the writer.
EntityUtil	getDataEscapeUtil() Get the data escaper used by the writer.
EntityUtil	getHTMLEscapeUtil() Get the HTML data escaper used by the writer.
Locale	getLocale() Get locale used for formatting..
LocaleContext	getLocaleContext() Get the locale context.
EntityUtil	getXHTMLEscapeUtil() Get the XHTML data escaper used by the writer.
boolean	isXHTML() Get the XHTML flag.
void	printEmptyTagClose() Print out close for an empty tag.
void	printEscapedAttribute(CharSequence name, CharSequence value) Print an Attribute.
void	printEscapedData(CharSequence cdata) Print escaped character data.
void	printEscapedDataWithBreak(CharSequence cdata) Print escaped character data.
void	printHTMLAttribute(CharSequence name, CharSequence value) Print an HTML Attribute.
void	printHTMLData(CharSequence cdata) Print HTML character data.
void	printHTMLDataWithBreak(CharSequence cdata) Print HTML character data.
void	printlnEmptyTagClose() Print out close for an empty tag.
void	printXHTMLData(CharSequence cdata) Print XHTML character data.
void	printXHTMLDataWithBreak(CharSequence cdata) Print XHTML character data.
void	setLocale(Locale locale) Set the locale used for formatting.
void	setLocaleContext(LocaleContext localeContext) Set the locale context to be used by methods that take a TextSource.
void	setXHTML(boolean xhtml) Set the XHTML.

Methods inherited from class java.io.PrintWriter

checkError, clearError, close, flush, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityUtilWriter

public EntityUtilWriter(File file)
                 throws FileNotFoundException

Constructor.

Parameters:

file - the file.

Throws:

FileNotFoundException - if the file is not found.

EntityUtilWriter

public EntityUtilWriter(File file,
                        String csn)
                 throws FileNotFoundException,
                        UnsupportedEncodingException

Constructor.

Parameters:

file - the file.

csn - character set name.

Throws:

FileNotFoundException - if the file isn't found.

UnsupportedEncodingException - if the character set is unsupported.

EntityUtilWriter

public EntityUtilWriter(OutputStream output)

Constructor.

Parameters:

output - the stream.

EntityUtilWriter

public EntityUtilWriter(OutputStream output,
                        boolean autoFlush)

Constructor.

Parameters:

output - the stream.

autoFlush - flush flag.

EntityUtilWriter

public EntityUtilWriter(String fileName)
                 throws FileNotFoundException

Constructor.

Parameters:

fileName - the file name.

Throws:

FileNotFoundException - if the file is not found.

EntityUtilWriter

public EntityUtilWriter(String fileName,
                        String csn)
                 throws FileNotFoundException,
                        UnsupportedEncodingException

Constructor.

Parameters:

fileName - the file name.

csn - character set name.

Throws:

FileNotFoundException - if the file isn't found.

UnsupportedEncodingException - if the character set is unsupported.

EntityUtilWriter

public EntityUtilWriter(Writer output)

Constructor.

Parameters:

output - the writer.

EntityUtilWriter

public EntityUtilWriter(Writer output,
                        boolean autoFlush)

Constructor.

Parameters:

output - the writer.

autoFlush - flush flag.

Method Detail

append

public EntityUtilWriter append(char c)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public EntityUtilWriter append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public EntityUtilWriter append(CharSequence csq,
                               int start,
                               int end)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public EntityUtilWriter append(@Nonnull
                               TextSource textSource,
                               @Nullable
                               Object... args)
                        throws IllegalStateException

Append the TextSource if setLocaleContext(LocaleContext) has been called.

Parameters:

textSource - the TextSource.

args - optional arguments.

Returns:

this.

Throws:

IllegalStateException - if the LocaleContext is not set.

appendEmptyTagClose

public EntityUtilWriter appendEmptyTagClose()

Print out close for an empty tag.

This will be either "/>" or ">". depending on isXHTML().

This is useful for empty tags like LINK, INPUT, etc.

Returns:

this writer.

appendEscapedAttribute

public EntityUtilWriter appendEscapedAttribute(CharSequence name,
                                               CharSequence value)

Append an Attribute. The data will be escaped according to isXHTML().

Parameters:

name - the name.

value - the value.

Returns:

the writer.

appendEscapedAttribute

public EntityUtilWriter appendEscapedAttribute(String name,
                                               TextSource value,
                                               @Nullable
                                               Object... args)
                                        throws IllegalStateException

Append the TextSource for Attribute. setLocaleContext(LocaleContext) must have been called.

Parameters:

name - the name.

value - the value.

args - optional arguments.

Returns:

this.

Throws:

IllegalStateException - if the LocaleContext is not set.

appendEscapedData

public EntityUtilWriter appendEscapedData(CharSequence cdata)

Append escaped character data. The data will be escaped according to isXHTML().

Parameters:

cdata - the character data.

Returns:

the writer.

appendEscapedData

public EntityUtilWriter appendEscapedData(@Nonnull
                                          TextSource textSource,
                                          @Nullable
                                          Object... args)
                                   throws IllegalStateException

Append escaped TextSource. setLocaleContext(LocaleContext) must have been called.

Parameters:

textSource - the TextSource.

args - optional arguments.

Returns:

this.

Throws:

IllegalStateException - if the LocaleContext is not set.

appendEscapedDataWithBreak

public EntityUtilWriter appendEscapedDataWithBreak(CharSequence cdata)

Append escaped character data with newlines converted to BR tags. The data will be escaped according to isXHTML().

Parameters:

cdata - the character data.

Returns:

the writer.

appendEscapedDataWithBreak

public EntityUtilWriter appendEscapedDataWithBreak(@Nonnull
                                                   TextSource textSource,
                                                   @Nullable
                                                   Object... args)
                                            throws IllegalStateException

Append escaped TextSource with newlines converted to BR tags. setLocaleContext(LocaleContext) must have been called.

Parameters:

textSource - the TextSource.

args - optional arguments.

Returns:

this.

Throws:

IllegalStateException - if the LocaleContext is not set.

appendHTMLAttribute

public EntityUtilWriter appendHTMLAttribute(CharSequence name,
                                            CharSequence value)

Append an HTML Attribute.

Parameters:

name - the name.

value - the value.

Returns:

the writer.

appendHTMLData

public EntityUtilWriter appendHTMLData(CharSequence cdata)

Append HTML character data. The data will be escaped.

Parameters:

cdata - the character data.

Returns:

the writer.

appendHTMLDataWithBreak

public EntityUtilWriter appendHTMLDataWithBreak(CharSequence cdata)

Append HTML character data. All newlines will be output as BR tags. The data will be escaped.

Parameters:

cdata - the character data.

Returns:

the writer.

appendXHTMLData

public EntityUtilWriter appendXHTMLData(CharSequence cdata)

Append XHTML character data. The data will be escaped.

Parameters:

cdata - the character data.

Returns:

the writer.

appendXHTMLDataWithBreak

public EntityUtilWriter appendXHTMLDataWithBreak(CharSequence cdata)

Append XHTML character data. All newlines will be output as BR tags. The data will be escaped.

Parameters:

cdata - the character data.

Returns:

the writer.

escapeAttribute

public String escapeAttribute(CharSequence characters)

Escape characters for attributes.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeData

public String escapeData(CharSequence characters)

Escape characters for HTML/XHTML based on isXHTML().

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeDataWithBreak

public String escapeDataWithBreak(CharSequence characters)

Escape characters for HTML/XHTML based on isXHTML() with newlines replaced with BR tags.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeHTML

public String escapeHTML(CharSequence characters)

Escape characters for HTML.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeHTMLWithBreak

public String escapeHTMLWithBreak(CharSequence characters)

Escape characters for HTML with newlines replaced with BR tags.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeXHTML

public String escapeXHTML(CharSequence characters)

Escape characters for XHTML.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

escapeXHTMLWithBreak

public String escapeXHTMLWithBreak(CharSequence characters)

Escape characters for XHTML with newlines replaced with BR tags.

This returns the escaped characters instead of writing them to the writer. This is useful when combined with other escaping before output via this writer.

Parameters:

characters - the characters.

Returns:

return the escaped string.

format

public EntityUtilWriter format(Locale l,
                               @Nonnull
                               String format,
                               @Nullable
                               Object... args)

Overrides:

format in class PrintWriter

format

public EntityUtilWriter format(@Nonnull
                               String format,
                               Object... args)

Overrides:

format in class PrintWriter

formatEscapedData

public EntityUtilWriter formatEscapedData(CharSequence format,
                                          Object... args)

Format XHTML character data. The format and arguments will be escaped. The data will be escaped according to isXHTML().

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

formatEscapedDataWithBreak

public EntityUtilWriter formatEscapedDataWithBreak(CharSequence format,
                                                   Object... args)

Format XHTML character data. All newlines will be output as BR tags. The format and arguments will be escaped. The data will be escaped according to isXHTML().

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

formatHTMLData

public EntityUtilWriter formatHTMLData(CharSequence format,
                                       Object... args)

Format HTML character data. The format and arguments will be escaped.

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

formatHTMLDataWithBreak

public EntityUtilWriter formatHTMLDataWithBreak(CharSequence format,
                                                Object... args)

Format HTML character data. All newlines will be output as BR tags. The format and arguments will be escaped.

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

formatXHTMLData

public EntityUtilWriter formatXHTMLData(CharSequence format,
                                        Object... args)

Format escaped character data. The format and arguments will be escaped.

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

formatXHTMLDataWithBreak

public EntityUtilWriter formatXHTMLDataWithBreak(CharSequence format,
                                                 Object... args)

Format XHTML character data. All newlines will be output as BR tags. The format and arguments will be escaped.

Parameters:

format - A format string as described in Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

the writer.

getAttributeEscapeUtil

public EntityUtil getAttributeEscapeUtil()

Get the attribute escaper used by the writer.

Returns:

the escape utility.

getDataEscapeUtil

public EntityUtil getDataEscapeUtil()

Get the data escaper used by the writer.

Returns:

the escape utility.

getHTMLEscapeUtil

public EntityUtil getHTMLEscapeUtil()

Get the HTML data escaper used by the writer.

Returns:

the escape utility.

getLocale

public Locale getLocale()

Get locale used for formatting..

Returns:

the locale. If not set, returns the default locale.

getLocaleContext

@Nullable
public LocaleContext getLocaleContext()

Get the locale context.

Returns:

the locale context

getXHTMLEscapeUtil

public EntityUtil getXHTMLEscapeUtil()

Get the XHTML data escaper used by the writer.

Returns:

the escape utility.

isXHTML

public boolean isXHTML()

Get the XHTML flag.

Returns:

the XHTML flag.

printEmptyTagClose

public void printEmptyTagClose()

Print out close for an empty tag.

This will be either "/>" or ">". depending on isXHTML().

This is useful for empty tags like LINK, INPUT, etc.

printEscapedAttribute

public void printEscapedAttribute(CharSequence name,
                                  CharSequence value)

Print an Attribute. The data will be escaped according to isXHTML().

Parameters:

name - the name.

value - the value.

printEscapedData

public void printEscapedData(CharSequence cdata)

Print escaped character data. The data will be escaped according to isXHTML().

Parameters:

cdata - the character data.

printEscapedDataWithBreak

public void printEscapedDataWithBreak(CharSequence cdata)

Print escaped character data. All newlines will be output as BR tags. The data will be escaped according to isXHTML().

Parameters:

cdata - the character data.

printHTMLAttribute

public void printHTMLAttribute(CharSequence name,
                               CharSequence value)

Print an HTML Attribute.

Parameters:

name - the name.

value - the value.

printHTMLData

public void printHTMLData(CharSequence cdata)

Print HTML character data. The data will be escaped.

Parameters:

cdata - the character data.

printHTMLDataWithBreak

public void printHTMLDataWithBreak(CharSequence cdata)

Print HTML character data. All newlines will be output as BR tags. The data will be escaped.

Parameters:

cdata - the character data.

printlnEmptyTagClose

public void printlnEmptyTagClose()

Print out close for an empty tag.

This will be either "/>" or ">". depending on isXHTML().

This is useful for empty tags like LINK, INPUT, etc.

printXHTMLData

public void printXHTMLData(CharSequence cdata)

Print XHTML character data. The data will be escaped.

Parameters:

cdata - the character data.

printXHTMLDataWithBreak

public void printXHTMLDataWithBreak(CharSequence cdata)

Print XHTML character data. All newlines will be output as BR tags. The data will be escaped.

Parameters:

cdata - the character data.

setLocale

public void setLocale(Locale locale)

Set the locale used for formatting.

Parameters:

locale - the locale.

setLocaleContext

public void setLocaleContext(LocaleContext localeContext)

Set the locale context to be used by methods that take a TextSource.

Parameters:

localeContext - the locale context.

setXHTML

public void setXHTML(boolean xhtml)

Set the XHTML.

Parameters:

xhtml - the XHTML flag.