ch.agent.t2.time

Class Day

java.lang.Object

ch.agent.t2.time.Time2

ch.agent.t2.time.Day

All Implemented Interfaces:

TimeIndex, Comparable<TimeIndex>

public class Day
extends Time2

A Day is a Time2 with day resolution. The domain label is daily. This is the only "user-friendy" domain object provided by this package, because it is needed in the implementation.

Author:

Jean-Paul Vetterli

Field Summary

Fields

Modifier and Type	Field and Description
static TimeDomain	DOMAIN A constant holding the domain.
static String	LABEL A constant holding the domain label.

Constructor Summary

Constructors

Constructor and Description
Day(long year, int month, int day) Construct a daily time from the given time components.
Day(String date) Construct a daily time from a string.
Day(TimeIndex time) Construct a daily time from another time object.

Method Summary

Modifier and Type	Method and Description
boolean	isWeekEnd() Return true if the day falls on a weekend.

Methods inherited from class ch.agent.t2.time.Time2

add, asLong, asOffset, compareTo, convert, convert, equals, getDay, getDayByRank, getDayOfWeek, getFractionalSecond, getHour, getMinute, getMonth, getSecond, getTimeDomain, getYear, hashCode, sub, toString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LABEL

public static final String LABEL

A constant holding the domain label.

See Also:

Constant Field Values

DOMAIN

public static final TimeDomain DOMAIN

A constant holding the domain.

Constructor Detail

Day

public Day(TimeIndex time)
    throws T2Exception

Construct a daily time from another time object.

Parameters:

time - a non-null time in the domain daily

Throws:

T2Exception

Day

public Day(String date)
    throws T2Exception

Construct a daily time from a string.

Parameters:

date - a non-null string

Throws:

T2Exception

Day

public Day(long year,
           int month,
           int day)
    throws T2Exception

Construct a daily time from the given time components.

Parameters:

year - a non-negative number

month - a number in [1-12]

day - a number between 1 and the last day of the month

Throws:

T2Exception

Method Detail

isWeekEnd

public boolean isWeekEnd()
                  throws T2Exception

Return true if the day falls on a weekend.

Returns:

true if the day falls on a weekend

Throws:

T2Exception