FormattableFlags

AI-generated Key Takeaways

• FormattableFlags modify the output format for Formattable objects when passed to the formatTo() method.

• Formattable implementations interpret and validate these flags, including ALTERNATE, LEFT_JUSTIFY, and UPPERCASE.

• These flags correspond to specific characters in format specifiers, influencing the output's justification, case, and form.

• The class inherits methods from Object, such as clone, equals, and toString, providing standard object functionalities.

public class FormattableFlags extends Object

FomattableFlags are passed to the Formattable.formatTo() method and modify the output format for {@linkplain Formattable Formattables}. Implementations of Formattable are responsible for interpreting and validating any flags.

Constant Summary

int	ALTERNATE	Requires the output to use an alternate form.
int	LEFT_JUSTIFY	Left-justifies the output.
int	UPPERCASE	Converts the output to upper case according to the rules of the {@linkplain java.util.Locale locale} given during creation of the formatter argument of the formatTo() method.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Constants

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.

Constant Value: 4

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.

Constant Value: 1

public static final int UPPERCASE

Converts the output to upper case according to the rules of the {@linkplain java.util.Locale 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.

Constant Value: 2