bradleyross.library.helpers

Class GenericPrinter

java.lang.Object

bradleyross.library.helpers.GenericPrinter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class GenericPrinter
extends Object
implements Appendable, Closeable, Flushable

Allows a single set of code to output results to StringWriter, PrintStream and PrintWriter objects by providing a common wrapper.

PrintStream and PrintWriter implement Closeable, Flushable, and Appendable. The method names and parameter types used by these methods are the same as those in the PrintStream and PrintWriter classes.

StringWriter is first encapsulated in a PrintWriter to enable it to be used as an output device.

Author:

Bradley Ross

See Also:

PrintStream, PrintWriter, StringWriter

Field Summary

Fields

Modifier and Type	Field and Description
(package private) PrintStream	stream PrintStream object.
(package private) Object	underlying PrintStream, PrintWriter, or StringWriter object that was used in the constructor.
(package private) PrintWriter	writer PrintWriter object.

Constructor Summary

Constructors

Constructor and Description
GenericPrinter(PrintStream value) Create printer for PrintStream object.
GenericPrinter(PrintWriter value) Create printer for PrintWriter object
GenericPrinter(StringWriter value) Create printer for StringWriter object.

Method Summary

Methods

Modifier and Type	Method and Description
Appendable	append(char c) Append a character.
Appendable	append(CharSequence csq) Append a character sequence to the output stream.
Appendable	append(CharSequence csq, int start, int end) Append a subsequence of the specified character sequence to the output stream.
boolean	checkError() Checks if an error has occurred on the output stream.
void	close() Close the output stream.
void	flush() Flush the output stream.
Object	getUnderlyingObject() Return the underlying StringWriter, PrintStream or PrintWriter object for the GenericPrinter object.
static void	main(String[] args) Test driver.
void	print(boolean value) Print a boolean value.
void	print(char c) Print a character.
void	print(char[] c) Print an array of characters.
void	print(double value) Print a double-precision floating-point number.
void	print(float value) Print a floating-point number.
void	print(int value) Print an integer value.
void	print(long value) Print a long integer value.
void	print(String value) Print string.
void	println() Terminate the line.
void	println(boolean value) Print a boolean value and then terminate the line.
void	println(char c) Print a character and terminate the line.
void	println(char[] c) Print an array of characters and then terminate the line.
void	println(double value) Print a double-precision floating-point number and then terminate the line.
void	println(float value) Print a floating-point number and then terminate the line.
void	println(int value) Print an integer value and then terminate the line.
void	println(long value) Print a long integer value and then terminate the line.
void	println(String value) Print string and then terminate the line.
void	write(int n) Place a byte containing the specified value to the stream.

Methods inherited from class java.lang.Object

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

Field Detail

writer

PrintWriter writer

PrintWriter object.

See Also:

PrintWriter

stream

PrintStream stream

PrintStream object.

See Also:

PrintStream

underlying

Object underlying

PrintStream, PrintWriter, or StringWriter object that was used in the constructor.

Constructor Detail

GenericPrinter

public GenericPrinter(PrintWriter value)

Create printer for PrintWriter object

Parameters:

value - PrintWriter object

See Also:

PrintWriter

GenericPrinter

public GenericPrinter(PrintStream value)

Create printer for PrintStream object.

Parameters:

value - PrintStream object

GenericPrinter

public GenericPrinter(StringWriter value)

Create printer for StringWriter object.

Parameters:

value - StringWriter object.

Method Detail

getUnderlyingObject

public Object getUnderlyingObject()

Return the underlying StringWriter, PrintStream or PrintWriter object for the GenericPrinter object.

Returns:

Underlying object

checkError

public boolean checkError()

Checks if an error has occurred on the output stream.

Returns:

True if an error has occurred

See Also:

PrintStream.checkError(), PrintWriter.checkError()

write

public void write(int n)

Place a byte containing the specified value to the stream.

Parameters:

n - Value of byte to be written.

See Also:

PrintStream.write(int), PrintWriter.write(int)

println

public void println(String value)

Print string and then terminate the line.

Parameters:

value - String to be printed

See Also:

