Class PrintWriter

protected Writer out

This is the underlying Writer we are sending output to

public PrintWriter(File file)
            throws FileNotFoundException

This initializes a new PrintWriter object to write to the specified file. It creates a FileOutputStream object and wraps it in an OutputStreamWriter using the default encoding.

Parameters:

file - the file to write to

Throws:

FileNotFoundException - if the file cannot be written or created

Since:

1.5

public PrintWriter(File file,
                   String enc)
            throws FileNotFoundException,
                   UnsupportedEncodingException

This initializes a new PrintWriter object to write to the specified file. It creates a FileOutputStream object and wraps it in an OutputStreamWriter using the specified encoding.

Parameters:

file - the file to write to

enc - the encoding to use

Throws:

FileNotFoundException - if the file cannot be written or created

UnsupportedEncodingException - if the encoding is not supported

Since:

1.5

public PrintWriter(OutputStream out)

This method initializes a new PrintWriter object to write to the specified OutputStream. Characters will be converted to chars using the system default encoding. Auto-flush functionality will not be enabled.

Parameters:

out - The OutputStream to write to

public PrintWriter(OutputStream out,
                   boolean autoflush)

This method initializes a new PrintWriter object to write to the specified OutputStream. Characters will be converted to chars using the system default encoding. This form of the constructor allows auto-flush functionality to be enabled if desired

Parameters:

out - The OutputStream to write to

autoflush - true to flush the stream after every println call, false otherwise.

public PrintWriter(Writer wr)

This method intializes a new PrintWriter object to write to the specified output sink. The form of the constructor does not enable auto-flush functionality.

Parameters:

wr - The Writer to write to.

public PrintWriter(Writer wr,
                   boolean autoflush)

This method intializes a new PrintWriter object to write to the specified output sink. This constructor also allows "auto-flush" functionality to be specified where the stream will be flushed after every line is terminated or newline character is written.

Parameters:

wr - The Writer to write to.

autoflush - true to flush the stream after every line, false otherwise

public PrintWriter(String file)
            throws FileNotFoundException

This initializes a new PrintWriter object to write to the specified file. It creates a FileOutputStream object and wraps it in an OutputStreamWriter using the default encoding.

Parameters:

file - name of the file to write to

Throws:

FileNotFoundException - if the file cannot be written or created

Since:

1.5

public PrintWriter(String file,
                   String enc)
            throws FileNotFoundException,
                   UnsupportedEncodingException

This initializes a new PrintWriter object to write to the specified file. It creates a FileOutputStream object and wraps it in an OutputStreamWriter using the specified encoding.

Parameters:

file - name of the file to write to

enc - the encoding to use

Throws:

FileNotFoundException - if the file cannot be written or created

UnsupportedEncodingException - if the encoding is not supported

Since:

1.5

public PrintWriter append(char c)

Specified by:

append in interface Appendable

Overrides:

append in interface Writer

Since:

1.5

public PrintWriter append(CharSequence cs)

Specified by:

append in interface Appendable

Overrides:

append in interface Writer

Since:

1.5

public PrintWriter append(CharSequence cs,
                          int start,
                          int end)

Specified by:

append in interface Appendable

Overrides:

append in interface Writer

Since:

1.5

public boolean checkError()

This method checks to see if an error has occurred on this stream. Note that once an error has occurred, this method will continue to report true forever for this stream. Before checking for an error condition, this method flushes the stream.

Returns:

true if an error has occurred, false otherwise

public void close()

This method closes this stream and all underlying streams.

Specified by:

close in interface Closeable

close in interface AutoCloseable

Overrides:

close in interface Writer

public void flush()

This method flushes any buffered chars to the underlying stream and then flushes that stream as well.

Specified by:

flush in interface Flushable

Overrides:

flush in interface Writer

public PrintWriter format(String format,
                          java.lang.Object... args)

Since:

1.5

public PrintWriter format(Locale locale,
                          String format,
                          java.lang.Object... args)

Since:

1.5

public void print(boolean bool)

This methods prints a boolean value to the stream. true values are printed as "true" and false values are printed as "false".

Parameters:

bool - The boolean value to print

public void print(char ch)

This method prints a char to the stream. The actual value printed is determined by the character encoding in use.

