com.ibm.icu.util
Class DateTimeRule

java.lang.Object
  com.ibm.icu.util.DateTimeRule

All Implemented Interfaces:

Serializable

public class DateTimeRule
extends Object
implements Serializable

DateTimeRule is a class representing a time in a year by a rule specified by month, day of month, day of week and time in the day.

See Also:

Serialized Form

Status:

Stable ICU 3.8.

Field Summary

static int	DOM Date rule type defined by exact day of month.
static int	DOW Date rule type defined by day of week in month.
static int	DOW_GEQ_DOM Date rule type defined by first day of week on or after exact day of month.
static int	DOW_LEQ_DOM Date rule type defined by last day of week on or before exact day of month.
static int	STANDARD_TIME Time rule type for local standard time.
static int	UTC_TIME Time rule type for coordinated universal time.
static int	WALL_TIME Time rule type for local wall time.

Constructor Summary

DateTimeRule(int month, int dayOfMonth, int dayOfWeek, boolean after, int millisInDay, int timeType)
Constructs a DateTimeRule by the first/last day of week on or after/before the day of month and the time rule.

DateTimeRule(int month, int dayOfMonth, int millisInDay, int timeType)
Constructs a DateTimeRule by the day of month and the time rule.

DateTimeRule(int month, int weekInMonth, int dayOfWeek, int millisInDay, int timeType)
Constructs a DateTimeRule by the day of week and its oridinal number and the time rule.

Method Summary

int	getDateRuleType() Gets the date rule type, such as DOM
int	getRuleDayOfMonth() Gets the rule day of month.
int	getRuleDayOfWeek() Gets the rule day of week.
int	getRuleMillisInDay() Gets the rule time in the rule day.
int	getRuleMonth() Gets the rule month.
int	getRuleWeekInMonth() Gets the rule day of week ordinal number in the month.
int	getTimeRuleType() Gets the time rule type
String	toString() Returns a String representation of this DateTimeRule object.

Methods inherited from class java.lang.Object

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

Field Detail

DOM

public static final int DOM

Date rule type defined by exact day of month. For example, March 14.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

DOW

public static final int DOW

Date rule type defined by day of week in month. For example, 2nd Sunday in March.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

DOW_GEQ_DOM

public static final int DOW_GEQ_DOM

Date rule type defined by first day of week on or after exact day of month. For example, 1st Monday on or after March 15.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

DOW_LEQ_DOM

public static final int DOW_LEQ_DOM

Date rule type defined by last day of week on or before exact day of month. For example, last Saturday on or before March 15.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

WALL_TIME

public static final int WALL_TIME

Time rule type for local wall time.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

STANDARD_TIME

public static final int STANDARD_TIME

Time rule type for local standard time.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

UTC_TIME

public static final int UTC_TIME

Time rule type for coordinated universal time.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

Constructor Detail

DateTimeRule

public DateTimeRule(int month,
                    int dayOfMonth,
                    int millisInDay,
                    int timeType)

Constructs a DateTimeRule by the day of month and the time rule. The date rule type for an instance created by this constructor is DOM.

Parameters:

month - The rule month, for example, Calendar.JANUARY

dayOfMonth - The day of month, 1-based.

millisInDay - The milliseconds in the rule date.

timeType - The time type, WALL_TIME or STANDARD_TIME or UTC_TIME.

Status:

Stable ICU 3.8.

DateTimeRule

public DateTimeRule(int month,
                    int weekInMonth,
                    int dayOfWeek,
                    int millisInDay,
                    int timeType)

Constructs a DateTimeRule by the day of week and its oridinal number and the time rule. The date rule type for an instance created by this constructor is DOW.

Parameters:

month - The rule month, for example, Calendar.JANUARY.

weekInMonth - The ordinal number of the day of week. Negative number may be used for specifying a rule date counted from the end of the rule month.

dayOfWeek - The day of week, for example, Calendar.SUNDAY.

millisInDay - The milliseconds in the rule date.

timeType - The time type, WALL_TIME or STANDARD_TIME or UTC_TIME.

Status:

Stable ICU 3.8.

DateTimeRule

public DateTimeRule(int month,
                    int dayOfMonth,
                    int dayOfWeek,
                    boolean after,
                    int millisInDay,
                    int timeType)

Constructs a DateTimeRule by the first/last day of week on or after/before the day of month and the time rule. The date rule type for an instance created by this constructor is either DOM_GEQ_DOM or DOM_LEQ_DOM.

Parameters:

month - The rule month, for example, Calendar.JANUARY

dayOfMonth - The day of month, 1-based.

dayOfWeek - The day of week, for example, Calendar.SUNDAY.

after - true if the rule date is on or after the day of month.

millisInDay - The milliseconds in the rule date.

timeType - The time type, WALL_TIME or STANDARD_TIME or UTC_TIME.

Status:

Stable ICU 3.8.

Method Detail

getDateRuleType

public int getDateRuleType()

Gets the date rule type, such as DOM

Returns:

The date rule type.

Status:

Stable ICU 3.8.

getRuleMonth

public int getRuleMonth()

Gets the rule month.

Returns:

The rule month.

Status:

Stable ICU 3.8.

getRuleDayOfMonth

public int getRuleDayOfMonth()

Gets the rule day of month. When the date rule type is DOW, the value is always 0.

Returns:

The rule day of month

Status:

Stable ICU 3.8.

getRuleDayOfWeek

public int getRuleDayOfWeek()

Gets the rule day of week. When the date rule type is DOM, the value is always 0.

Returns:

The rule day of week.

Status:

Stable ICU 3.8.

getRuleWeekInMonth

public int getRuleWeekInMonth()

Gets the rule day of week ordinal number in the month. When the date rule type is not DOW, the value is always 0.

Returns:

The rule day of week ordinal number in the month.

Status:

Stable ICU 3.8.

getTimeRuleType

public int getTimeRuleType()

Gets the time rule type

Returns:

The time rule type, either WALL_TIME or STANDARD_TIME or UTC_TIME.

Status:

Stable ICU 3.8.

getRuleMillisInDay

public int getRuleMillisInDay()

Gets the rule time in the rule day.

Returns:

The time in the rule day in milliseconds.

Status:

Stable ICU 3.8.

toString

public String toString()

Returns a String representation of this DateTimeRule object. This method is used for debugging purpose only. The string representation can be changed in future version of ICU without any notice.

Overrides:

toString in class Object

Status:

Stable ICU 3.8.