SignStyle
class SignStyle
| kotlin.Any | ||
| ↳ | kotlin.Enum<java.time.format.SignStyle> | |
| ↳ | java.time.format.SignStyle | |
Enumeration of ways to handle the positive/negative sign.
The formatting engine allows the positive and negative signs of numbers to be controlled using this enum. See DateTimeFormatterBuilder for usage.
Summary
| Enum values | |
|---|---|
|
Style to always output the sign, where zero will output '+'. |
|
|
Style to always output the sign if the value exceeds the pad width. |
|
|
Style to never output sign, only outputting the absolute value. |
|
|
Style to output the sign only if the value is negative. |
|
|
Style to block negative values, throwing an exception on printing. |
|
Enum values
ALWAYS
enum val ALWAYS : SignStyle
Style to always output the sign, where zero will output '+'.
In strict parsing, the absence of a sign will be rejected. In lenient parsing, any sign will be accepted, with the absence of a sign treated as a positive number.
EXCEEDS_PAD
enum val EXCEEDS_PAD : SignStyle
Style to always output the sign if the value exceeds the pad width. A negative value will always output the '-' sign.
In strict parsing, the sign will be rejected unless the pad width is exceeded. In lenient parsing, any sign will be accepted, with the absence of a sign treated as a positive number.
NEVER
enum val NEVER : SignStyle
Style to never output sign, only outputting the absolute value.
In strict parsing, any sign will be rejected. In lenient parsing, any sign will be accepted unless the width is fixed.
NORMAL
enum val NORMAL : SignStyle
Style to output the sign only if the value is negative.
In strict parsing, the negative sign will be accepted and the positive sign rejected. In lenient parsing, any sign will be accepted.
NOT_NEGATIVE
enum val NOT_NEGATIVE : SignStyle
Style to block negative values, throwing an exception on printing.
In strict parsing, any sign will be rejected. In lenient parsing, any sign will be accepted unless the width is fixed.