net.time4j.tz.model

Enum OffsetIndicator

java.lang.Object

java.lang.Enum<OffsetIndicator>

net.time4j.tz.model.OffsetIndicator

All Implemented Interfaces:

Serializable, Comparable<OffsetIndicator>

public enum OffsetIndicator
extends Enum<OffsetIndicator>

Helps to interprete a timestamp relative to an timezone offset.

Since:

2.2

Author:

Meno Hochschild

See Also:

SimpleTimeZone.UTC_TIME, SimpleTimeZone.STANDARD_TIME, SimpleTimeZone.WALL_TIME

Enum Constant Summary

Enum Constants

Enum Constant and Description
STANDARD_TIME Local standard time (UTC + standard-offset).
UTC_TIME Reference to UTC-offset.
WALL_TIME Local time (UTC + standard-offset + dst-offset).

Method Summary

Modifier and Type	Method and Description
char	getSymbol() Yields the symbol for this indicator as used in tzdb-repository.
static OffsetIndicator	parseSymbol(char symbol) Interpretes given symbol as indicator.
static OffsetIndicator	valueOf(String name) Returns the enum constant of this type with the specified name.
static OffsetIndicator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UTC_TIME

public static final OffsetIndicator UTC_TIME

Reference to UTC-offset.

STANDARD_TIME

public static final OffsetIndicator STANDARD_TIME

Local standard time (UTC + standard-offset).

WALL_TIME

public static final OffsetIndicator WALL_TIME

Local time (UTC + standard-offset + dst-offset).

Method Detail

values

public static OffsetIndicator[] 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 (OffsetIndicator c : OffsetIndicator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OffsetIndicator valueOf(String 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 - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

parseSymbol

public static OffsetIndicator parseSymbol(char symbol)

Interpretes given symbol as indicator.

The TZDB-repository recognizes following letters:

• u, g, z - UTC_TIME
• s - STANDARD_TIME
• w - WALL_TIME

Parameters:

symbol - symbol letter to be parsed as found in TZDB-data

Returns:

offset indicator

Throws:

IllegalArgumentException - if the letter is not supported

Since:

2.2

getSymbol

public char getSymbol()

Yields the symbol for this indicator as used in tzdb-repository.

Returns:

char ("u", "s" or "w")