|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.text.Format
com.ibm.icu.text.UFormat
com.ibm.icu.text.TimeZoneFormat
public class TimeZoneFormat
TimeZoneFormat
supports time zone display name formatting and parsing.
An instance of TimeZoneFormat works as a subformatter of SimpleDateFormat
,
but you can also directly get a new instance of TimeZoneFormat
and
formatting/parsing time zone display names.
ICU implements the time zone display names defined by UTS#35
Unicode Locale Data Markup Language (LDML). TimeZoneNames
represents the
time zone display name data model and this class implements the algorithm for actual
formatting and parsing.
SimpleDateFormat
,
TimeZoneNames
,
Serialized FormNested Class Summary | |
---|---|
static class |
TimeZoneFormat.GMTOffsetPatternType
Offset pattern type enum. |
static class |
TimeZoneFormat.ParseOption
Parse option enum, used for specifying optional parse behavior. |
static class |
TimeZoneFormat.Style
Time zone display format style enum used by format/parse APIs in TimeZoneFormat . |
static class |
TimeZoneFormat.TimeType
Time type enum used for receiving time type (standard time, daylight time or unknown) in TimeZoneFormat APIs. |
Nested classes/interfaces inherited from class java.text.Format |
---|
Format.Field |
Constructor Summary | |
---|---|
protected |
TimeZoneFormat(ULocale locale)
The protected constructor for subclassing. |
Method Summary | |
---|---|
TimeZoneFormat |
cloneAsThawed()
Provides for the clone operation. |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
|
String |
format(TimeZoneFormat.Style style,
TimeZone tz,
long date)
Returns the display name of the time zone at the given date for the style. |
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. |
String |
formatOffsetISO8601(int offset)
Returns the ISO 8601 style (extended format) time zone string for the given offset. |
String |
formatOffsetLocalizedGMT(int offset)
Returns the localized GMT(UTC) offset format for the given offset. |
String |
formatOffsetRFC822(int offset)
Returns the RFC822 style time zone string for the given offset. |
AttributedCharacterIterator |
formatToCharacterIterator(Object obj)
|
TimeZoneFormat |
freeze()
Freezes the object. |
EnumSet<TimeZoneFormat.ParseOption> |
getDefaultParseOptions()
Returns the default parse options used by this TimeZoneFormat instance. |
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. |
String |
getGMTOffsetPattern(TimeZoneFormat.GMTOffsetPatternType type)
Returns the offset pattern used for localized GMT format. |
String |
getGMTPattern()
Returns the localized GMT format pattern. |
String |
getGMTZeroFormat()
Returns the localized GMT format string for GMT(UTC) itself (GMT offset is 0). |
static TimeZoneFormat |
getInstance(ULocale locale)
Returns a frozen instance of TimeZoneFormat for the given locale. |
TimeZoneNames |
getTimeZoneNames()
Returns the time zone display name data used by this instance. |
boolean |
isFrozen()
Determines whether the object has been frozen or not. |
TimeZone |
parse(String text)
Returns a TimeZone for the given text. |
TimeZone |
parse(String text,
ParsePosition pos)
Returns a TimeZone by parsing the time zone string according to
the given parse position. |
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. |
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. |
Object |
parseObject(String source,
ParsePosition pos)
|
int |
parseOffsetISO8601(String text,
ParsePosition pos)
Returns offset from GMT(UTC) in milliseconds for the given ISO 8601 style (extended format) time zone string. |
int |
parseOffsetLocalizedGMT(String text,
ParsePosition pos)
Returns offset from GMT(UTC) in milliseconds for the given localized GMT offset format string. |
int |
parseOffsetRFC822(String text,
ParsePosition pos)
Returns offset from GMT(UTC) in milliseconds for the given RFC822 style time zone string. |
TimeZoneFormat |
setDefaultParseOptions(EnumSet<TimeZoneFormat.ParseOption> options)
Sets the default parse options. |
TimeZoneFormat |
setGMTOffsetDigits(String digits)
Sets the decimal digit characters used for localized GMT format. |
TimeZoneFormat |
setGMTOffsetPattern(TimeZoneFormat.GMTOffsetPatternType type,
String pattern)
Sets the offset pattern for the given offset type. |
TimeZoneFormat |
setGMTPattern(String pattern)
Sets the localized GMT format pattern. |
TimeZoneFormat |
setGMTZeroFormat(String gmtZeroFormat)
Sets the localized GMT format string for GMT(UTC) itself (GMT offset is 0). |
TimeZoneFormat |
setTimeZoneNames(TimeZoneNames tznames)
Sets the time zone display name data to this instance. |
Methods inherited from class com.ibm.icu.text.UFormat |
---|
getLocale |
Methods inherited from class java.text.Format |
---|
clone, format, parseObject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TimeZoneFormat(ULocale locale)
locale
- the localeMethod Detail |
---|
public static TimeZoneFormat getInstance(ULocale locale)
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.
locale
- the locale.
TimeZoneFormat
for the given locale.public TimeZoneNames getTimeZoneNames()
setTimeZoneNames(TimeZoneNames)
public TimeZoneFormat setTimeZoneNames(TimeZoneNames tznames)
tznames
- the time zone display name data.
UnsupportedOperationException
- when this object is frozen.getTimeZoneNames()
public String getGMTPattern()
setGMTPattern(String)
public TimeZoneFormat setGMTPattern(String pattern)
pattern
- the localized GMT format pattern string
IllegalArgumentException
- when the pattern string does not contain "{0}"
UnsupportedOperationException
- when this object is frozen.getGMTPattern()
public String getGMTOffsetPattern(TimeZoneFormat.GMTOffsetPatternType type)
type
- the offset pattern enumsetGMTOffsetPattern(GMTOffsetPatternType, String)
public TimeZoneFormat setGMTOffsetPattern(TimeZoneFormat.GMTOffsetPatternType type, String pattern)
type
- the offset pattern.pattern
- the pattern string.
IllegalArgumentException
- when the pattern string does not have required time field letters.
UnsupportedOperationException
- when this object is frozen.getGMTOffsetPattern(GMTOffsetPatternType)
public String getGMTOffsetDigits()
setGMTOffsetDigits(String)
public TimeZoneFormat setGMTOffsetDigits(String digits)
digits
- a string contains the decimal digit characters from 0 to 9 n the ascending order.
IllegalArgumentException
- when the string did not contain ten characters.
UnsupportedOperationException
- when this object is frozen.getGMTOffsetDigits()
public String getGMTZeroFormat()
setGMTZeroFormat(String)
public TimeZoneFormat setGMTZeroFormat(String gmtZeroFormat)
gmtZeroFormat
- the localized GMT format string for GMT(UTC).
UnsupportedOperationException
- when this object is frozen.getGMTZeroFormat()
public TimeZoneFormat setDefaultParseOptions(EnumSet<TimeZoneFormat.ParseOption> options)
Note: By default, an instance of TimeZoneFormat>
created by {#link getInstance(ULocale)
has no parse options set.
options
- the default parse options.
TimeZoneFormat.ParseOption
public EnumSet<TimeZoneFormat.ParseOption> getDefaultParseOptions()
TimeZoneFormat
instance.
TimeZoneFormat.ParseOption
public final String formatOffsetRFC822(int offset)
offset
- the offset from GMT(UTC) in milliseconds.
IllegalArgumentException
- if the specified offset is out of supported range
(-24 hours < offset < +24 hours).parseOffsetRFC822(String, ParsePosition)
public final String formatOffsetISO8601(int offset)
offset
- the offset from GMT(UTC) in milliseconds.
IllegalArgumentException
- if the specified offset is out of supported range
(-24 hours < offset < +24 hours).parseOffsetISO8601(String, ParsePosition)
public String formatOffsetLocalizedGMT(int offset)
getGMTPattern()
)
getGMTOffsetPattern(GMTOffsetPatternType)
)
getGMTOffsetDigits()
)
getGMTZeroFormat()
)
offset
- the offset from GMT(UTC) in milliseconds.
IllegalArgumentException
- if the specified offset is out of supported range
(-24 hours < offset < +24 hours).parseOffsetLocalizedGMT(String, ParsePosition)
public final String format(TimeZoneFormat.Style style, TimeZone tz, long date)
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.
style
- the style enum (e.g. GENERIC_LONG
, LOCALIZED_GMT
...)tz
- the time zone.date
- the date.
TimeZoneFormat.Style
,
format(Style, TimeZone, long, Output)
public String format(TimeZoneFormat.Style style, TimeZone tz, long date, Output<TimeZoneFormat.TimeType> timeType)
Output<TimeType> timeType
in addition to the argument list of format(Style, 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.
style
- the style enum (e.g. GENERIC_LONG
, LOCALIZED_GMT
...)tz
- the time zone.date
- the date.timeType
- the output argument for receiving the time type (standard/daylight/unknown)
used for the display name, or specify null if the information is not necessary.
TimeZoneFormat.Style
,
format(Style, TimeZone, long)
public final int parseOffsetRFC822(String text, ParsePosition pos)
ParsePosition pos
and returns 0.
text
- the text contains RFC822 style time zone string (e.g. "-0800")
at the position.pos
- the position.
formatOffsetRFC822(int)
public final int parseOffsetISO8601(String text, ParsePosition pos)
ParsePosition pos
and returns 0.
text
- the text contains ISO 8601 style time zone string (e.g. "-08:00", "Z")
at the position.pos
- the position.
formatOffsetISO8601(int)
public int parseOffsetLocalizedGMT(String text, ParsePosition pos)
ParsePosition pos
and returns 0.
text
- the text contains a localized GMT offset string at the position.pos
- the position.
formatOffsetLocalizedGMT(int)
public TimeZone parse(TimeZoneFormat.Style style, String text, ParsePosition pos, EnumSet<TimeZoneFormat.ParseOption> options, Output<TimeZoneFormat.TimeType> timeType)
TimeZone
by parsing the time zone string according to
the parse position, the style and the parse options.
text
- the text contains a time zone string at the position.style
- the format style.pos
- the position.options
- the parse options.timeType
- The output argument for receiving the time type (standard/daylight/unknown),
or specify null if the information is not necessary.
TimeZone
, or null if the input could not be parsed.TimeZoneFormat.Style
,
format(Style, TimeZone, long, Output)
public TimeZone parse(TimeZoneFormat.Style style, String text, ParsePosition pos, Output<TimeZoneFormat.TimeType> timeType)
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)
.
text
- the text contains a time zone string at the position.style
- the format stylepos
- the position.timeType
- The output argument for receiving the time type (standard/daylight/unknown),
or specify null if the information is not necessary.
TimeZone
, or null if the input could not be parsed.TimeZoneFormat.Style
,
parse(Style, String, ParsePosition, EnumSet, Output)
,
format(Style, TimeZone, long, Output)
,
setDefaultParseOptions(EnumSet)
public final TimeZone parse(String text, ParsePosition pos)
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)
.
text
- the text contains a time zone string at the position.pos
- the position.
TimeZone
, or null if the input could not be parsed.parse(Style, String, ParsePosition, EnumSet, Output)
public final TimeZone parse(String text) throws ParseException
TimeZone
for the given text.
Note: The behavior of this method is equivalent to parse(String, ParsePosition)
.
text
- the time zone string
TimeZone
.
ParseException
- when the input could not be parsed as a time zone string.parse(String, ParsePosition)
public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
format
in class Format
public AttributedCharacterIterator formatToCharacterIterator(Object obj)
formatToCharacterIterator
in class Format
public Object parseObject(String source, ParsePosition pos)
parseObject
in class Format
public boolean isFrozen()
isFrozen
in interface Freezable<TimeZoneFormat>
public TimeZoneFormat freeze()
freeze
in interface Freezable<TimeZoneFormat>
public TimeZoneFormat cloneAsThawed()
cloneAsThawed
in interface Freezable<TimeZoneFormat>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |