Formatter out() method in Java with Examples

The out() method is a built-in method of the java.util.Formatter which returns the destination for the output by the formatter.

Syntax:

public Appendable out()

Parameters: The function accepts no parameter.



Return Value: The function returns the destination for the output.

Exceptions: The function throws FormatterClosedException if the formatter has been closed before the function call.

Below is the implementation of the above function:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to implement
// the above function
  
import java.util.Formatter;
import java.util.Locale;
  
public class Main {
  
    public static void main(String[] args)
    {
  
        // Get the string Buffer
        StringBuffer buffer
            = new StringBuffer();
  
        // Object creation
        Formatter frmt
            = new Formatter(buffer,
                            Locale.CANADA);
  
        // Format a new string
        String name = "My name is Gopal Dave";
        frmt.format("What is your name? \n%s !",
                    name);
  
        // Print the Formatted string
        System.out.println(frmt);
  
        // Prints the destination of the output
        System.out.println("\nDestination: "
                           + frmt.out());
    }
}

chevron_right


Output:

What is your name? 
My name is Gopal Dave !

Destination: What is your name? 
My name is Gopal Dave !

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to implement
// the above function
  
import java.util.Formatter;
import java.util.Locale;
  
public class Main {
  
    public static void main(String[] args)
    {
        try {
  
            // Get the string Buffer
            StringBuffer buffer
                = new StringBuffer();
  
            // Object creation
            Formatter frmt
                = new Formatter(buffer,
                                Locale.CANADA);
  
            // Format a new string
            String name = "My name is Gopal Dave";
            frmt.format("What is your name? \n%s !",
                        name);
  
            // Print the Formatted string
            System.out.println(frmt);
  
            // Formatter closed
            frmt.close();
  
            // Prints the destination of the output
            System.out.println("\nDestination: "
                               + frmt.out());
        }
        catch (Exception e) {
            System.out.println("Exception is: "
                               + e);
        }
    }
}

chevron_right


Output:

What is your name? 
My name is Gopal Dave !
Exception is: java.util.FormatterClosedException

Reference: https://docs.oracle.com/javase/10/docs/api/java/util/Formatter.html#out()



My Personal Notes arrow_drop_up

The function of education is to teach one to think intensively and to think critically

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.