PrintStream format(Locale, String, Object) method in Java with Examples

The format(Locale, String, Object) method of PrintStream Class in Java is used to print a formatted string in the stream using the given Locale. The string is formatted using specified format and arguments passed as the parameter.

Syntax:

public PrintStream format(Locale locale, String format, Object…args)



Parameters: This method accepts two mandatory parameter:

  • locale which is the locale value to be applied on the this method
  • format which is the format according to which the String is to be formatted.
  • args which is the number of arguments for the formatted string. It can be optional, i.e. no arguments or any number of arguments according to the format.

Return Value: This method returns this PrintStream instance.

Exception: This method throws following exceptions:

  • NullPointerException This is thrown if the format is null.
  • IllegalFormatException This is thrown if the format specified is illegal or there are insufficient arguments.

Below methods illustrates the working of format(Locale, String, Object) method:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// PrintStream format(String, Object) method
  
import java.io.*;
import java.util.*;
  
class GFG {
    public static void main(String[] args)
    {
  
        try {
  
            // Get the parameters
            Locale locale = Locale.getDefault();
  
            double arg = 47.65734;
  
            String format = "GeeksForGeeks %.8f";
  
            // Create a PrintStream instance
            PrintStream stream
                = new PrintStream(System.out);
  
            // print the formatted string
            // to this stream using format() method
            stream.format(format, arg);
  
            stream.flush();
        }
        catch (Exception e) {
            System.out.println(e);
        }
    }
}

chevron_right


Output:

GeeksForGeeks 47.65734000

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// PrintStream format(String, Object) method
  
import java.io.*;
import java.util.*;
  
class GFG {
    public static void main(String[] args)
    {
  
        try {
  
            // Get the parameters
            Locale locale = Locale.getDefault();
  
            String arg1 = "GFG";
            String arg2 = "GeeksforGeeks";
  
            String format = "A Computer Science "
                            + "Portal  %1$s, %1$s and %2$s";
  
            // Create a PrintStream instance
            PrintStream stream
                = new PrintStream(System.out);
  
            // print the formatted string
            // to this stream using format() method
            stream.format(format, arg1, arg2);
  
            stream.flush();
        }
        catch (Exception e) {
            System.out.println(e);
        }
    }
}

chevron_right


Output:

A Computer Science Portal  GFG, GFG and GeeksforGeeks


My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.