TextStyle (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.lang.Enum<TextStyle>
  • • java.time.format.TextStyle

• All Implemented Interfaces:
  [Serializable](../../../java/io/Serializable.html "interface in java.io"), [Comparable](../../../java/lang/Comparable.html "interface in java.lang")<[TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format")>

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.
Since:
1.8

• • Enum Constant Summary

  Enum Constants

  Enum Constant	Description
  FULL	Full text, typically the full description.
  FULL_STANDALONE	Full text for stand-alone use, typically the full description.
  NARROW	Narrow text, typically a single letter.
  NARROW_STANDALONE	Narrow text for stand-alone use, typically a single letter.
  SHORT	Short text, typically an abbreviation.
  SHORT_STANDALONE	Short text for stand-alone use, typically an abbreviation.

  • Method Summary

  All Methods Static Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  TextStyle	asNormal​()	Returns the normal style with the same size.
  TextStyle	asStandalone​()	Returns the stand-alone style with the same size.
  boolean	isStandalone​()	Returns true if the Style is a stand-alone style.
  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](../../../java/lang/Enum.html "class in java.lang")  
     `[clone](../../../java/lang/Enum.html#clone--), [compareTo](../../../java/lang/Enum.html#compareTo-E-), [equals](../../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../../java/lang/Enum.html#hashCode--), [name](../../../java/lang/Enum.html#name--), [ordinal](../../../java/lang/Enum.html#ordinal--), [toString](../../../java/lang/Enum.html#toString--), [valueOf](../../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Enum Constant Detail

     * #### FULL  
     public static final [TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format") FULL  
     Full text, typically the full description. For example, day-of-week Monday might output "Monday".  
     * #### FULL\_STANDALONE  
     public static final [TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format") 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](../../../java/time/format/TextStyle.html "enum in java.time.format") SHORT  
     Short text, typically an abbreviation. For example, day-of-week Monday might output "Mon".  
     * #### SHORT\_STANDALONE  
     public static final [TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format") 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](../../../java/time/format/TextStyle.html "enum in java.time.format") NARROW  
     Narrow text, typically a single letter. For example, day-of-week Monday might output "M".  
     * #### NARROW\_STANDALONE  
     public static final [TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format") 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](../../../java/time/format/TextStyle.html "enum in java.time.format")[] 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](../../../java/time/format/TextStyle.html "enum in java.time.format") valueOf​([String](../../../java/lang/String.html "class in java.lang") 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](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- 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](../../../java/time/format/TextStyle.html "enum in java.time.format") asStandalone​()  
    Returns the stand-alone style with the same size.  
    Returns:  
    the stand-alone style with the same size  
    * #### asNormal  
    public [TextStyle](../../../java/time/format/TextStyle.html "enum in java.time.format") asNormal​()  
    Returns the normal style with the same size.  
    Returns:  
    the normal style with the same size

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.