com.nitido.nimx.nuggets.wcap
Class WeekDay

java.lang.Object
  com.nitido.nimx.nuggets.wcap.WeekDay

public class WeekDay
extends java.lang.Object

The possible values of day name of a week.

This is a data object that acts as a C style enum. It force the programmer to use a set of predefined values. These predefined values are declared by iCalendar proposed standard (RFC 2445).

The available options are:

• SUN - for Sunday
• MON - for Monday
• TUE - for Tuesday
• WED - for Wednesday
• THU - for Thursday
• FRI - for Friday
• SAT - for Saturday

Field Summary

static WeekDay	FRI Friday
static WeekDay	MON Monday
static WeekDay	SAT Saturday
static java.lang.String	STR_FRI The actual string value of Friday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_MON The actual string value of Monday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_SAT The actual string value of Saturday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_SUN The actual string value of Sunday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_THU The actual string value of Thursday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_TUE The actual string value of Tuesday (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_WED The actual string value of Wednesday (as defined by RFC 2445 and WCAP).
static WeekDay	SUN Sunday
static WeekDay	THU Thursday
static WeekDay	TUE Tuesday
static WeekDay	WED Wednesday

Method Summary

static WeekDay	convertFromInt(int dayInt) Convert a integer into a WeekDay object.
static WeekDay	convertFromString(java.lang.String inStr) Convert a string into a WeekDay object.
boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.lang.String	getStringValue() Get the string value of the object
java.lang.String	toString() Display the object as a string.
java.lang.String	toWcapQuery(WcapNugget nugget) Convert the component into a string that is used for constructing a WCAP query.

Methods inherited from class java.lang.Object

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

Field Detail

STR_SUN

public static final java.lang.String STR_SUN

The actual string value of Sunday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_MON

public static final java.lang.String STR_MON

The actual string value of Monday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_TUE

public static final java.lang.String STR_TUE

The actual string value of Tuesday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_WED

public static final java.lang.String STR_WED

The actual string value of Wednesday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_THU

public static final java.lang.String STR_THU

The actual string value of Thursday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_FRI

public static final java.lang.String STR_FRI

The actual string value of Friday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_SAT

public static final java.lang.String STR_SAT

The actual string value of Saturday (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

SUN

public static final WeekDay SUN

Sunday

MON

public static final WeekDay MON

Monday

TUE

public static final WeekDay TUE

Tuesday

WED

public static final WeekDay WED

Wednesday

THU

public static final WeekDay THU

Thursday

FRI

public static final WeekDay FRI

Friday

SAT

public static final WeekDay SAT

Saturday

Method Detail

getStringValue

public java.lang.String getStringValue()

Get the string value of the object

equals

public boolean equals(java.lang.Object inObj)

Override the default java.lang.Object's equal command. This will compares the content of the fields. In case of a vector or array field, it will compare the content of the field.

Overrides:

equals in class java.lang.Object

convertFromString

public static WeekDay convertFromString(java.lang.String inStr)

Convert a string into a WeekDay object. The string format is defined in the recurrence rule definition of RFC 2445 and iPlanet WCAP. In otherwords, the string convertions are

• "SU" ---> WeekDay.SUN
• "MO" ---> WeekDay.MON
• "TU" ---> WeekDay.TUE
• "WE" ---> WeekDay.WED
• "TH" ---> WeekDay.THU
• "FR" ---> WeekDay.FRI
• "SA" ---> WeekDay.SAT
• Other ---> WeekDay.SUN

convertFromInt

public static WeekDay convertFromInt(int dayInt)

Convert a integer into a WeekDay object. The integer meanings follows how iPlanet Calendar Server 5.2 stores the "first day of week" attribute in the LDAP directory attribute "icsFirstDay". In otherwords, the string convertions are

• "1" ---> WeekDay.SUN
• "2" ---> WeekDay.MON
• "3" ---> WeekDay.TUE
• "4" ---> WeekDay.WED
• "5" ---> WeekDay.THU
• "6" ---> WeekDay.FRI
• "7" ---> WeekDay.SAT
• Other ---> WeekDay.SUN

toWcapQuery

public java.lang.String toWcapQuery(WcapNugget nugget)
                             throws WcapException

Convert the component into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only.

Throws:

WcapException

toString

public java.lang.String toString()

Display the object as a string. This method is mainly used for debugging.

Overrides:

toString in class java.lang.Object