In this article, we will discuss formatting a string using String’s format() method

1. String’s format(String format, Object… args) method:

• This String method is used to format a string using supplied or input arguments i.e.;
  • Format –> format of the string like (%s, %f, %n, %d)
  • Object –> actual string input to be formatted
  • Local –> if not provided, it uses default local, by invoking Locale.getDefault();

1.1 Method Signature:

public static String format(String format, Object… args);

public static String format(Locale locale, String format,
		Object… args);

1.2 Returns:

• Returns a formatted string using the specified locale, format string, and arguments

1.3 Throws:

• NullPointerException: If the format passed is null
• IllegalFormatException: If the syntax of format passed is illegal or incompatible with the given arguments or some other illegal conditions

2. Examples on format() method:

• Sample Java program to get formatted string

StringFormatMethod.java

package in.bench.resources.string.methods;

public class StringFormatMethod {

	public static void main(String[] args) {

		// sample variable declarations
		String testString = "BenchResources";
		float testFloat = 141.236958f;

		// String formatting using string value and %s formatter
		String strFomrat1 = String.format("%s", testString);

		// String formatting using float value and %f formatter
		String strFomrat2 = String.format("%f", testFloat);

		// String formatting using float value and %3.2f formatter
		String strFomrat3 = String.format("%3.2f", testFloat);

		// printing formatted values
		System.out.println(strFomrat1);
		System.out.println(strFomrat2);
		System.out.println(strFomrat3);
	}
}

Output:

BenchResources
141.236954
141.24

Related Articles:

• Java – String charAt(int index) method
• Java – String compareTo(String anotherString) method
• Java – String compareToIgnoreCase(String str) method
• Java – String concat(String str) method
• Java – String contains(CharSequence s) method
• Java – String contentEquals(StringBuffer sb) method
• Java – String copyValueOf(char[] data) method (2)
• Java – String endsWith(String suffix) method
• Java – String equals(Object anObject) method
• Java – String equalsIgnoreCase(Object anObject) method
• Java – String format(String format, Object… args) method
• Java – String getBytes() method (4)
• Java – String getChars() method
• Java – String hashCode() method
• Java – String indexOf() method (4)
• Java – String intern() method
• Java – String isEmpty() method
• Java – String join() method (2)
• Java – String lastIndexOf() method (4)
• Java – String length() method
• Java – String matches(String regex) method
• Java – String regionMatches() method (2)
• Java – String replace(char oldChar, char newChar) method
• Java – String replace(CharSequence target, CharSequence replacement) method
• Java – String replaceAll(String regex, String replacement) method
• Java – String replaceFirst(String regex, String replacement) method
• Java – String split(String regex) method
• Java – String split(String regex, int limit) method
• Java – String startsWith(String prefix) method
• Java – String startsWith(String prefix, int toffset) method
• Java – String subSequence(int beginIndex, int endIndex) method
• Java – String substring(int beginIndex) method
• Java – String substring(int beginIndex, int endIndex) method
• Java – String toCharArray() method
• Java – String toLowerCase() method (2)
• Java – String toUpperCase() method (2)
• Java – String toString() method
• Java – String trim() method
• Java – String valueOf() method (9)

References:

• https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html
• https://docs.oracle.com/javase/tutorial/essential/concurrency/imstrat.html
• https://docs.oracle.com/javase/tutorial/java/data/strings.html
• https://docs.oracle.com/javase/8/docs/api/java/lang/String.html
• https://docs.oracle.com/javase/8/docs/api/java/lang/class-use/String.html
• https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html
• https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html

Happy Coding !!
Happy Learning !!