com.ibm.icu.text

Enum RelativeDateTimeFormatter.RelativeDateTimeUnit

java.lang.Object

java.lang.Enum<RelativeDateTimeFormatter.RelativeDateTimeUnit>

com.ibm.icu.text.RelativeDateTimeFormatter.RelativeDateTimeUnit

All Implemented Interfaces:

Serializable, Comparable<RelativeDateTimeFormatter.RelativeDateTimeUnit>

Enclosing class:

RelativeDateTimeFormatter

public static enum RelativeDateTimeFormatter.RelativeDateTimeUnit
extends Enum<RelativeDateTimeFormatter.RelativeDateTimeUnit>

Represents the unit for formatting a relative date. e.g "in 5 days" or "next year"

Status:

Stable ICU 57.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY Specifies that relative unit is day, e.g.
FRIDAY Specifies that relative unit is Friday, e.g.
HOUR Specifies that relative unit is hour, e.g. "1 hour ago", "in 5 hours".
MINUTE Specifies that relative unit is minute, e.g. "1 minute ago", "in 5 minutes".
MONDAY Specifies that relative unit is Monday, e.g.
MONTH Specifies that relative unit is month, e.g.
QUARTER Specifies that relative unit is quarter, e.g.
SATURDAY Specifies that relative unit is Saturday, e.g.
SECOND Specifies that relative unit is second, e.g. "1 second ago", "in 5 seconds".
SUNDAY Specifies that relative unit is Sunday, e.g.
THURSDAY Specifies that relative unit is Thursday, e.g.
TUESDAY Specifies that relative unit is Tuesday, e.g.
WEDNESDAY Specifies that relative unit is Wednesday, e.g.
WEEK Specifies that relative unit is week, e.g.
YEAR Specifies that relative unit is year, e.g.

Method Summary

Modifier and Type	Method and Description
static RelativeDateTimeFormatter.RelativeDateTimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelativeDateTimeFormatter.RelativeDateTimeUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YEAR

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit YEAR

Specifies that relative unit is year, e.g. "last year", "in 5 years".

Status:

Stable ICU 57.

QUARTER

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit QUARTER

Specifies that relative unit is quarter, e.g. "last quarter", "in 5 quarters".

Status:

Stable ICU 57.

MONTH

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit MONTH

Specifies that relative unit is month, e.g. "last month", "in 5 months".

Status:

Stable ICU 57.

WEEK

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit WEEK

Specifies that relative unit is week, e.g. "last week", "in 5 weeks".

Status:

Stable ICU 57.

DAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit DAY

Specifies that relative unit is day, e.g. "yesterday", "in 5 days".

Status:

Stable ICU 57.

HOUR

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit HOUR

Specifies that relative unit is hour, e.g. "1 hour ago", "in 5 hours".

Status:

Stable ICU 57.

MINUTE

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit MINUTE

Specifies that relative unit is minute, e.g. "1 minute ago", "in 5 minutes".

Status:

Stable ICU 57.

SECOND

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit SECOND

Specifies that relative unit is second, e.g. "1 second ago", "in 5 seconds".

Status:

Stable ICU 57.

SUNDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit SUNDAY

Specifies that relative unit is Sunday, e.g. "last Sunday", "this Sunday", "next Sunday", "in 5 Sundays".

Status:

Stable ICU 57.

MONDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit MONDAY

Specifies that relative unit is Monday, e.g. "last Monday", "this Monday", "next Monday", "in 5 Mondays".

Status:

Stable ICU 57.

TUESDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit TUESDAY

Specifies that relative unit is Tuesday, e.g. "last Tuesday", "this Tuesday", "next Tuesday", "in 5 Tuesdays".

Status:

Stable ICU 57.

WEDNESDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit WEDNESDAY

Specifies that relative unit is Wednesday, e.g. "last Wednesday", "this Wednesday", "next Wednesday", "in 5 Wednesdays".

Status:

Stable ICU 57.

THURSDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit THURSDAY

Specifies that relative unit is Thursday, e.g. "last Thursday", "this Thursday", "next Thursday", "in 5 Thursdays".

Status:

Stable ICU 57.

FRIDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit FRIDAY

Specifies that relative unit is Friday, e.g. "last Friday", "this Friday", "next Friday", "in 5 Fridays".

Status:

Stable ICU 57.

SATURDAY

public static final RelativeDateTimeFormatter.RelativeDateTimeUnit SATURDAY

Specifies that relative unit is Saturday, e.g. "last Saturday", "this Saturday", "next Saturday", "in 5 Saturdays".

Status:

Stable ICU 57.

Method Detail

values

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

Returns:

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

valueOf

public static RelativeDateTimeFormatter.RelativeDateTimeUnit 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