com.ibm.icu.text

Class TimeZoneNames.MatchInfo

java.lang.Object

com.ibm.icu.text.TimeZoneNames.MatchInfo

Enclosing class:

TimeZoneNames

public static class TimeZoneNames.MatchInfo
extends Object

A MatchInfo represents a time zone name match used by TimeZoneNames.find(CharSequence, int, EnumSet).

Status:

Draft ICU 49 (Retain).

Constructor Summary

Constructors

Constructor and Description
MatchInfo(TimeZoneNames.NameType nameType, String tzID, String mzID, int matchLength) Constructing a MatchInfo.

Method Summary

Modifier and Type	Method and Description
int	matchLength() Returns the match length.
String	mzID() Returns the meta zone ID, or null if not available.
TimeZoneNames.NameType	nameType() Returns the time zone name type.
String	tzID() Returns the time zone ID, or null if not available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MatchInfo

public MatchInfo(TimeZoneNames.NameType nameType,
                 String tzID,
                 String mzID,
                 int matchLength)

Constructing a MatchInfo.

Parameters:

nameType - the name type enum.

tzID - the time zone ID, or null

mzID - the meta zone ID, or null

matchLength - the match length.

Throws:

IllegalArgumentException - when 1) nameType is null, or 2) both tzID and mzID are null, or 3) matchLength is 0 or smaller.

See Also:

TimeZoneNames.NameType

Status:

Draft ICU 49 (Retain).

Method Detail

tzID

public String tzID()

Returns the time zone ID, or null if not available.

Note: A MatchInfo must have either a time zone ID or a meta zone ID.

Returns:

the time zone ID, or null.

See Also:

mzID()

Status:

Draft ICU 49 (Retain).

mzID

public String mzID()

Returns the meta zone ID, or null if not available.

Note: A MatchInfo must have either a time zone ID or a meta zone ID.

Returns:

the meta zone ID, or null.

See Also:

tzID()

Status:

Draft ICU 49 (Retain).

nameType

public TimeZoneNames.NameType nameType()

Returns the time zone name type.

Returns:

the time zone name type enum.

See Also:

TimeZoneNames.NameType

Status:

Draft ICU 49 (Retain).

matchLength

public int matchLength()

Returns the match length.

Returns:

the match length.

Status:

Draft ICU 49 (Retain).