Java Formatter toString() Method

Description

The java Formatter toString() method returns the result of invoking toString() on the destination for the output.

Declaration

Following is the declaration for java.util.Formatter.toString() method

public String toString()

Parameters

NA

Return Value

This method returns the result of invoking toString() on the destination for the output.

Exception

FormatterClosedException − If this formatter has been closed by invoking its close() method

Getting String Representation of a Formatter Object of US Locale Example

The following example shows the usage of Java Formatter out() method to print the destination of a formatter. We've created a formatter object with a StringBuffer and US locale. Formatter is used to print a string using the format() method. Then its content is printed using toString() method.

package com.tutorialspoint;

import java.util.Formatter;
import java.util.Locale;

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

      // create a new formatter
      StringBuffer buffer = new StringBuffer();
      Formatter formatter = new Formatter(buffer, Locale.US);

      // format a new string
      String name = "World";
      formatter.format("Hello %s !", name);

      // print the formatted string with default locale
      System.out.println("" + formatter);

      // print the formatter as a string
      System.out.println("" + formatter.toString());
	  
      formatter.close();
   }
}

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

Hello World !
Hello World !

Getting String Representation of a Formatter Object of GERMAN Locale Example

The following example shows the usage of Java Formatter out() method to print the destination of a formatter. We've created a formatter object with a StringBuffer and GERMAN locale. Formatter is used to print a string using the format() method. Then its content is printed using toString() method.

package com.tutorialspoint;

import java.util.Formatter;
import java.util.Locale;

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

      // create a new formatter
      StringBuffer buffer = new StringBuffer();
      Formatter formatter = new Formatter(buffer, Locale.GERMAN);

      // format a new string
      String name = "World";
      formatter.format("Hello %s !", name);

      // print the formatted string with default locale
      System.out.println("" + formatter);

      // print the formatter as a string
      System.out.println("" + formatter.toString());
	  
      formatter.close();
   }
}

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

Hello World !
Hello World !

Getting String Representation of a Formatter Object of FRENCH Locale Example

The following example shows the usage of Java Formatter out() method to print the destination of a formatter. We've created a formatter object with a StringBuffer and FRENCH locale. Formatter is used to print a string using the format() method. Then its content is printed using toString() method.

package com.tutorialspoint;

import java.util.Formatter;
import java.util.Locale;

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

      // create a new formatter
      StringBuffer buffer = new StringBuffer();
      Formatter formatter = new Formatter(buffer, Locale.FRENCH);

      // format a new string
      String name = "World";
      formatter.format("Hello %s !", name);

      // print the formatted string with default locale
      System.out.println("" + formatter);

      // print the formatter as a string
      System.out.println("" + formatter.toString());
	  
      formatter.close();
   }
}

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

Hello World !
Hello World !