FormattableFlags (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.util
class FormattableFlags

java.lang.Object
  java.util.FormattableFlags

public class FormattableFlags
extends Object

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

Field Summary
`static int`	`ALTERNATE` Requires the output to use an alternate form.
`static int`	`LEFT_JUSTIFY` Left-justifies the output.
`static int`	`UPPERCASE` Converts the output to upper case according to the rules of the java.util.Locale given during creation of the `formatter` argument of the java.util.Formattable.formatTo method.

Method Summary

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

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.

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.

UPPERCASE

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 {@link Formattable#formatTo formatTo()} method. The output should be equivalent the following invocation of {@link String#toUpperCase(java.util.Locale)}

     out.toUpperCase()

This flag corresponds to '^' ('\u005e') in the format specifier.