net.fortuna.ical4j.model

Class WeekDay

java.lang.Object

net.fortuna.ical4j.model.WeekDay

All Implemented Interfaces:

java.io.Serializable

public class WeekDay
extends java.lang.Object
implements java.io.Serializable

$Id$ Created: 19/12/2004 Defines a day of the week with a possible offset related to a MONTHLY or YEARLY occurrence.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WeekDay.Day

Field Summary

Fields

Modifier and Type	Field and Description
static WeekDay	FR Friday.
static WeekDay	MO Monday.
static WeekDay	SA Saturday.
static WeekDay	SU Sunday.
static WeekDay	TH Thursday.
static WeekDay	TU Tuesday.
static WeekDay	WE Wednesday.

Constructor Summary

Constructors

Constructor and Description
WeekDay(java.lang.String value)
WeekDay(WeekDay weekDay, int offset) Constructs a new weekday instance based on the specified instance and offset.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object arg0)
static int	getCalendarDay(WeekDay weekday) Returns the corresponding java.util.Calendar.DAY_OF_WEEK constant for the specified WeekDay.
WeekDay.Day	getDay()
static WeekDay	getDay(int calDay) Returns the corresponding day constant to the specified java.util.Calendar.DAY_OF_WEEK property.
static WeekDay	getMonthlyOffset(java.util.Calendar cal) Returns a weekday/offset representation of the specified calendar.
static WeekDay	getNegativeMonthlyOffset(java.util.Calendar cal) Returns a weekday/negative offset representation of the specified calendar.
int	getOffset()
static WeekDay	getWeekDay(java.util.Calendar cal) Returns a weekday representation of the specified calendar.
static WeekDay	getWeekDay(WeekDay.Day day)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SU

public static final WeekDay SU

Sunday.

MO

public static final WeekDay MO

Monday.

TU

public static final WeekDay TU

Tuesday.

WE

public static final WeekDay WE

Wednesday.

TH

public static final WeekDay TH

Thursday.

FR

public static final WeekDay FR

Friday.

SA

public static final WeekDay SA

Saturday.

Constructor Detail

WeekDay

public WeekDay(java.lang.String value)

Parameters:

value - a string representation of a week day

WeekDay

public WeekDay(WeekDay weekDay,
               int offset)

Constructs a new weekday instance based on the specified instance and offset.

Parameters:

weekDay - a week day template for the instance

offset - a month offset value

Method Detail

getDay

public final WeekDay.Day getDay()

Returns:

Returns the day.

getOffset

public final int getOffset()

Returns:

Returns the offset.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getWeekDay

public static WeekDay getWeekDay(WeekDay.Day day)

getWeekDay

public static WeekDay getWeekDay(java.util.Calendar cal)

Returns a weekday representation of the specified calendar.

Parameters:

cal - a calendar (java.util)

Returns:

a weekday instance representing the specified calendar

getMonthlyOffset

public static WeekDay getMonthlyOffset(java.util.Calendar cal)

Returns a weekday/offset representation of the specified calendar.

Parameters:

cal - a calendar (java.util)

Returns:

a weekday instance representing the specified calendar

getNegativeMonthlyOffset

public static WeekDay getNegativeMonthlyOffset(java.util.Calendar cal)

Returns a weekday/negative offset representation of the specified calendar.

Parameters:

cal - a calendar (java.util)

Returns:

a weekday instance representing the specified calendar

getDay

public static WeekDay getDay(int calDay)

Returns the corresponding day constant to the specified java.util.Calendar.DAY_OF_WEEK property.

Parameters:

calDay - a property value of java.util.Calendar.DAY_OF_WEEK

Returns:

a string, or null if an invalid DAY_OF_WEEK property is specified

getCalendarDay

public static int getCalendarDay(WeekDay weekday)

Returns the corresponding java.util.Calendar.DAY_OF_WEEK constant for the specified WeekDay.

Parameters:

weekday - a week day instance

Returns:

the corresponding java.util.Calendar day

equals

public final boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object