Module com.aoapps.encoding

Package com.aoapps.encoding

Class ChainWriter

java.lang.Object

com.aoapps.encoding.ChainWriter

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable

@ThreadSafe
public final class ChainWriter
extends Object
implements Appendable, Closeable

A chain writer encapsulates a PrintWriter and returns the ChainWriter instance on most methods. This gives the ability to call code like out.print("Hi ").print(name).print('!');

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
ChainWriter(EncodingContext encodingContext, OutputStream out)	Create a new PrintWriter, without automatic line flushing, from an existing OutputStream.
ChainWriter(EncodingContext encodingContext, OutputStream out, boolean autoFlush)	Create a new PrintWriter from an existing OutputStream.
ChainWriter(EncodingContext encodingContext, PrintWriter out)
ChainWriter(EncodingContext encodingContext, Writer out)	Create a new PrintWriter, if needed, without automatic line flushing.
ChainWriter(EncodingContext encodingContext, Writer out, boolean autoFlush)	Create a new PrintWriter, if needed.
ChainWriter(OutputStream out)	Deprecated. Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.OutputStream)
ChainWriter(OutputStream out, boolean autoFlush)	Deprecated. Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.OutputStream, boolean)
ChainWriter(PrintWriter out)	Deprecated. Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.PrintWriter)
ChainWriter(Writer out)	Deprecated. Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.Writer)
ChainWriter(Writer out, boolean autoFlush)	Deprecated. Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.Writer, boolean)

Method Summary

Modifier and Type	Method	Description
ChainWriter	append(char c)
ChainWriter	append(CharSequence csq)
ChainWriter	append(CharSequence csq, int start, int end)
void	close()	Closes the stream.
ChainWriter	encodeHtml(Object value, boolean isXhtml)	Deprecated. the effects of makeBr and makeNbsp should be handled by CSS white-space property.
ChainWriter	encodeHtml(Object value, boolean makeBr, boolean makeNbsp, boolean isXhtml)	Deprecated. the effects of makeBr and makeNbsp should be handled by CSS white-space property.
ChainWriter	flush()	Flushes the stream.
ChainWriter	format(String format, Object... args)
ChainWriter	format(Locale l, String format, Object... args)
EncodingContext	getEncodingContext()
PrintWriter	getPrintWriter()
ChainWriter	print(boolean b)	Print a boolean value.
ChainWriter	print(char c)	Print a character.
ChainWriter	print(char[] s)	Print an array of characters.
ChainWriter	print(double d)	Print a double-precision floating-point number.
ChainWriter	print(float f)	Print a floating-point number.
ChainWriter	print(int i)	Print an integer.
ChainWriter	print(long l)	Print a long integer.
ChainWriter	print(Object obj)	Print an object.
ChainWriter	print(String s)	Print a string.
ChainWriter	printf(String format, Object... args)
ChainWriter	printf(Locale l, String format, Object... args)
ChainWriter	println()	Terminate the current line by writing the line separator string.
ChainWriter	println(boolean x)	Print a boolean value and then terminate the line.
ChainWriter	println(char x)	Print a character and then terminate the line.
ChainWriter	println(char[] x)	Print an array of characters and then terminate the line.
ChainWriter	println(double x)	Print a double-precision floating-point number and then terminate the line.
ChainWriter	println(float x)	Print a floating-point number and then terminate the line.
ChainWriter	println(int x)	Print an integer and then terminate the line.
ChainWriter	println(long x)	Print a long integer and then terminate the line.
ChainWriter	println(Object x)	Print an Object and then terminate the line.
ChainWriter	println(String x)	Print a String and then terminate the line.
ChainWriter	textInJavascript(Object value)	Encodes a javascript string.
ChainWriter	textInJavascriptInXhtml(Object value)	Encodes a javascript string for use in an XML body CDATA context.
ChainWriter	textInJavascriptInXmlAttribute(Object value)	Encodes a javascript string for use in an XML attribute context.
ChainWriter	textInMysql(Object value)	Encodes a MySQL string.
ChainWriter	textInPsql(Object value)	Encodes a psql string.
ChainWriter	textInSh(Object value)	Encodes a sh string.
ChainWriter	textInXhtml(Object value)
ChainWriter	textInXmlAttribute(Object value)
ChainWriter	write(char[] buf)	Write an array of characters.
ChainWriter	write(char[] buf, int off, int len)	Write a portion of an array of characters.
ChainWriter	write(int c)	Write a single character.
ChainWriter	write(String s)	Write a string.
ChainWriter	write(String s, int off, int len)	Write a portion of a string.
ChainWriter	writeHtmlColor(int color)	Prints a color in HTML format #xxxxxx, where xxxxxx is the hex code.
static void	writeHtmlColor(int color, Appendable out)	Prints a color in HTML format #xxxxxx, where xxxxxx is the hex code.

