Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright (c) 1996, 2011, Oracle and/or its affiliates. All rights reserved.
    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    *
    * This code is free software; you can redistribute it and/or modify it
    * under the terms of the GNU General Public License version 2 only, as
    * published by the Free Software Foundation.  Oracle designates this
    * particular file as subject to the "Classpath" exception as provided
    * by Oracle in the LICENSE file that accompanied this code.
   *
   * This code is distributed in the hope that it will be useful, but WITHOUT
   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   * version 2 for more details (a copy is included in the LICENSE file that
   * accompanied this code).
   *
   * You should have received a copy of the GNU General Public License version
   * 2 along with this work; if not, write to the Free Software Foundation,
   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   * or visit www.oracle.com if you need additional information or have any
   * questions.
   */
  
  package java.io;
  
  import java.util.Objects;
  import java.util.Locale;
Prints formatted representations of objects to a text-output stream. This class implements all of the print methods found in PrintStream. It does not contain methods for writing raw bytes, for which a program should use unencoded byte streams.

Unlike the PrintStream class, if automatic flushing is enabled it will be done only when one of the println, printf, or format methods is invoked, rather than whenever a newline character happens to be output. These methods use the platform's own notion of line separator rather than the newline character.

Methods in this class never throw I/O exceptions, although some of its constructors may. The client may inquire as to whether any errors have occurred by invoking checkError().

Author(s):
Frank Yellin
Mark Reinhold
Since:
JDK1.1
  
  
  public class PrintWriter extends Writer {

    
The underlying character-output stream of this PrintWriter.

Since:
1.2
  
      protected Writer out;
  
      private final boolean autoFlush;
      private boolean trouble = false;
      private Formatter formatter;
      private PrintStream psOut = null;

    
Line separator string. This is the value of the line.separator property at the moment that the stream was created.
  
      private final String lineSeparator;

    
Returns a charset object for the given charset name.

Throws:
java.lang.NullPointerException is csn is null
UnsupportedEncodingException if the charset is not supported
  
      private static Charset toCharset(String csn)
          throws UnsupportedEncodingException
      {
          Objects.requireNonNull(csn"charsetName");
          try {
              return Charset.forName(csn);
          } catch (IllegalCharsetNameException|UnsupportedCharsetException unused) {
              // UnsupportedEncodingException should be thrown
              throw new UnsupportedEncodingException(csn);
          }
      }

    
Creates a new PrintWriter, without automatic line flushing.

Parameters:
out A character-output stream
  
      public PrintWriter (Writer out) {
         this(outfalse);
     }

    
Creates a new PrintWriter.

Parameters:
out A character-output stream
autoFlush A boolean; if true, the println, printf, or format methods will flush the output buffer
 
     public PrintWriter(Writer out,
                        boolean autoFlush) {
         super(out);
         this. = out;
         this. = autoFlush;
          = java.security.AccessController.doPrivileged(
             new sun.security.action.GetPropertyAction("line.separator"));
     }

    
Creates 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
See also:
java.io.OutputStreamWriter.OutputStreamWriter.(java.io.OutputStream)
 
     public PrintWriter(OutputStream out) {
         this(outfalse);
     }

    
Creates 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, printf, or format methods will flush the output buffer
See also:
java.io.OutputStreamWriter.OutputStreamWriter.(java.io.OutputStream)
 
     public PrintWriter(OutputStream outboolean autoFlush) {
         this(new BufferedWriter(new OutputStreamWriter(out)), autoFlush);
 
         // save print stream for error propagation
         if (out instanceof java.io.PrintStream) {
              = (PrintStreamout;
         }
     }

    
Creates a new PrintWriter, without automatic line flushing, with the specified file name. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the java.nio.charset.Charset.defaultCharset() for this instance of the Java virtual machine.

Parameters:
fileName The name of the file to use as the destination of this writer. If the file exists then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
Throws:
FileNotFoundException If the given string does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
java.lang.SecurityException If a security manager is present and java.lang.SecurityManager.checkWrite(java.io.FileDescriptor) denies write access to the file
Since:
1.5
 
     public PrintWriter(String fileNamethrows FileNotFoundException {
         this(new BufferedWriter(new OutputStreamWriter(new FileOutputStream(fileName))),
              false);
     }
 
     /* Private constructor */
     private PrintWriter(Charset charsetFile file)
         throws FileNotFoundException
     {
         this(new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), charset)),
              false);
     }

    
Creates a new PrintWriter, without automatic line flushing, with the specified file name and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the provided charset.

Parameters:
fileName The name of the file to use as the destination of this writer. If the file exists then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
csn The name of a supported charset
Throws:
FileNotFoundException If the given string does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
java.lang.SecurityException If a security manager is present and java.lang.SecurityManager.checkWrite(java.io.FileDescriptor) denies write access to the file
UnsupportedEncodingException If the named charset is not supported
Since:
1.5
 
     public PrintWriter(String fileNameString csn)
     {
         this(toCharset(csn), new File(fileName));
     }

    
