RecurringDay Class

com.bea.p13n.xml.schema
RecurringDay Class

public class RecurringDay

    extends Object
    implements Cloneable, Serializable

This class provides the Java biding for the XML schema type recurringDay as specified in Section 3.3.32 of XML Schema Part 2: Datatypes.

recurringDay represents a day of the month that recurs every month.

Lexical Representation: Left truncated representation for date as ----DD.

Check with the spec. Sec 3.3.32 specified the lexical representation as ---DD and not as ----DD. Verify this.

Example: ----11, 11th, that occurs every month.

Hierarchy
Object
  RecurringDay
All Implemented Interfaces

Cloneable, Serializable
Direct Known Subclasses

RecurringDate

Field Summary
protected RecurringDuration
_internal
RecurringDuration
protected TimeInstant
reference
TimeInstant
 

Constructor Summary
RecurringDay()

Constructs a new RecurringDay instance.
RecurringDay(TimeInstant instant)

Constructs a new RecurringDay instance with the with a timeInstant.
 

Method Summary
public Object
clone()
Returns a copy.
public static RecurringDay
createRecurringDay()
Returns a RecurringDay for the current day.
public static RecurringDay
createRecurringDay(String recurringDay)

Given a string of the form ----DD, returns a RecurringDay instance.

public int
getDay()
Returns the day (DD) field
public TimeInstant
getReference()
Returns the reference instant.
public TimeZone
getTimeZone()
Returns the time zone
public Date
next()
Returns the next date based on the reference time instant.
public Date
next(TimeInstant instant)
Returns the next date with repsect to the specified time instant.
public Date
previous()
Returns the previous date based on the reference time instant.
public Date
previous(TimeInstant instant)
Returns the previous date with repsect to the specified time instant.
public void
setDay(int day)
Sets the day (DD) field
public void
setReference(TimeInstant reference)
Sets the reference instant.
public void
setTimeZone(TimeZone timeZone)
Sets the time zone
public String
toString()
Returns a string representation in the form of ----DD with the time zone.
 
Methods from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   

Field Detail

_internal

protected RecurringDuration _internal

reference

protected TimeInstant reference

 

Constructor Detail

RecurringDay

protected RecurringDay()
Constructs a new RecurringDay instance.

RecurringDay

protected RecurringDay(TimeInstant instant)
Constructs a new RecurringDay instance with the with a timeInstant.
 

Method Detail

clone() Method

public Object clone()
Returns a copy.

Overrides
Object.clone()

Returns

copy

createRecurringDay() Method

public static RecurringDay createRecurringDay()
Returns a RecurringDay for the current day.

Returns

recurring date

createRecurringDay(String) Method

public static RecurringDay createRecurringDay(String recurringDay)
     throws ParseException

Given a string of the form ----DD, returns a RecurringDay instance. The argument may optionally include the timezone specified as "Z" or as <+/->hh:mm.

It is invalid to prepend the argument string with a "+" or "-" (minus) symbol.

Parameters

recurringDay
recurring date

Returns

recurring date

Exceptions

ParseException

getDay() Method

public int getDay()
Returns the day (DD) field

Returns

day field

getReference() Method

public TimeInstant getReference()
Returns the reference instant.

Returns

reference time instant

getTimeZone() Method

public TimeZone getTimeZone()
Returns the time zone

Returns

time zone

next() Method

public Date next()
Returns the next date based on the reference time instant.

Returns

next date

Related Topics

RecurringDay.setReference(TimeInstant)

next(TimeInstant) Method

public Date next(TimeInstant instant)
Returns the next date with repsect to the specified time instant.

Parameters

instant
reference time instant

Returns

next date

previous() Method

public Date previous()
Returns the previous date based on the reference time instant.

Returns

previous date

Related Topics

RecurringDay.setReference(TimeInstant)

previous(TimeInstant) Method

public Date previous(TimeInstant instant)
Returns the previous date with repsect to the specified time instant.

Parameters

instant
reference time instant

Returns

previous date

setDay(int) Method

public void setDay(int day)
Sets the day (DD) field

Parameters

day
day field

setReference(TimeInstant) Method

public void setReference(TimeInstant reference)
Sets the reference instant.

Parameters

reference
reference time instant

setTimeZone(TimeZone) Method

public void setTimeZone(TimeZone timeZone)
Sets the time zone

Parameters

timeZone
time zone

toString() Method

public String toString()
Returns a string representation in the form of ----DD with the time zone.

Overrides
Object.toString()

Returns

string