FormattableFlags (FlexDoc/Javadoc 2.0 Demo)

Class

PREV CLASS NEXT CLASS All Classes All Packages

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

FlexDoc/Javadoc 2.0
Demo Java Doc

java.base / java.util

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
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 inherited from class java.lang.Object

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

Field Detail

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

Class

PREV CLASS NEXT CLASS All Classes All Packages

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

FlexDoc/Javadoc 2.0
Demo Java Doc

Java API documentation generated with FlexDoc/Javadoc 2.0 using JavadocClassic 3.0 template set.

FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, FlexDoc/Javadoc may be the only tool able to help you! Find out more at www.flexdoc.xyz