Public Member Functions | |
RecurringDuration () | |
RecurringDuration (TimeDuration duration, TimeDuration period) | |
RecurringDuration (String duration, String period) | |
RecurringDuration (String duration, String period, short[] values) throws OperationNotSupportedException | |
void | setCentury (short century) |
void | setYear (short year) throws OperationNotSupportedException |
void | setMonth (short month) throws OperationNotSupportedException |
void | setDay (short day) throws OperationNotSupportedException |
boolean | isLeap () |
void | setValues (short[] values) throws OperationNotSupportedException |
short | getCentury () |
short | getYear () |
short | getMonth () |
short | getDay () |
short[] | getValues () |
Date | toDate () throws ParseException |
String | toString () |
boolean | equals (Object object) |
boolean | equal (RecurringDuration reccD) throws ValidationException |
boolean | isGreater (RecurringDuration reccD) throws ValidationException |
Static Public Member Functions | |
static Object | parse (String str) throws ParseException |
static RecurringDuration | parseRecurringDuration (String str) throws ParseException |
Represents recurringDuration utterly a recurringDuration must contain all the fields :
(+|-)CCYY-MM-DDThh:mm:ss.sss(Z|(+|-)hh:mm)
The validation of the date fields is done in the set methods and follows the ISO8601 Date and Time Format
It is possible to omit higher components by using '-'.
org.exolab.castor.types.RecurringDuration.RecurringDuration | ( | ) |
org.exolab.castor.types.RecurringDuration.RecurringDuration | ( | TimeDuration | duration, | |
TimeDuration | period | |||
) |
returns a recurringDuration with the facets duration and period set up
duration | the TimeDuration representing the duration facet | |
period | the TimeDuration reprensenting the period facet |
org.exolab.castor.types.RecurringDuration.RecurringDuration | ( | String | duration, | |
String | period | |||
) |
returns a recurringDuration with the facets duration and period set up
duration | the String representing the duration facet | |
period | the String reprensenting the period facet |
org.exolab.castor.types.RecurringDuration.RecurringDuration | ( | String | duration, | |
String | period, | |||
short[] | values | |||
) | throws OperationNotSupportedException |
returns a recurringDuration with the facets duration and period set up but also the fields
duration | the String representing the duration facet | |
period | the String reprensenting the period facet | |
values | an array of shorts which contains the values of the fields |
References org.exolab.castor.types.RecurringDuration.setValues().
boolean org.exolab.castor.types.RecurringDuration.equal | ( | RecurringDuration | reccD | ) | throws ValidationException |
Returns true if the present instance of Recurring Duration is equal to the parameter.
The equals relation is the following :
rd1 equals rd2
iff each field of rd1 is equal to the corresponding field of rd2
reccD | the recurring duration to compare with the present instance |
References org.exolab.castor.types.TimeDuration.equals(), org.exolab.castor.types.RecurringDuration.equals(), org.exolab.castor.types.RecurringDuration.getCentury(), org.exolab.castor.types.RecurringDuration.getDay(), org.exolab.castor.types.RecurringDurationBase.getDuration(), org.exolab.castor.types.RecurringDurationBase.getHour(), org.exolab.castor.types.RecurringDurationBase.getMilli(), org.exolab.castor.types.RecurringDurationBase.getMinute(), org.exolab.castor.types.RecurringDuration.getMonth(), org.exolab.castor.types.RecurringDurationBase.getPeriod(), org.exolab.castor.types.RecurringDurationBase.getSeconds(), org.exolab.castor.types.RecurringDuration.getYear(), org.exolab.castor.types.RecurringDurationBase.getZoneHour(), org.exolab.castor.types.RecurringDurationBase.getZoneMinute(), org.exolab.castor.types.RecurringDurationBase.isNegative(), and org.exolab.castor.types.RecurringDurationBase.isUTC().
Referenced by org.exolab.castor.types.RecurringDuration.equals().
boolean org.exolab.castor.types.RecurringDuration.equals | ( | Object | object | ) |
Override the java.lang.equals method
Reimplemented from org.exolab.castor.types.RecurringDurationBase.
References org.exolab.castor.types.RecurringDuration.equal(), and org.exolab.castor.core.exceptions.CastorException.printStackTrace().
Referenced by org.exolab.castor.types.RecurringDuration.equal(), and org.exolab.castor.types.RecurringDuration.isGreater().
short org.exolab.castor.types.RecurringDuration.getCentury | ( | ) |
Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler.setValue(), org.exolab.castor.types.Year.toString(), and org.exolab.castor.types.Month.toString().
short org.exolab.castor.types.RecurringDuration.getDay | ( | ) |
short org.exolab.castor.types.RecurringDuration.getMonth | ( | ) |
Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.Month.toString().
short [] org.exolab.castor.types.RecurringDuration.getValues | ( | ) |
returns an array of short with all the fields which describe a RecurringDuration
Reimplemented from org.exolab.castor.types.RecurringDurationBase.
References org.exolab.castor.types.RecurringDuration.getCentury(), org.exolab.castor.types.RecurringDuration.getDay(), org.exolab.castor.types.RecurringDurationBase.getHour(), org.exolab.castor.types.RecurringDurationBase.getMilli(), org.exolab.castor.types.RecurringDurationBase.getMinute(), org.exolab.castor.types.RecurringDuration.getMonth(), org.exolab.castor.types.RecurringDurationBase.getSeconds(), org.exolab.castor.types.RecurringDuration.getYear(), org.exolab.castor.types.RecurringDurationBase.getZoneHour(), and org.exolab.castor.types.RecurringDurationBase.getZoneMinute().
Referenced by org.exolab.castor.types.RecurringDuration.isGreater().
short org.exolab.castor.types.RecurringDuration.getYear | ( | ) |
Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), org.exolab.castor.types.Year.toString(), and org.exolab.castor.types.Month.toString().
boolean org.exolab.castor.types.RecurringDuration.isGreater | ( | RecurringDuration | reccD | ) | throws ValidationException |
Returns true if the present instance of RecurringDuration is greater than the parameter
Note : the order relation follows the W3C XML Schema draft i.e rd1 < rd2
iff rd2-rd1>0
reccD | the recurring duration to compare with the present instance |
References org.exolab.castor.types.TimeDuration.equals(), org.exolab.castor.types.RecurringDuration.equals(), org.exolab.castor.types.RecurringDurationBase.getDuration(), org.exolab.castor.types.RecurringDurationBase.getPeriod(), and org.exolab.castor.types.RecurringDuration.getValues().
boolean org.exolab.castor.types.RecurringDuration.isLeap | ( | ) |
return true if the year field represents a leap year A specific year is a leap year if it is either evenly divisible by 400 OR evenly divisible by 4 and not evenly divisible by 100
Referenced by org.exolab.castor.types.RecurringDuration.setDay().
static Object org.exolab.castor.types.RecurringDuration.parse | ( | String | str | ) | throws ParseException [static] |
Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.
References org.exolab.castor.types.RecurringDuration.parseRecurringDuration().
static RecurringDuration org.exolab.castor.types.RecurringDuration.parseRecurringDuration | ( | String | str | ) | throws ParseException [static] |
parse a String and convert it into a recurringDuration
str | the string to parse |
ParseException | a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class) |
References org.exolab.castor.types.RecurringDuration.getDay(), org.exolab.castor.types.RecurringDurationBase.isNegative(), org.exolab.castor.types.RecurringDurationBase.isUTC(), org.exolab.castor.types.RecurringDuration.RecurringDuration(), org.exolab.castor.types.RecurringDuration.setCentury(), org.exolab.castor.types.RecurringDuration.setDay(), org.exolab.castor.types.RecurringDurationBase.setHour(), org.exolab.castor.types.RecurringDurationBase.setMinute(), org.exolab.castor.types.RecurringDuration.setMonth(), org.exolab.castor.types.RecurringDurationBase.setNegative(), org.exolab.castor.types.RecurringDurationBase.setSecond(), org.exolab.castor.types.RecurringDuration.setYear(), org.exolab.castor.types.RecurringDurationBase.setZone(), and org.exolab.castor.types.RecurringDurationBase.setZoneNegative().
Referenced by org.exolab.castor.types.RecurringDuration.parse().
void org.exolab.castor.types.RecurringDuration.setCentury | ( | short | century | ) |
set the century field
century | the value to set up |
Referenced by org.exolab.castor.types.Century.parseCentury(), org.exolab.castor.types.Month.parseMonth(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.Year.parseYear(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().
void org.exolab.castor.types.RecurringDuration.setDay | ( | short | day | ) | throws OperationNotSupportedException |
set the Day Field
day | the value to set up Note a validation is done on the day field |
Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.
References org.exolab.castor.types.RecurringDuration.isLeap().
Referenced by org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().
void org.exolab.castor.types.RecurringDuration.setMonth | ( | short | month | ) | throws OperationNotSupportedException |
month | the value to set up Note 1<month<12 |
Reimplemented in org.exolab.castor.types.Century, and org.exolab.castor.types.Year.
Referenced by org.exolab.castor.types.Month.parseMonth(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().
void org.exolab.castor.types.RecurringDuration.setValues | ( | short[] | values | ) | throws OperationNotSupportedException |
set all the fields by reading the values in an array
values | an array of shorts with the values the array is supposed to be of length 10 and ordered like that:
|
OperationNotSupportedException | this exception is thrown if changing the value of one field os not allowed |
Reimplemented from org.exolab.castor.types.RecurringDurationBase.
References org.exolab.castor.types.RecurringDuration.setCentury(), org.exolab.castor.types.RecurringDuration.setDay(), org.exolab.castor.types.RecurringDurationBase.setHour(), org.exolab.castor.types.RecurringDurationBase.setMinute(), org.exolab.castor.types.RecurringDuration.setMonth(), org.exolab.castor.types.RecurringDurationBase.setSecond(), org.exolab.castor.types.RecurringDuration.setYear(), and org.exolab.castor.types.RecurringDurationBase.setZone().
Referenced by org.exolab.castor.types.RecurringDuration.RecurringDuration().
void org.exolab.castor.types.RecurringDuration.setYear | ( | short | year | ) | throws OperationNotSupportedException |
set the Year field Note: 0000 is not allowed
the | year to set up |
Reimplemented in org.exolab.castor.types.Century.
Referenced by org.exolab.castor.types.Month.parseMonth(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.Year.parseYear(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().
Date org.exolab.castor.types.RecurringDuration.toDate | ( | ) | throws ParseException |
convert this recurringDuration into a local Date
Note : Be aware a the 'local' property of the date i.e toDate()
will de the conversion between a UTC date and your computer date format. For instance if you have set up your computer time zone on the Pacific Day Time the conversion of 2000-10-20T00:00:00.000
into a java.util.Date
will return Thu Oct 19 17:00:00 PDT 2000
ParseException |
Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.
References org.exolab.castor.types.RecurringDurationBase.getZoneHour(), org.exolab.castor.types.RecurringDurationBase.getZoneMinute(), org.exolab.castor.types.RecurringDurationBase.isUTC(), org.exolab.castor.types.RecurringDurationBase.isZoneNegative(), and org.exolab.castor.types.Date.parse().
String org.exolab.castor.types.RecurringDuration.toString | ( | ) |
Convert this recurringDuration to a string
The format is defined by W3C XML Schema draft and ISO8601 i.e (+|-)CCYY-MM-DDThh:mm:ss.sss(Z|(+|-)hh:mm)
Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.
Referenced by org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler.getValue(), and org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.getValue().