com.bea.p13n.xml.schema
Class RecurringDuration

java.lang.Object
  |
  +--com.bea.p13n.xml.schema.RecurringDuration

public class RecurringDuration

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

This class provides the Java binding for the XML schema type recurringDuration as specified in Section 3.2.7 of XML Schema Part 2: Datatypes.

recurringDuration represents a specific period of time that recurs with a specific frequency, starting from a specific point in time. The value space of timeInstant is the space of timeDurations that recur with a specific timeDuration from a specific timeInstant.

Example: 2001-01-18T09:00:00.0005Z with a duration P1M and period P2D.

Values of th facets duration and period must be specified while creating an instance of RecurringDuration. Otherwise, this class uses defaults of "P0Y" for both duration and period.

See Also:

Serialized Form

Constructor Summary

protected	RecurringDuration() Constructs a new RecurringDuration instance with "P0Y" as the duration and period at the current point in time.
protected	RecurringDuration(TimeInstant instant, TimeDuration duration, TimeDuration period) Constructs a new RecurringDuration instance with the specified duration and period and at the specified point in time.

Method Summary

java.lang.Object	clone() Retuns a copy of this RecurringDuration.
int	compareTo(java.lang.Object anotherObject) Compares this RecurringDuration with another object.
int	compareTo(RecurringDuration anotherRecurringDuration) Compares this RecurringDuration with another RecurringDuration.
static RecurringDuration	createRecurringDuration(java.lang.String instant) Returns a RecurringDuration instance at the specified point in time with a duration of "P0Y" and period of "P0Y".
static RecurringDuration	createRecurringDuration(java.lang.String instant, java.lang.String duration, java.lang.String period) Returns a RecurringDuration instance at the specified point in time with the given duration and period.
static RecurringDuration	createRecurringDuration(TimeInstant instant, TimeDuration duration, TimeDuration period) Returns a RecurringDuration instance at the specified point in time with the given duration and period.
TimeDuration	getDuration() Returns the duration
TimeInstant	getInstant() Returns the point in time
TimeDuration	getPeriod() Returns the period
void	setDuration(TimeDuration duration) Sets the duration
void	setInstant(TimeInstant instant) Sets the point in time
void	setPeriod(TimeDuration period) Sets the period
java.lang.String	toString() Returns a XML schema compliant recurringDuration string expressed as the instant of this Recurringduration.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecurringDuration

protected RecurringDuration()

Constructs a new RecurringDuration instance with "P0Y" as the duration and period at the current point in time.

RecurringDuration

protected RecurringDuration(TimeInstant instant,
                            TimeDuration duration,
                            TimeDuration period)

Constructs a new RecurringDuration instance with the specified duration and period and at the specified point in time.

Parameters:

instant - point in time

duration - durition

period - period

Method Detail

createRecurringDuration

public static RecurringDuration createRecurringDuration(java.lang.String instant)
                                                 throws java.text.ParseException

Returns a RecurringDuration instance at the specified point in time with a duration of "P0Y" and period of "P0Y".

Parameters:

instant - point in time

createRecurringDuration

public static RecurringDuration createRecurringDuration(java.lang.String instant,
                                                        java.lang.String duration,
                                                        java.lang.String period)
                                                 throws java.text.ParseException

Returns a RecurringDuration instance at the specified point in time with the given duration and period.

Parameters:

instant - point in time

duration - duration

period - period

createRecurringDuration

public static RecurringDuration createRecurringDuration(TimeInstant instant,
                                                        TimeDuration duration,
                                                        TimeDuration period)
                                                 throws java.text.ParseException

Returns a RecurringDuration instance at the specified point in time with the given duration and period.

Parameters:

instant - point in time

duration - duration

period - period

getInstant

public TimeInstant getInstant()

Returns the point in time

Returns:

point in time

setInstant

public void setInstant(TimeInstant instant)

Sets the point in time

Parameters:

instant - point in time

getDuration

public TimeDuration getDuration()

Returns the duration

Returns:

duration

setDuration

public void setDuration(TimeDuration duration)

Sets the duration

Parameters:

duration - duration

getPeriod

public TimeDuration getPeriod()

Returns the period

Returns:

period

setPeriod

public void setPeriod(TimeDuration period)

Sets the period

Parameters:

period - period

clone

public java.lang.Object clone()

Retuns a copy of this RecurringDuration.

Returns:

copy

Overrides:

clone in class java.lang.Object

compareTo

public int compareTo(RecurringDuration anotherRecurringDuration)

Compares this RecurringDuration with another RecurringDuration.

Parameters:

anotherRecurringDuration - another RecurringDuration object to be compared.

Returns:

the value 0 if the argument RecurringDuration is equal to this RecurringDuration; a value less than 0 if this RecurringDuration starts before the RecurringDuration argument; and a value greater than 0 if this RecurringDuration starts after the RecurringDuration argument.

Throws:

java.lang.IllegalArgumentException - thrown when the argument has a different duration and period.

compareTo

public int compareTo(java.lang.Object anotherObject)

Compares this RecurringDuration with another object. If the other object is a RecurringDuration, this method behaves like compareTo(RecurringDuration). Otherwise, it throws a ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - the object to be compared

Returns:

the value 0 if the argument RecurringDuration is equal to this RecurringDuration; a value less than 0 if this RecurringDuration starts before the RecurringDuration argument; and a value greater than 0 if this RecurringDuration starts after the RecurringDuration argument.

Throws:

java.lang.IllegalArgumentException - thrown when the argument has a different duration and period.

java.lang.ClassCastException - thrown if the argument is not an instance of TimeInstant.

toString

public java.lang.String toString()

Returns a XML schema compliant recurringDuration string expressed as the instant of this Recurringduration.

Returns:

string value

Overrides:

toString in class java.lang.Object