PrintStream.println(String), PrintWriter.println(String)

print

public void print(String value)

Print string.

Parameters:

value - String to be printed

See Also:

PrintStream.print(String), PrintWriter.print(String)

print

public void print(char c)

Print a character.

Parameters:

c - Character to be printed

See Also:

PrintStream.print(char), PrintWriter.print(char)

println

public void println(char c)

Print a character and terminate the line.

Parameters:

c - Character to be printed

See Also:

PrintStream.println(String), PrintWriter.println(String)

print

public void print(char[] c)

Print an array of characters.

Parameters:

c - Character to be printed

See Also:

PrintStream.print(char[]), PrintWriter.print(char[])

println

public void println(char[] c)

Print an array of characters and then terminate the line.

Parameters:

c - Character to be printed

See Also:

PrintStream.println(char[]), PrintWriter.println(char[])

println

public void println()

Terminate the line.

See Also:

PrintStream.println(), PrintWriter.println()

append

public Appendable append(char c)

Append a character.

Specified by:

append in interface Appendable

Returns:

PrintStream or PrintWriter object

See Also:

PrintStream.append(char), PrintWriter.append(char)

append

public Appendable append(CharSequence csq)

Append a character sequence to the output stream.

Specified by:

append in interface Appendable

Parameters:

csq - The character sequence to be be appended.

See Also:

PrintStream.append(CharSequence), PrintWriter.append(CharSequence)

append

public Appendable append(CharSequence csq,
                int start,
                int end)
                  throws IndexOutOfBoundsException

Append a subsequence of the specified character sequence to the output stream.

Specified by:

append in interface Appendable

Parameters:

csq - The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".

start - The index of the first character in the subsequence

end - The index of the character following the last character in the subsequence

Throws:

IndexOutOfBoundsException

See Also:

PrintStream.append(CharSequence,int,int), PrintWriter.append(CharSequence, int, int)

close

public void close()

Close the output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

See Also:

PrintStream.close(), PrintWriter.close()

flush

public void flush()

Flush the output stream.

Specified by:

flush in interface Flushable

See Also:

PrintStream.flush(), PrintWriter.flush()

print

public void print(int value)

Print an integer value.

Parameters:

value - integer value to be printed

See Also:

Integer.toString(int), PrintStream.print(int), PrintWriter.print(int)

println

public void println(int value)

Print an integer value and then terminate the line.

Parameters:

value - integer value to be printed

See Also:

Integer.toString(int), PrintStream.println(int), PrintWriter.println(int)

print

public void print(long value)

Print a long integer value.

Parameters:

value - long integer value to be printed

See Also:

Long.toString(long), PrintStream.println(long), PrintWriter.println(long)

println

public void println(long value)

Print a long integer value and then terminate the line.

Parameters:

value - long integer value to be printed

See Also:

Long.toString(long), PrintStream.println(long), PrintWriter.println(long)

print

public void print(boolean value)

Print a boolean value.

Parameters:

value - boolean value to be printed

See Also:

Boolean.toString(boolean), PrintStream.print(boolean), PrintWriter.print(boolean)

println

public void println(boolean value)

Print a boolean value and then terminate the line.

Parameters:

value - Boolean value to be printed

See Also:

Boolean.toString(boolean), PrintStream.println(boolean), PrintWriter.println(boolean)

print

public void print(double value)

Print a double-precision floating-point number.

Parameters:

value - Double-precision floating-point number to be printed

See Also:

PrintStream.print(double), PrintWriter.print(double)

println

public void println(double value)

Print a double-precision floating-point number and then terminate the line.

Parameters:

value - Double-precision floating-point number to be printed

See Also:

PrintStream.println(double), PrintWriter.println(double)

print

public void print(float value)

Print a floating-point number.

Parameters:

value - Floating-point number to be printed

See Also:

PrintStream.println(float), PrintWriter.println(float)

println

public void println(float value)

Print a floating-point number and then terminate the line.

Parameters:

value - Floating-point number to be printed

See Also:

PrintStream.println(float), PrintWriter.println(float)

main

public static void main(String[] args)

Test driver.

Parameters:

args - Not used