Enum Class FormatStyle

java.lang.Object
java.lang.Enum<FormatStyle>
java.time.format.FormatStyle
All Implemented Interfaces:
Serializable, Comparable<FormatStyle>, Constable 
public enum FormatStyle extends Enum<FormatStyle>
Enumeration of the style of a localized date, time or date-time formatter.

These styles are used when obtaining a date-time style from configuration. See DateTimeFormatter and 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 java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constant Description
FULL
Full text style, with the most detail.
LONG
Long text style, with lots of detail.
MEDIUM
Medium text style, with some detail.
SHORT
Short text style, typically numeric.

Method Summary

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

Methods declared in class java.lang.Enum

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

Methods declared in class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

public static final FormatStyle FULL
Full text style, with the most detail. For example, the format might be 'Tuesday, April 12, 1952 AD' or '3:30:42pm PST'.

LONG

public static final FormatStyle LONG
Long text style, with lots of detail. For example, the format might be 'January 12, 1952'.

MEDIUM

public static final FormatStyle MEDIUM
Medium text style, with some detail. For example, the format might be 'Jan 12, 1952'.

SHORT

public static final FormatStyle SHORT
Short text style, typically numeric. For example, the format might be '12.13.52' or '3:30pm'.

Method Details

values

public static FormatStyle[] 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 FormatStyle 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, 2021, 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.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/FormatStyle.html