TimeZoneFormat

See also:

• SimpleDateFormat
• TimeZoneNames

TimeZoneFormat

protected TimeZoneFormat (ULocale locale)

The protected constructor for subclassing.

cloneAsThawed

public TimeZoneFormat cloneAsThawed ()

Provides for the clone operation. Any clone is initially unfrozen.

format

public StringBuffer format (Object obj, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Formats an object and appends the resulting text to a given string buffer. If the pos argument identifies a field used by the format, then its indices are set to the beginning and end of the first such field encountered.

format

public String format (TimeZoneFormat.Style style, 
                TimeZone tz, 
                long date, 
                Output<TimeZoneFormat.TimeType> timeType)

Returns the display name of the time zone at the given date for the style. This method takes an extra argument Output<TimeType> timeType in addition to the argument list of format(android.icu.text.TimeZoneFormat.Style, android.icu.util.TimeZone, long). The argument is used for receiving the time type (standard time or daylight saving time, or unknown) actually used for the display name.

format

public final String format (TimeZoneFormat.Style style, 
                TimeZone tz, 
                long date)

Returns the display name of the time zone at the given date for the style.

Note: A style may have fallback styles defined. For example, when GENERIC_LONG is requested, but there is no display name data available for GENERIC_LONG style, the implementation may use GENERIC_LOCATION or LOCALIZED_GMT. See UTS#35 UNICODE LOCALE DATA MARKUP LANGUAGE (LDML) Appendix J: Time Zone Display Name for the details.

formatOffsetISO8601Basic

public final String formatOffsetISO8601Basic (int offset, 
                boolean useUtcIndicator, 
                boolean isShort, 
                boolean ignoreSeconds)

Returns the ISO 8601 basic time zone string for the given offset. For example, "-08", "-0830" and "Z"

formatOffsetISO8601Extended

public final String formatOffsetISO8601Extended (int offset, 
                boolean useUtcIndicator, 
                boolean isShort, 
                boolean ignoreSeconds)

Returns the ISO 8601 extended time zone string for the given offset. For example, "-08:00", "-08:30" and "Z"

formatOffsetLocalizedGMT

public String formatOffsetLocalizedGMT (int offset)

Returns the localized GMT(UTC) offset format for the given offset. The localized GMT offset is defined by;

• GMT format pattern (e.g. "GMT {0}" - see getGMTPattern())
• Offset time pattern (e.g. "+HH:mm" - see getGMTOffsetPattern(android.icu.text.TimeZoneFormat.GMTOffsetPatternType))
• Offset digits (e.g. "0123456789" - see getGMTOffsetDigits())
• GMT zero format (e.g. "GMT" - see getGMTZeroFormat())

formatOffsetShortLocalizedGMT

public String formatOffsetShortLocalizedGMT (int offset)

Returns the short localized GMT(UTC) offset format for the given offset. The short localized GMT offset is defined by;

• GMT format pattern (e.g. "GMT {0}" - see getGMTPattern())
• Offset time pattern (e.g. "+HH:mm" - see getGMTOffsetPattern(android.icu.text.TimeZoneFormat.GMTOffsetPatternType))
• Offset digits (e.g. "0123456789" - see getGMTOffsetDigits())
• GMT zero format (e.g. "GMT" - see getGMTZeroFormat())

formatToCharacterIterator

public AttributedCharacterIterator formatToCharacterIterator (Object obj)

Formats an Object producing an AttributedCharacterIterator. You can use the returned AttributedCharacterIterator to build the resulting String, as well as to determine information about the resulting String.

Each attribute key of the AttributedCharacterIterator will be of type Field. It is up to each Format implementation to define what the legal values are for each attribute in the AttributedCharacterIterator, but typically the attribute key is also used as the attribute value.

The default implementation creates an AttributedCharacterIterator with no attributes. Subclasses that support fields should override this and create an AttributedCharacterIterator with meaningful attributes.

freeze

public TimeZoneFormat freeze ()

Freezes the object.

getDefaultParseOptions

public EnumSet<TimeZoneFormat.ParseOption> getDefaultParseOptions ()

Returns the default parse options used by this TimeZoneFormat instance.

getGMTOffsetDigits

public String getGMTOffsetDigits ()

Returns the decimal digit characters used for localized GMT format in a single string containing from 0 to 9 in the ascending order.

getGMTOffsetPattern

public String getGMTOffsetPattern (TimeZoneFormat.GMTOffsetPatternType type)

Returns the offset pattern used for localized GMT format.

getGMTPattern

public String getGMTPattern ()

Returns the localized GMT format pattern.

getGMTZeroFormat

public String getGMTZeroFormat ()

Returns the localized GMT format string for GMT(UTC) itself (GMT offset is 0).

getInstance

public static TimeZoneFormat getInstance (Locale locale)

Returns a frozen instance of TimeZoneFormat for the given Locale.

Note: The instance returned by this method is frozen. If you want to customize a TimeZoneFormat, you must use cloneAsThawed() to get a thawed copy first.

getInstance

public static TimeZoneFormat getInstance (ULocale locale)

Returns a frozen instance of TimeZoneFormat for the given locale.

Note: The instance returned by this method is frozen. If you want to customize a TimeZoneFormat, you must use cloneAsThawed() to get a thawed copy first.

getTimeZoneNames

public TimeZoneNames getTimeZoneNames ()

Returns the time zone display name data used by this instance.

isFrozen

public boolean isFrozen ()

Determines whether the object has been frozen or not.

parse

public final TimeZone parse (String text)

Returns a TimeZone for the given text.

Note: The behavior of this method is equivalent to parse(java.lang.String, java.text.ParsePosition).

parse

public final TimeZone parse (String text, 
                ParsePosition pos)

Returns a TimeZone by parsing the time zone string according to the given parse position.

Note: This method is equivalent to parse(Style.GENERIC_LOCATION, text, pos, EnumSet.of(ParseOption.ALL_STYLES), timeType).

parse

public TimeZone parse (TimeZoneFormat.Style style, 
                String text, 
                ParsePosition pos, 
                Output<TimeZoneFormat.TimeType> timeType)

Returns a TimeZone by parsing the time zone string according to the parse position, the style and the default parse options.

Note: This method is equivalent to parse(style, text, pos, null, timeType).

parse

public TimeZone parse (TimeZoneFormat.Style style, 
                String text, 
                ParsePosition pos, 
                EnumSet<TimeZoneFormat.ParseOption> options, 
                Output<TimeZoneFormat.TimeType> timeType)

Returns a TimeZone by parsing the time zone string according to the parse position, the style and the parse options.

parseObject

public Object parseObject (String source, 
                ParsePosition pos)

Parses text from a string to produce an object.

The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed object is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned.

parseOffsetISO8601

public final int parseOffsetISO8601 (String text, 
                ParsePosition pos)

Returns offset from GMT(UTC) in milliseconds for the given ISO 8601 basic or extended time zone string. When the given string is not an ISO 8601 time zone string, this method sets the current position as the error index to ParsePosition pos and returns 0.

parseOffsetLocalizedGMT

public int parseOffsetLocalizedGMT (String text, 
                ParsePosition pos)

Returns offset from GMT(UTC) in milliseconds for the given localized GMT offset format string. When the given string cannot be parsed, this method sets the current position as the error index to ParsePosition pos and returns 0.

parseOffsetShortLocalizedGMT

public int parseOffsetShortLocalizedGMT (String text, 
                ParsePosition pos)

Returns offset from GMT(UTC) in milliseconds for the given short localized GMT offset format string. When the given string cannot be parsed, this method sets the current position as the error index to ParsePosition pos and returns 0.

setDefaultParseOptions

public TimeZoneFormat setDefaultParseOptions (EnumSet<TimeZoneFormat.ParseOption> options)

Sets the default parse options.

Note: By default, an instance of TimeZoneFormat created by getInstance(android.icu.util.ULocale) has no parse options set.

setGMTOffsetDigits

public TimeZoneFormat setGMTOffsetDigits (String digits)

Sets the decimal digit characters used for localized GMT format.

setGMTOffsetPattern

public TimeZoneFormat setGMTOffsetPattern (TimeZoneFormat.GMTOffsetPatternType type, 
                String pattern)

Sets the offset pattern for the given offset type.

setGMTPattern

public TimeZoneFormat setGMTPattern (String pattern)

Sets the localized GMT format pattern. The pattern must contain a single argument {0}, for example "GMT {0}".

setGMTZeroFormat

public TimeZoneFormat setGMTZeroFormat (String gmtZeroFormat)

Sets the localized GMT format string for GMT(UTC) itself (GMT offset is 0).

setTimeZoneNames

public TimeZoneFormat setTimeZoneNames (TimeZoneNames tznames)

Sets the time zone display name data to this instance.