Java.io.PrintWriter.format() Method

Description

The java.io.PrintWriter.format() method 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.

Declaration

Following is the declaration for java.io.PrintWriter.format() method.

public PrintWriter format(String format,Object... 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.

Return Value

This method returns this writer.

Exception

• 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.

• NullPointerException − If the format is null.

Example

The following example shows the usage of java.io.PrintWriter.format() method.

package com.tutorialspoint;

import java.io.*;

public class PrintWriterDemo {
   public static void main(String[] args) {
      String s = "Hello World";
      
      try {
         // create a new writer
         PrintWriter pw = new PrintWriter(System.out);

         // format text with default locale
         // %s indicates a string will be placed there, which is s
         pw.format("This is a %s program", s);

         // change line
         pw.println();

         // format text with default locale
         // %d indicates a integer will be placed there, which is 100
         pw.format("This is a %s program with %d", s, 100);

         // flush the writer
         pw.flush();
      } catch (Exception ex) {
         ex.printStackTrace();
      }
   }
}

Let us compile and run the above program, this will produce the following result −

This is a Hello World program
This is a Hello World program with 100