Methods inherited from class java.lang.Object

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

Constructor Details

ChainWriter

public ChainWriter(EncodingContext encodingContext,
 OutputStream out)

Create a new PrintWriter, without automatic line flushing, from an existing OutputStream. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the default character encoding.

Parameters:

out - An output stream

ChainWriter

@Deprecated
public ChainWriter(OutputStream out)

Deprecated.

Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.OutputStream)

See Also:

• EncodingContext.DEFAULT

ChainWriter

public ChainWriter(EncodingContext encodingContext,
 OutputStream out,
 boolean autoFlush)

Create a new PrintWriter from an existing OutputStream. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the default character encoding.

Parameters:

out - An output stream

autoFlush - A boolean; if true, the println() methods will flush the output buffer

ChainWriter

@Deprecated
public ChainWriter(OutputStream out,
 boolean autoFlush)

Deprecated.

Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.OutputStream, boolean)

See Also:

• EncodingContext.DEFAULT

ChainWriter

public ChainWriter(EncodingContext encodingContext,
 PrintWriter out)

ChainWriter

@Deprecated
public ChainWriter(PrintWriter out)

Deprecated.

Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.PrintWriter)

See Also:

• EncodingContext.DEFAULT

ChainWriter

public ChainWriter(EncodingContext encodingContext,
 Writer out)

Create a new PrintWriter, if needed, without automatic line flushing.

When out is already a PrintWriter, it is used directly, regardless of autoFlush settings.

Parameters:

out - A character-output stream

ChainWriter

@Deprecated
public ChainWriter(Writer out)

Deprecated.

Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.Writer)

See Also:

• EncodingContext.DEFAULT

ChainWriter

public ChainWriter(EncodingContext encodingContext,
 Writer out,
 boolean autoFlush)

Create a new PrintWriter, if needed.

When out is already a PrintWriter, it is used directly, regardless of autoFlush settings.

Parameters:

out - A character-output stream

autoFlush - A boolean; if true, the println() methods will flush the output buffer

ChainWriter

@Deprecated
public ChainWriter(Writer out,
 boolean autoFlush)

Deprecated.

Please use ChainWriter(com.aoapps.encoding.EncodingContext, java.io.Writer, boolean)

See Also:

• EncodingContext.DEFAULT

Method Details

getEncodingContext

public EncodingContext getEncodingContext()

getPrintWriter

public PrintWriter getPrintWriter()

flush

public ChainWriter flush()
                  throws IOException

Flushes the stream.

Unlike PrintWriter.flush(), exceptions are thrown immediately, as requiring the caller to remember to invoke PrintWriter.checkError() too easily leads to swallowed exceptions and hard-to-diagnose runtime problems.

Throws:

IOException

close

public void close()
           throws IOException

Closes the stream.

Unlike PrintWriter.close(), exceptions are thrown immediately, as requiring the caller to remember to invoke PrintWriter.checkError() too easily leads to swallowed exceptions and hard-to-diagnose runtime problems.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

write

public ChainWriter write(int c)

Write a single character.

write

public ChainWriter write(char[] buf,
 int off,
 int len)

Write a portion of an array of characters.

write

public ChainWriter write(char[] buf)

Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

write

public ChainWriter write(String s,
 int off,
 int len)

Write a portion of a string.

write

public ChainWriter write(String s)

Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

print

public ChainWriter print(boolean b)

Print a boolean value. The string produced by String.valueOf(boolean) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

b - The boolean to be printed

print

public ChainWriter print(char c)

Print a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

c - The char to be printed

print

public ChainWriter print(int i)

Print an integer. The string produced by String.valueOf(int) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

i - The int to be printed

See Also:

• Integer.toString(int)

print

public ChainWriter print(long l)

Print a long integer. The string produced by String.valueOf(long) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

l - The long to be printed

print

public ChainWriter print(float f)

Print a floating-point number. The string produced by String.valueOf(float) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

f - The float to be printed

See Also:

• Float.toString(float)

print

public ChainWriter print(double d)

Print a double-precision floating-point number. The string produced by String.valueOf(double) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

d - The double to be printed

print

public ChainWriter print(char[] s)

Print an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

s - The array of chars to be printed

Throws:

NullPointerException - If s is null

print

public ChainWriter print(String s)

Print a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

s - The String to be printed

print

public ChainWriter print(Object obj)

Print an object. The string produced by the String.valueOf(Object) method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:

obj - The Object to be printed

See Also:

• Object.toString()

println

public ChainWriter println()

Terminate the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').

println

public ChainWriter println(boolean x)

Print a boolean value and then terminate the line. This method behaves as though it invokes print(boolean) and then println().

