Home » Java programming language

Java Formatter out() Method with Example

Formatter Class out() method: Here, we are going to learn about the out() method of Formatter Class with its syntax and example.
Submitted by Preeti Jain, on February 14, 2020

Formatter Class out() method

• out() method is available in java.util package.
• out() method is used to get Appendable for the output.
• out() method is a non-static method, it is accessible with the class object and if we try to access the method with the class name then we will get an error.
• out() method may throw an exception at the time of returning destination for the output.
  FormatterClosedException: This exception may throw when this Formatter close by calling its close() method.

Syntax:

    public Appendable out();

Parameter(s):

• It does not accept any parameter.

Return value:

The return type of this method is Appendable, it returns Appendable for the output.

Example:

// Java program is to demonstrate the example of
// out() method of Formatter

import java.util.*;

public class OutOfFormatter {
    public static void main(String[] args) {

        // Instantiates a StringBuffer and Formmatter object
        StringBuffer sb = new StringBuffer();
        Formatter formatt = new Formatter(sb, Locale.UK);

        // By using format() method is to format
        // a string
        formatt.format("Hi %s !", "IncludeHelp");

        // Display Formatted String
        System.out.println(formatt);

        // By using out() method is to
        // return the output formatted by
        // this Formatter
        System.out.println("formatt.out(): " + formatt.out());
    }
}

Output

Hi IncludeHelp !
formatt.out(): Hi IncludeHelp !