Inspectopedia Help

Malformed format string

Reports format strings that don't comply with the standard Java syntax.

By default, the inspection considers a compile-time constant a format string if it's used as an argument to the corresponding methods on java.util.Formatter, java.lang.String, java.io.PrintWriter or java.io.PrintStream.

Example:

String.format("x = %d, y = %d", 42);

Use the inspection settings to mark additional classes and methods as related to string formatting.

As an alternative, you can use the org.intellij.lang.annotations.PrintFormat annotation to mark the format string method parameter. In this case, the format arguments parameter must immediately follow the format string and be the last method parameter. Example:

void myFormatMethod(int mode, @PrintFormat String formatString, Object... args) {...}

Methods annotated in this way will also be recognized by this inspection.

Inspection options

Option

Type

Default

Additional formatter classes

StringList

[]

Additional formatter methods

StringList

[]

Inspection Details

Available in:

IntelliJ IDEA 2023.3, Qodana for JVM 2023.3

Plugin:

Java, 233.SNAPSHOT

Last modified: 13 July 2023