Stay organized with collections
Save and categorize content based on your preferences.
open class FormattableFlags
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.
Summary
| Constants |
| static Int |
Requires the output to use an alternate form.
|
| static Int |
Left-justifies the output.
|
| static Int |
Converts the output to upper case according to the rules of the locale given during creation of the formatter argument of the formatTo() method.
|
Constants
ALTERNATE
static val ALTERNATE: Int
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.
Value: 4
LEFT_JUSTIFY
static val LEFT_JUSTIFY: Int
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.
Value: 1
UPPERCASE
static val UPPERCASE: Int
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.
Value: 2
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# FormattableFlags\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nFormattableFlags\n================\n\n```\nopen class FormattableFlags\n```\n\n|---|---------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.util.FormattableFlags](#) |\n\nFormattableFlags are passed to the [Formattable.formatTo()](/reference/kotlin/java/util/Formattable#formatTo(java.util.Formatter,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int)) method and modify the output format for [Formattables](/reference/kotlin/java/util/Formattable). Implementations of [Formattable](/reference/kotlin/java/util/Formattable) are responsible for interpreting and validating any flags.\n\nSummary\n-------\n\n| Constants ||\n|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [ALTERNATE](#ALTERNATE:kotlin.Int) Requires the output to use an alternate form. |\n| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [LEFT_JUSTIFY](#LEFT_JUSTIFY:kotlin.Int) Left-justifies the output. |\n| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [UPPERCASE](#UPPERCASE:kotlin.Int) Converts the output to upper case according to the rules of the [locale](/reference/kotlin/java/util/Locale) given during creation of the `formatter` argument of the [formatTo()](/reference/kotlin/java/util/Formattable#formatTo(java.util.Formatter,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int)) method. |\n\nConstants\n---------\n\n### ALTERNATE\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val ALTERNATE: Int\n```\n\nRequires the output to use an alternate form. The definition of the form is specified by the `Formattable`.\n\nThis flag corresponds to `'#'` (`'\\u0023'`) in the format specifier. \n\n Value: 4\n\n### LEFT_JUSTIFY\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val LEFT_JUSTIFY: Int\n```\n\nLeft-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.\n\nThis flag corresponds to `'-'` (`'\\u002d'`) in the format specifier. \n\n Value: 1\n\n### UPPERCASE\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val UPPERCASE: Int\n```\n\nConverts the output to upper case according to the rules of the [locale](/reference/kotlin/java/util/Locale) given during creation of the `formatter` argument of the [formatTo()](/reference/kotlin/java/util/Formattable#formatTo(java.util.Formatter,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int)) method. The output should be equivalent the following invocation of [String.toUpperCase(java.util.Locale)](../lang/String.html#toUpperCase(java.util.Locale)) \n\n```kotlin\nout.toUpperCase() \n```\n\n\u003cbr /\u003e\n\nThis flag corresponds to `'S'` (`'\\u0053'`) in the format specifier. \n\n Value: 2"]]