Creates a new PrintWriter, without automatic line flushing, with the specified file. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the java.nio.charset.Charset.defaultCharset() for this instance of the Java virtual machine.

Parameters:
file The file to use as the destination of this writer. If the file exists then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
Throws:
FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
java.lang.SecurityException If a security manager is present and java.lang.SecurityManager.checkWrite(java.io.FileDescriptor) denies write access to the file
Since:
1.5
 
     public PrintWriter(File filethrows FileNotFoundException {
         this(new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file))),
              false);
     }

    
Creates a new PrintWriter, without automatic line flushing, with the specified file and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will encode characters using the provided charset.

Parameters:
file The file to use as the destination of this writer. If the file exists then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.
csn The name of a supported charset
Throws:
FileNotFoundException If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file
java.lang.SecurityException If a security manager is present and java.lang.SecurityManager.checkWrite(java.io.FileDescriptor) denies write access to the file
UnsupportedEncodingException If the named charset is not supported
Since:
1.5
 
     public PrintWriter(File fileString csn)
     {
         this(toCharset(csn), file);
     }

    
Checks to make sure that the stream has not been closed
 
     private void ensureOpen() throws IOException {
         if ( == null)
             throw new IOException("Stream closed");
     }

    
Flushes the stream.

See also:
checkError()
 
     public void flush() {
         try {
             synchronized () {
                 ensureOpen();
                 .flush();
             }
         }
         catch (IOException x) {
              = true;
         }
     }

    
Closes the stream and releases any system resources associated with it. Closing a previously closed stream has no effect.

See also:
checkError()
 
     public void close() {
         try {
             synchronized () {
                 if ( == null)
                     return;
                 .close();
                  = null;
             }
         }
         catch (IOException x) {
              = true;
         }
     }

    
Flushes the stream if it's not closed and checks its error state.

Returns:
true if the print stream has encountered an error, either on the underlying output stream or during a format conversion.
 
     public boolean checkError() {
         if ( != null) {
             flush();
         }
         if ( instanceof java.io.PrintWriter) {
             PrintWriter pw = (PrintWriter;
             return pw.checkError();
         } else if ( != null) {
             return .checkError();
         }
         return ;
     }

    
Indicates that an error has occurred.

This method will cause subsequent invocations of checkError() to return true until clearError() is invoked.

 
     protected void setError() {
          = true;
     }

    
Clears the error state of this stream.

This method will cause subsequent invocations of checkError() to return false until another write operation fails and invokes setError().

Since:
1.6
 
     protected void clearError() {
          = false;
     }
 
     /*
      * Exception-catching, synchronized output operations,
      * which also implement the write() methods of Writer
      */

    
Writes a single character.

Parameters:
c int specifying a character to be written.
 
     public void write(int c) {
         try {
             synchronized () {
                 ensureOpen();
                 .write(c);
             }
         }
         catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         }
         catch (IOException x) {
              = true;
         }
     }

    
Writes A Portion of an array of characters.

Parameters:
buf Array of characters
off Offset from which to start writing characters
len Number of characters to write
 
     public void write(char buf[], int offint len) {
         try {
             synchronized () {
                 ensureOpen();
                 .write(bufofflen);
             }
         }
         catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         }
         catch (IOException x) {
              = true;
         }
     }

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

Parameters:
buf Array of characters to be written
 
     public void write(char buf[]) {
         write(buf, 0, buf.length);
     }

    
Writes a portion of a string.

Parameters:
s A String
off Offset from which to start writing characters
len Number of characters to write
 
     public void write(String sint offint len) {
         try {
             synchronized () {
                 ensureOpen();
                 .write(sofflen);
             }
         }
         catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         }
         catch (IOException x) {
              = true;
         }
     }

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

Parameters:
s String to be written
 
     public void write(String s) {
         write(s, 0, s.length());
     }
 
     private void newLine() {
         try {
             synchronized () {
                 ensureOpen();
                 .write();
                 if ()
                     .flush();
             }
         }
         catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         }
         catch (IOException x) {
              = true;
         }
     }
 
     /* Methods that do not terminate lines */

    
Prints a boolean value. The string produced by java.lang.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
 
     public void print(boolean b) {
         write(b ? "true" : "false");
     }

    
Prints 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
 
     public void print(char c) {
         write(c);
     }

    
Prints an integer. The string produced by java.lang.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:
java.lang.Integer.toString(int)
 
     public void print(int i) {
         write(String.valueOf(i));
     }

    
Prints a long integer. The string produced by java.lang.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
See also:
java.lang.Long.toString(long)
 
     public void print(long l) {
         write(String.valueOf(l));
     }

    
Prints a floating-point number. The string produced by java.lang.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:
java.lang.Float.toString(float)
 
     public void print(float f) {
         write(String.valueOf(f));
     }

    