println

public ChainWriter println(char x)

Print a character and then terminate the line. This method behaves as though it invokes print(char) and then println().

println

public ChainWriter println(int x)

Print an integer and then terminate the line. This method behaves as though it invokes print(int) and then println().

println

public ChainWriter println(long x)

Print a long integer and then terminate the line. This method behaves as though it invokes print(long) and then println().

println

public ChainWriter println(float x)

Print a floating-point number and then terminate the line. This method behaves as though it invokes print(float) and then println().

println

public ChainWriter println(double x)

Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes print(double) and then println().

println

public ChainWriter println(char[] x)

Print an array of characters and then terminate the line. This method behaves as though it invokes print(char[]) and then println().

println

public ChainWriter println(String x)

Print a String and then terminate the line. This method behaves as though it invokes print(String) and then println().

println

public ChainWriter println(Object x)

Print an Object and then terminate the line. This method behaves as though it invokes print(Object) and then println().

printf

public ChainWriter printf(String format,
 Object... args)

printf

public ChainWriter printf(Locale l,
 String format,
 Object... args)

format

public ChainWriter format(String format,
 Object... args)

format

public ChainWriter format(Locale l,
 String format,
 Object... args)

append

public ChainWriter append(CharSequence csq)

Specified by:

append in interface Appendable

append

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

Specified by:

append in interface Appendable

append

public ChainWriter append(char c)

Specified by:

append in interface Appendable

textInXmlAttribute

public ChainWriter textInXmlAttribute(Object value)
                               throws IOException

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInXhtmlAttributeEncoder
• Coercion.write(java.lang.Object, com.aoapps.lang.io.Encoder, java.io.Writer, boolean)

textInXhtml

public ChainWriter textInXhtml(Object value)
                        throws IOException

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInXhtmlEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

encodeHtml

@Deprecated
public ChainWriter encodeHtml(Object value,
 boolean isXhtml)
                       throws IOException

Deprecated.

the effects of makeBr and makeNbsp should be handled by CSS white-space property.

Escapes HTML for displaying in browsers and writes to the internal PrintWriter. Has makeBr and makeNbsp enabled.

Parameters:

value - the string to be escaped.

Throws:

IOException

See Also:

• textInXhtml(java.lang.Object)

encodeHtml

@Deprecated
public ChainWriter encodeHtml(Object value,
 boolean makeBr,
 boolean makeNbsp,
 boolean isXhtml)
                       throws IOException

Deprecated.

the effects of makeBr and makeNbsp should be handled by CSS white-space property.

Escapes HTML for displaying in browsers and writes to the internal PrintWriter.

Parameters:

value - the string to be escaped.

makeBr - will write <br /> tags for every newline character

makeNbsp - will write &#160; for a space when another space follows

Throws:

IOException

See Also:

• textInXhtml(java.lang.Object)

textInJavascript

public ChainWriter textInJavascript(Object value)
                             throws IOException

Encodes a javascript string. Quotes ("…") are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInJavaScriptEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

textInJavascriptInXmlAttribute

public ChainWriter textInJavascriptInXmlAttribute(Object value)
                                           throws IOException

Encodes a javascript string for use in an XML attribute context. Quotes ("…") are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInJavaScriptEncoder
• JavaScriptInXhtmlAttributeEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

textInJavascriptInXhtml

public ChainWriter textInJavascriptInXhtml(Object value)
                                    throws IOException

Encodes a javascript string for use in an XML body CDATA context. Quotes ("…") are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInJavaScriptEncoder
• JavaScriptInXhtmlEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

textInMysql

public ChainWriter textInMysql(Object value)
                        throws IOException

Encodes a MySQL string. E'…' quotes are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInMysqlEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

textInPsql

public ChainWriter textInPsql(Object value)
                       throws IOException

Encodes a psql string. E'…' quotes are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInPsqlEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

textInSh

public ChainWriter textInSh(Object value)
                     throws IOException

Encodes a sh string. $'…' quotes are added around the string. Also, if the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

Parameters:

value - the value to be encoded

Throws:

IOException

See Also:

• TextInShEncoder
• MarkupCoercion.write(java.lang.Object, com.aoapps.util.i18n.MarkupType, boolean, com.aoapps.lang.io.Encoder, boolean, java.io.Writer, boolean)

writeHtmlColor

public static void writeHtmlColor(int color,
 Appendable out)
                           throws IOException

Prints a color in HTML format #xxxxxx, where xxxxxx is the hex code.

Throws:

IOException

writeHtmlColor

public ChainWriter writeHtmlColor(int color)
                           throws IOException

Prints a color in HTML format #xxxxxx, where xxxxxx is the hex code.

Throws:

IOException