Class FormattableFlags

java.lang.Object
java.util.FormattableFlags
public class FormattableFlags extends Object
FormattableFlags are passed to the Formattable.formatTo() method and modify the output format for Formattables. Implementations of Formattable are responsible for interpreting and validating any flags.
Since:
1.5

Field Summary

Modifier and Type Field Description
static final int ALTERNATE
Requires the output to use an alternate form.
static final int LEFT_JUSTIFY
Left-justifies the output.
static final int UPPERCASE
Converts the output to upper case according to the rules of the locale given during creation of the formatter argument of the formatTo() method.

Method Summary

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LEFT_JUSTIFY

public static final int LEFT_JUSTIFY
Left-justifies the output. Spaces ('\u0020') will be added at the end of the converted value as required to fill the minimum width of the field. If this flag is not set then the output will be right-justified.

This flag corresponds to '-' ('\u002d') in the format specifier.

See Also:

UPPERCASE

public static final int UPPERCASE
Converts the output to upper case according to the rules of the locale given during creation of the formatter argument of the formatTo() method. The output should be equivalent the following invocation of String.toUpperCase(java.util.Locale) 
     out.toUpperCase()

This flag corresponds to 'S' ('\u0053') in the format specifier.

See Also:

ALTERNATE

public static final int ALTERNATE
Requires the output to use an alternate form. The definition of the form is specified by the Formattable.

This flag corresponds to '#' ('\u0023') in the format specifier.

See Also:

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/FormattableFlags.html