Java String format() Method

What You’ll Learn

The format() method builds a new String from a template with placeholders like %s and %d. It is static, printf-style, and ideal for readable output that mixes text, numbers, and fixed decimal places.

Definition and Usage

In Java, String.format(String format, Object... args) is a static method on java.lang.String. You provide a format string containing specifiers such as %s, plus values that replace each specifier in order. The method returns the completed string.

The syntax is inspired by C's printf. Use it for user-facing messages, invoices, progress logs, and anywhere a template reads clearer than chaining many + operators.

📝 Syntax

The format() method has several overloads. The most common form is:

public static String format(String format, Object... args)
public static String format(Locale l, String format, Object... args)

Parameters

• format — the template string with format specifiers (for example %s, %d, %.2f).
• args — zero or more values inserted into the template in order.
• l — (optional overload) a Locale for locale-sensitive formatting of numbers and dates.

Return Value

Returns a new formatted String.

Exceptions

Throws IllegalFormatException if the format string is invalid or an argument type does not match its specifier.

Examples Gallery

These programs run in Java 8+. They show string insertion, decimal formatting, multiple arguments, zero-padding, and comparison with printf.

public class StringFormatExample {
    public static void main(String[] args) {
        String formatted = String.format("Hello, %s!", "Java");

        System.out.println(formatted);
    }
}

Hello, Java!

public class PriceFormat {
    public static void main(String[] args) {
        double price = 49.99;

        String message = String.format("The price is $%.2f", price);

        System.out.println(message);
    }
}

The price is $49.99

public class MultipleArgs {
    public static void main(String[] args) {
        int quantity = 3;
        String item = "Apples";

        String order = String.format("I want %d %s", quantity, item);

        System.out.println(order);
    }
}

I want 3 Apples

public class PaddedId {
    public static void main(String[] args) {
        int ticket = 42;

        String id = String.format("Ticket #%05d", ticket);

        System.out.println(id);
    }
}

Ticket #00042

public class FormatVsPrintf {
    public static void main(String[] args) {
        String name = "Mari";

        String stored = String.format("Welcome, %s!", name);
        System.out.println("Stored: " + stored);

        System.out.print("Printed: ");
        System.out.printf("Welcome, %s!", name);
        System.out.println();
    }
}

Stored: Welcome, Mari!
Printed: Welcome, Mari!

🚀 Common Use Cases

• User messages — build personalized greetings and status lines from variables.
• Financial display — show currency with fixed decimal places using %.2f.
• Logging — create consistent log lines with timestamps, levels, and details.
• Reports and tables — align columns with width and padding specifiers.
• Test expected output — compose predictable strings for assertions.

📝 Notes

• format() is static—call String.format(...), not myString.format(...).
• Specifiers and argument types must match: use %d for integers, %f for floating-point, %s for general objects.
• Use %% to output a literal percent sign in the template.
• For locale-specific number formatting, use the overload with Locale.
• In loops, building one formatted string per iteration is fine; avoid unnecessary repeated formatting of unchanged templates.

⚡ Optimization

String.format() is efficient for typical use but allocates a new string each call. In tight loops logging thousands of lines, consider whether a simpler append or a dedicated logging API fits better. For most application code, readability wins—prefer format() over long + chains when placeholders and precision matter.

💡 Best Practices