Parameters:

ch - The char value to be printed

public void print(char[] charArray)

This method prints an array of characters to the stream. The actual value printed depends on the system default encoding.

Parameters:

charArray - The array of characters to print.

public void print(double dnum)

This method prints a double to the stream. The value printed is determined using the String.valueOf() method.

Parameters:

dnum - The double value to be printed

public void print(float fnum)

This method prints a float to the stream. The value printed is determined using the String.valueOf() method.

Parameters:

fnum - The float value to be printed

public void print(int inum)

This method prints an integer to the stream. The value printed is determined using the String.valueOf() method.

Parameters:

inum - The int value to be printed

public void print(Object obj)

This method prints an Object to the stream. The actual value printed is determined by calling the String.valueOf() method.

Parameters:

obj - The Object to print.

public void print(String str)

This method prints a String to the stream. The actual value printed depends on the system default encoding.

Parameters:

str - The String to print.

public void print(long lnum)

This method prints a long to the stream. The value printed is determined using the String.valueOf() method.

Parameters:

lnum - The long value to be printed

public PrintWriter printf(String format,
                          java.lang.Object... args)

Since:

1.5

public PrintWriter printf(Locale locale,
                          String format,
                          java.lang.Object... args)

Since:

1.5

public void println()

This method prints a line separator sequence to the stream. The value printed is determined by the system property line.separator and is not necessarily the Unix '\n' newline character.

public void println(boolean bool)

This methods prints a boolean value to the stream. true values are printed as "true" and false values are printed as "false". This method prints a line termination sequence after printing the value.

Parameters:

bool - The boolean value to print

public void println(char ch)

This method prints a char to the stream. The actual value printed is determined by the character encoding in use. This method prints a line termination sequence after printing the value.

Parameters:

ch - The char value to be printed

public void println(char[] charArray)

This method prints an array of characters to the stream. The actual value printed depends on the system default encoding. This method prints a line termination sequence after printing the value.

Parameters:

charArray - The array of characters to print.

public void println(double dnum)

This method prints a double to the stream. The value printed is determined using the String.valueOf() method. This method prints a line termination sequence after printing the value.

Parameters:

dnum - The double value to be printed

public void println(float fnum)

This method prints a float to the stream. The value printed is determined using the String.valueOf() method. This method prints a line termination sequence after printing the value.

Parameters:

fnum - The float value to be printed

public void println(int inum)

This method prints an integer to the stream. The value printed is determined using the String.valueOf() method. This method prints a line termination sequence after printing the value.

Parameters:

inum - The int value to be printed

public void println(Object obj)

This method prints an Object to the stream. The actual value printed is determined by calling the String.valueOf() method. This method prints a line termination sequence after printing the value.

Parameters:

obj - The Object to print.

public void println(String str)

This method prints a String to the stream. The actual value printed depends on the system default encoding. This method prints a line termination sequence after printing the value.

Parameters:

str - The String to print.

public void println(long lnum)

This method prints a long to the stream. The value printed is determined using the String.valueOf() method. This method prints a line termination sequence after printing the value.

Parameters:

lnum - The long value to be printed

protected void setError()

This method can be called by subclasses to indicate that an error has occurred and should be reported by checkError.

public void write(char[] charArray)

This method write all the chars in the specified array to the output.

Overrides:

write in interface Writer

Parameters:

charArray - The array of characters to write

public void write(char[] charArray,
                  int offset,
                  int count)

This method writes count chars from the specified array starting at index offset into the array.

Overrides:

write in interface Writer

Parameters:

charArray - The array of chars to write

offset - The index into the array to start writing from

count - The number of chars to write

public void write(int ch)

This method writes a single char to the stream.

Overrides:

write in interface Writer

Parameters:

ch - The char to be written, passed as a int

public void write(String str)

This method writes the contents of the specified String to the underlying stream.

Overrides:

write in interface Writer

Parameters:

str - The String to write

public void write(String str,
                  int offset,
                  int count)

This method writes count chars from the specified String to the output starting at character position offset into the String

Overrides:

write in interface Writer

Parameters:

str - The String to write chars from

offset - The offset into the String to start writing from

count - The number of chars to write.