org.threeten.bp.format

Enum TextStyle

java.lang.Object

java.lang.Enum<TextStyle>

org.threeten.bp.format.TextStyle

All Implemented Interfaces:

Serializable, Comparable<TextStyle>

public enum TextStyle
extends Enum<TextStyle>

Enumeration of the style of text output to use.

This defines the "size" of the text to be output.

Specification for implementors

This is immutable and thread-safe enum.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL Full text, typically the full description.
NARROW Narrow text, typically a single letter.
SHORT Short text, typically an abbreviation.

Method Summary

Methods

Modifier and Type	Method and Description
static TextStyle	valueOf(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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULL

public static final TextStyle FULL

Full text, 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".

NARROW

public static final TextStyle NARROW

Narrow text, 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