Enum TextStyle
- java.lang.Object
-
- java.lang.Enum<TextStyle>
-
- java.time.format.TextStyle
-
- All Implemented Interfaces:
- Serializable, Comparable<TextStyle>
public enum TextStyle extends Enum<TextStyle>
Enumeration of the style of text formatting and parsing.Text styles define three sizes for the formatted text - 'full', 'short' and 'narrow'. Each of these three sizes is available in both 'standard' and 'stand-alone' variations.
The difference between the three sizes is obvious in most languages. For example, in English the 'full' month is 'January', the 'short' month is 'Jan' and the 'narrow' month is 'J'. Note that the narrow size is often not unique. For example, 'January', 'June' and 'July' all have the 'narrow' text 'J'.
The difference between the 'standard' and 'stand-alone' forms is trickier to describe as there is no difference in English. However, in other languages there is a difference in the word used when the text is used alone, as opposed to in a complete date. For example, the word used for a month when used alone in a date picker is different to the word used for month in association with a day and year in a date.
- Implementation Requirements:
- This is immutable and thread-safe enum.
-
-
Enum Constant Summary
Enum Constants Enum Constant and Description FULLFull text, typically the full description.FULL_STANDALONEFull text for stand-alone use, typically the full description.NARROWNarrow text, typically a single letter.NARROW_STANDALONENarrow text for stand-alone use, typically a single letter.SHORTShort text, typically an abbreviation.SHORT_STANDALONEShort text for stand-alone use, typically an abbreviation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description TextStyleasNormal()Returns the normal style with the same size.TextStyleasStandalone()Returns the stand-alone style with the same size.booleanisStandalone()Returns true if the Style is a stand-alone style.static TextStylevalueOf(String name)Returns the enum constant of this type with the specified name.static TextStyle[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
FULL
public static final TextStyle FULL
Full text, typically the full description. For example, day-of-week Monday might output "Monday".
FULL_STANDALONE
public static final TextStyle FULL_STANDALONE
Full text for stand-alone use, typically the full description. For example, day-of-week Monday might output "Monday".
SHORT
public static final TextStyle SHORT
Short text, typically an abbreviation. For example, day-of-week Monday might output "Mon".
SHORT_STANDALONE
public static final TextStyle SHORT_STANDALONE
Short text for stand-alone use, typically an abbreviation. For example, day-of-week Monday might output "Mon".
NARROW
public static final TextStyle NARROW
Narrow text, typically a single letter. For example, day-of-week Monday might output "M".
NARROW_STANDALONE
public static final TextStyle NARROW_STANDALONE
Narrow text for stand-alone use, typically a single letter. For example, day-of-week Monday might output "M".
-
Method Detail
values
public static TextStyle[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TextStyle c : TextStyle.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
valueOf
public static TextStyle valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name -
NullPointerException- if the argument is null
isStandalone
public boolean isStandalone()
Returns true if the Style is a stand-alone style.- Returns:
- true if the style is a stand-alone style.
asStandalone
public TextStyle asStandalone()
Returns the stand-alone style with the same size.- Returns:
- the stand-alone style with the same size
asNormal
public TextStyle asNormal()
Returns the normal style with the same size.- Returns:
- the normal style with the same size
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
