Class TimeZoneNameProvider

java.lang.Object
java.util.spi.LocaleServiceProvider
java.util.spi.TimeZoneNameProvider
public abstract class TimeZoneNameProvider extends LocaleServiceProvider
An abstract class for service providers that provide localized time zone names for the TimeZone class. The localized time zone names available from the implementations of this class are also the source for the DateFormatSymbols.getZoneStrings() method.
Since:
1.6

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TimeZoneNameProvider()
    Sole constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    getDisplayName(String ID, boolean daylight, int style, Locale locale)
    Returns a name for the given time zone ID that's suitable for presentation to the user in the specified locale.
    String
    getGenericDisplayName(String ID, int style, Locale locale)
    Returns a generic name for the given time zone ID that's suitable for presentation to the user in the specified locale.

    Methods declared in class LocaleServiceProvider

    getAvailableLocales, isSupportedLocale
    Modifier and Type
    Method
    Description
    abstract Locale[]
    getAvailableLocales()
    Returns an array of all locales for which this locale service provider can provide localized objects or names.
    boolean
    isSupportedLocale(Locale locale)
    Returns true if the given locale is supported by this locale service provider.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • TimeZoneNameProvider

      protected TimeZoneNameProvider()
      Sole constructor. (For invocation by subclass constructors, typically implicit.)

  • Method Details

    • getDisplayName

      public abstract String getDisplayName(String ID, boolean daylight, int style, Locale locale)
      Returns a name for the given time zone ID that's suitable for presentation to the user in the specified locale. The given time zone ID is "GMT" or one of the names defined using "Zone" entries in the "tz database", a public domain time zone database at https://www.iana.org/time-zones. The data of this database is contained in a file whose name starts with "tzdata", and the specification of the data format is part of the zic.8 man page, which is contained in a file whose name starts with "tzcode".

      If daylight is true, the method should return a name appropriate for daylight saving time even if the specified time zone has not observed daylight saving time in the past.

      Parameters:
      ID - a time zone ID string
      daylight - if true, return the daylight saving name.
      style - either TimeZone.LONG or TimeZone.SHORT
      locale - the desired locale
      Returns:
      the human-readable name of the given time zone in the given locale, or null if it's not available.
      Throws:
      IllegalArgumentException - if style is invalid, or locale isn't one of the locales returned from getAvailableLocales().
      NullPointerException - if ID or locale is null
      External Specifications
      See Also:

    • getGenericDisplayName

      public String getGenericDisplayName(String ID, int style, Locale locale)
      Returns a generic name for the given time zone ID that's suitable for presentation to the user in the specified locale. Generic time zone names are neutral from standard time and daylight saving time. For example, "PT" is the short generic name of time zone ID America/Los_Angeles, while its short standard time and daylight saving time names are "PST" and "PDT", respectively. Refer to getDisplayName for valid time zone IDs.

      The default implementation of this method returns null.

      Parameters:
      ID - a time zone ID string
      style - either TimeZone.LONG or TimeZone.SHORT
      locale - the desired locale
      Returns:
      the human-readable generic name of the given time zone in the given locale, or null if it's not available.
      Throws:
      IllegalArgumentException - if style is invalid, or locale isn't one of the locales returned from getAvailableLocales().
      NullPointerException - if ID or locale is null
      Since:
      1.8