Enum Class SignStyle

java.lang.Object

java.lang.Enum<SignStyle>

java.time.format.SignStyle

All Implemented Interfaces:: Serializable, Comparable<SignStyle>, Constable

public enum SignStyle extends Enum<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.

Implementation Requirements:: This is an immutable and thread-safe enum.
Since:: 1.8

Nested Class Summary

Nested classes/interfaces declared in class Enum

Enum.EnumDesc<E>

Modifier and Type	Class	Description
`static final class`	`Enum.EnumDesc<E extends Enum<E>>`	A nominal descriptor for an `enum` constant.

Enum Constant Summary

Enum Constant	Description
`ALWAYS`	Style to always output the sign, where zero will output '+'.
`EXCEEDS_PAD`	Style to always output the sign if the value exceeds the pad width.
`NEVER`	Style to never output sign, only outputting the absolute value.
`NORMAL`	Style to output the sign only if the value is negative.
`NOT_NEGATIVE`	Style to block negative values, throwing an exception on printing.

Method Summary

Modifier and Type	Method	Description
`static SignStyle`	`valueOf(String name)`	Returns the enum constant of this class with the specified name.
`static SignStyle[]`	`values()`	Returns an array containing the constants of this enum class, in the order they are declared.

Methods declared in class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Modifier and Type	Method	Description
`protected final Object`	`clone()`	Throws CloneNotSupportedException.
`final int`	`compareTo(SignStyle o)`	Compares this enum with the specified object for order.
`final Optional<Enum.EnumDesc<SignStyle>>`	`describeConstable()`	Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
`final boolean`	`equals(Object other)`	Returns true if the specified object is equal to this enum constant.
`protected final void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal.
`final Class<SignStyle>`	`getDeclaringClass()`	Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()`	Returns a hash code for this enum constant.
`final String`	`name()`	Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()`	Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()`	Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)`	Returns the enum constant of the specified enum class with the specified name.

Methods declared in class Object

getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Enum Constant Details

NORMAL

public static final SignStyle NORMAL

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.

ALWAYS

public static final SignStyle ALWAYS

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.

NEVER

public static final SignStyle NEVER

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.

NOT_NEGATIVE

public static final SignStyle NOT_NEGATIVE

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.

EXCEEDS_PAD

public static final SignStyle EXCEEDS_PAD

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.

Method Details

values

public static SignStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:: an array containing the constants of this enum class, in the order they are declared

valueOf

public static SignStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum class has no constant with the specified name; NullPointerException - if the argument is null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.