plume

Class CountingPrintWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

plume.CountingPrintWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class CountingPrintWriter
extends java.io.PrintWriter

Prints formatted representations of objects to a text-output stream counting the number of bytes and characters printed.

Methods in this class never throw I/O exceptions. The client may inquire as to whether any errors have occurred by invoking PrintWriter.checkError().

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CountingPrintWriter(java.io.OutputStream out) Create a new PrintWriter, without automatic line flushing, from an existing OutputStream.
CountingPrintWriter(java.io.OutputStream out, boolean autoFlush) Create a new PrintWriter from an existing OutputStream.
CountingPrintWriter(java.io.Writer out) Create a new PrintWriter, without automatic line flushing.
CountingPrintWriter(java.io.Writer out, boolean autoFlush) Create a new PrintWriter, without automatic line flushing.

Method Summary

Modifier and Type	Method and Description
int	countBytes(char c) Returns the number of bytes used to represent a character.
int	countBytes(java.lang.String s) Returns the number of bytes contained in a string.
int	getNumberOfPrintedBytes() Returns the total number of bytes printed using any of the 'print' or 'println' methods of this CountingPrintBuffer.
int	getNumberOfPrintedChars() Returns the total number of characters printed using any of the 'print' or 'println' methods of this CountingPrintBuffer.
int	getNumberOfWrittenBytes() Returns the total number of bytes printed using any of the 'write' methods of this CountingPrintBuffer.
void	print(boolean b) Print a boolean value.
void	print(char c) Print a character.
void	print(char[] s) Print an array of characters.
void	print(double d) Print a double-precision floating-point number.
void	print(float f) Print a floating-point number.
void	print(int i) Print an integer.
void	print(long l) Print a long integer.
void	print(java.lang.Object obj) Print an object.
void	print(java.lang.String s) Print a string.
void	println() Terminate the current line by writing the line separator string.
void	println(java.lang.String s) Print a String and then terminate the line.
void	resetAll() Resets all the byte and char counters.
void	resetPrintedByteCounter() Resets printedByte counter.
void	resetPrintedCharCounter() Resets printedChar counter.
void	resetWrittenByteCounter() Resets writtenByte counter.
void	resetWrittenCharCounter() Resets writtenChar counter.
void	write(char[] buf) Write an array of characters.
void	write(char[] buf, int off, int len) Write a portion of a character array.
void	write(java.lang.String s) Write a string.
void	write(java.lang.String s, int off, int len) Write a portion of a string.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, printf, printf, println, println, println, println, println, println, println, println, setError, write

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingPrintWriter

public CountingPrintWriter(java.io.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

CountingPrintWriter

public CountingPrintWriter(java.io.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 - if true, the println() methods will flush the output buffer

CountingPrintWriter

public CountingPrintWriter(java.io.Writer out)

Create a new PrintWriter, without automatic line flushing.

Parameters:

out - a Writer

CountingPrintWriter

public CountingPrintWriter(java.io.Writer out,
                           boolean autoFlush)

Create a new PrintWriter, without automatic line flushing.

Parameters:

out - a writer

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

Method Detail

countBytes

public int countBytes(java.lang.String s)

Returns the number of bytes contained in a string. If s is null, returns -1

Parameters:

s - the String for which to count bytes

Returns:

bytes in the string, or null

countBytes

public int countBytes(char c)

Returns the number of bytes used to represent a character.

Parameters:

c - a character

Returns:

number of bytes used to represent c

getNumberOfPrintedBytes

public int getNumberOfPrintedBytes()

Returns the total number of bytes printed using any of the 'print' or 'println' methods of this CountingPrintBuffer.

Returns:

number of bytes printed so far

getNumberOfWrittenBytes

public int getNumberOfWrittenBytes()

Returns the total number of bytes printed using any of the 'write' methods of this CountingPrintBuffer.

Returns:

number of bytes written so far

getNumberOfPrintedChars

public int getNumberOfPrintedChars()

Returns the total number of characters printed using any of the 'print' or 'println' methods of this CountingPrintBuffer.

Returns:

number of characters printed so far

print

public void print(java.lang.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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

s - the string to be printed, or null

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

b - the boolean to be printed

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

c - the char to be printed

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

s - the char[] to be printed

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

d - the double to be printed

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

f - the float to be printed

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

i - the int to be printed

resetAll

public void resetAll()

Resets all the byte and char counters.

resetPrintedByteCounter

public void resetPrintedByteCounter()

Resets printedByte counter.

resetPrintedCharCounter

public void resetPrintedCharCounter()

Resets printedChar counter.

resetWrittenByteCounter

public void resetWrittenByteCounter()

Resets writtenByte counter.

resetWrittenCharCounter

public void resetWrittenCharCounter()

Resets writtenChar counter.

print

public void 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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

l - the long to be printed

print

public void print(java.lang.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 PrintWriter.write(int) method.

Overrides:

print in class java.io.PrintWriter

Parameters:

obj - the object to be printed

println

public void 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').

When incrementing the byte count of PrintWriter, also accounts for the bytes needed to represent the line separator string.

Overrides:

println in class java.io.PrintWriter

println

public void println(java.lang.String s)

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

Overrides:

println in class java.io.PrintWriter

Parameters:

s - the string to be printed

write

public void write(char[] buf)

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

Overrides:

write in class java.io.PrintWriter

Parameters:

buf - the char[] to be printed

write

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

Write a portion of a character array.

Overrides:

write in class java.io.PrintWriter

Parameters:

buf - character array

off - offset from which to start writing characters

len - number of characters to write

write

public void write(java.lang.String s)

Write a string.

Overrides:

write in class java.io.PrintWriter

Parameters:

s - the string to be printed

write

public void write(java.lang.String s,
                  int off,
                  int len)

Write a portion of a string.

Overrides:

write in class java.io.PrintWriter

Parameters:

s - string to be printed

off - offset from which to start writing characters

len - number of characters to write