RecurringDate Class

com.bea.p13n.xml.schema
RecurringDate Class

public class RecurringDate

    extends RecurringDay
    implements Cloneable, Serializable

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

recurringDate represents a date that recurs, specifically a day of the year. Recurring day is a one-year long annually periodic instances.

The value space of month is the set of Gregorian calendar dates specified as --MM-DD.

Example: 05-11, May 11th, that occurs every year.

Hierarchy
Object
  RecurringDay
    RecurringDate
All Implemented Interfaces

Cloneable, Serializable

Field Summary
   
Fields from  com.bea.p13n.xml.schema.RecurringDay
_internal, reference
 

Constructor Summary
RecurringDate()

Constructs a new RecurringDate instance.
RecurringDate(TimeInstant instant)

Constructs a new RecurringDate instance with month and day specified with a timeInstant.
 

Method Summary
public Object
clone()
Returns a copy.
public static RecurringDate
createRecurringDate()
Returns a RecurringDate for the current month and day.
public static RecurringDate
createRecurringDate(String recurringDate)

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

public int
getMonth()
Returns the month (MM) field
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
setMonth(int month)
Sets the month (MM) field
public String
toString()
Returns a string representation in the form of ---DD with the time zone.
 
Methods from  com.bea.p13n.xml.schema.RecurringDay
createRecurringDay, createRecurringDay, getDay, getReference, getTimeZone, setDay, setReference, setTimeZone,
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

RecurringDate

protected RecurringDate()
Constructs a new RecurringDate instance.

RecurringDate

protected RecurringDate(TimeInstant instant)
Constructs a new RecurringDate instance with month and day specified with a timeInstant.
 

Method Detail

clone() Method

public Object clone()
Returns a copy.

Overrides
RecurringDay.clone()

Returns

copy

createRecurringDate() Method

public static RecurringDate createRecurringDate()
Returns a RecurringDate for the current month and day.

Returns

recurring date

createRecurringDate(String) Method

public static RecurringDate createRecurringDate(String recurringDate)
     throws ParseException

Given a string of the form --MM-DD, returns a RecurringDate 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

recurringDate
recurring date

Returns

recurring date

Exceptions

ParseException

getMonth() Method

public int getMonth()
Returns the month (MM) field

Returns

month field

next() Method

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

Overrides
RecurringDay.next()

Returns

next date

Related Topics

RecurringDate.setReference(TimeInstant)

next(TimeInstant) Method

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

Overrides
RecurringDay.next(TimeInstant)

Parameters

instant
reference time instant

Returns

next date

previous() Method

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

Overrides
RecurringDay.previous()

Returns

previous date

Related Topics

RecurringDate.setReference(TimeInstant)

previous(TimeInstant) Method

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

Overrides
RecurringDay.previous(TimeInstant)

Parameters

instant
reference time instant

Returns

previous date

setMonth(int) Method

public void setMonth(int month)
Sets the month (MM) field

Parameters

month
month field

toString() Method

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

Overrides
RecurringDay.toString()

Returns

string