Prints a double-precision floating-point number. The string produced by java.lang.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
See also:
java.lang.Double.toString(double)
 
     public void print(double d) {
         write(String.valueOf(d));
     }

    
Prints 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:
java.lang.NullPointerException If s is null
 
     public void print(char s[]) {
         write(s);
     }

    
Prints 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
 
     public void print(String s) {
         if (s == null) {
             s = "null";
         }
         write(s);
     }

    
Prints an object. The string produced by the java.lang.String.valueOf(java.lang.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:
java.lang.Object.toString()
 
     public void print(Object obj) {
         write(String.valueOf(obj));
     }
 
     /* Methods that do terminate lines */

    
Terminates 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').
 
     public void println() {
         newLine();
     }

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

Parameters:
x the boolean value to be printed
 
     public void println(boolean x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the char value to be printed
 
     public void println(char x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the int value to be printed
 
     public void println(int x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the long value to be printed
 
     public void println(long x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the float value to be printed
 
     public void println(float x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the double value to be printed
 
     public void println(double x) {
         synchronized () {
             print(x);
             println();
         }
     }

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

Parameters:
x the array of char values to be printed
 
     public void println(char x[]) {
         synchronized () {
             print(x);
             println();
         }
     }

    
Prints a String and then terminates the line. This method behaves as though it invokes print(java.lang.String) and then println().

Parameters:
x the String value to be printed
 
     public void println(String x) {
         synchronized () {
             print(x);
             println();
         }
     }

    
Prints an Object and then terminates the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes print(java.lang.String) and then println().

Parameters:
x The Object to be printed.
 
     public void println(Object x) {
         String s = String.valueOf(x);
         synchronized () {
             print(s);
             println();
         }
     }

    
A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

An invocation of this method of the form out.printf(format, args) behaves in exactly the same way as the invocation

     out.format(format, args) 

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:
This writer
Throws:
IllegalFormatException If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
java.lang.NullPointerException If the format is null
Since:
1.5
 
     public PrintWriter printf(String formatObject ... args) {
         return format(formatargs);
     }

    
A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

An invocation of this method of the form out.printf(l, format, args) behaves in exactly the same way as the invocation

     out.format(l, format, args) 

Parameters:
l The locale to apply during formatting. If l is null then no localization is applied.
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:
This writer
Throws:
IllegalFormatException If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
java.lang.NullPointerException If the format is null
Since:
1.5
 
     public PrintWriter printf(Locale lString formatObject ... args) {
         return format(lformatargs);
     }

    
Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

The locale always used is the one returned by java.util.Locale.getDefault(), regardless of any previous invocations of other formatting methods on this object.

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:
This writer
Throws:
IllegalFormatException If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the Formatter class specification.
java.lang.NullPointerException If the format is null
Since:
1.5
 
     public PrintWriter format(String formatObject ... args) {
         try {
             synchronized () {
                 ensureOpen();
                 if (( == null)
                     || (.locale() != Locale.getDefault()))
                      = new Formatter(this);
                 .format(Locale.getDefault(), formatargs);
                 if ()
                     .flush();
             }
         } catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         } catch (IOException x) {
              = true;
         }
         return this;
     }

    
Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

Parameters:
l The locale to apply during formatting. If l is null then no localization is applied.
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:
This writer
Throws:
IllegalFormatException If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
java.lang.NullPointerException If the format is null
Since:
1.5
 
     public PrintWriter format(Locale lString formatObject ... args) {
         try {
             synchronized () {
                 ensureOpen();
                 if (( == null) || (.locale() != l))
                      = new Formatter(thisl);
                 .format(lformatargs);
                 if ()
                     .flush();
             }
         } catch (InterruptedIOException x) {
             Thread.currentThread().interrupt();
         } catch (IOException x) {
              = true;
         }
         return this;
     }

    
Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

     out.write(csq.toString()) 

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

Parameters:
csq The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.
Returns:
This writer
Since:
1.5
 
    public PrintWriter append(CharSequence csq) {
        if (csq == null)
            write("null");
        else
            write(csq.toString());
        return this;
    }

    
Appends a subsequence of the specified character sequence to this writer.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

     out.write(csq.subSequence(start, end).toString()) 

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
Returns:
This writer
Throws:
java.lang.IndexOutOfBoundsException If start or end are negative, start is greater than end, or end is greater than csq.length()
Since:
1.5
    public PrintWriter append(CharSequence csqint startint end) {
        CharSequence cs = (csq == null ? "null" : csq);
        write(cs.subSequence(startend).toString());
        return this;
    }

    
Appends the specified character to this writer.

An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation

     out.write(c) 

Parameters:
c The 16-bit character to append
Returns:
This writer
Since:
1.5
    public PrintWriter append(char c) {
        write(c);
        return this;
    }
New to GrepCode? Check out our FAQ X