|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.exolab.castor.types.RecurringDurationBase
The base class for recurring Duration types.
This base class contains all the time fields (including the time zone ones) and also the facets period and duration
The validation of the time fields is done in the set methods and follows the ISO8601 Date and Time Format
RecurringDuration
,
Time
,
TimeInstant
,
TimePeriod
, Serialized FormMethod Summary | |
boolean |
equal(RecurringDurationBase reccD)
Returns true if the present instance of Recurring Duration Base is equal to the parameter. |
boolean |
equals(java.lang.Object object)
Override the java.lang.equals method |
TimeDuration |
getDuration()
|
short |
getHour()
|
short |
getMilli()
|
short |
getMinute()
|
TimeDuration |
getPeriod()
|
short |
getSeconds()
|
short[] |
getValues()
returns an array of short with all the fields which describe a RecurringDurationBase |
short |
getZoneHour()
|
short |
getZoneMinute()
|
boolean |
isGreater(RecurringDurationBase reccD)
Returns true if the present instance of RecurringDurationBase is greater than the parameter |
boolean |
isNegative()
|
boolean |
isUTC()
return true if this recurring Duration type is UTC i.e if there is no time zone. |
boolean |
isZoneNegative()
|
void |
setDuration(java.lang.String duration)
set the duration facet for this recurringDuration |
void |
setDuration(TimeDuration duration)
set the duration facet for this recurringDuration |
void |
setHour(short hour)
set the hour field for this recurringDuration |
void |
setMinute(short minute)
set the minute field for this recurringDuration |
void |
setNegative()
set the negative field to true |
void |
setPeriod(java.lang.String period)
set the period facet for this recurringDuration |
void |
setPeriod(TimeDuration period)
set the period facet for this recurringDuration |
void |
setSecond(short second,
short millsecond)
set the second field for this recurringDuration |
void |
setUTC()
set the UTC field to true |
void |
setValues(short[] values)
set all the fields by reading the values in an array |
void |
setZone(short hour,
short minute)
set the time zone fields for this recurringDuration |
void |
setZoneNegative()
set the time zone negative field to true |
Methods inherited from class java.lang.Object |
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Method Detail |
public void setPeriod(TimeDuration period) throws OperationNotSupportedException
period
- the period to setpublic void setPeriod(java.lang.String period) throws OperationNotSupportedException
period
- the period to setpublic void setDuration(TimeDuration duration) throws OperationNotSupportedException
duration
- the period to setpublic void setDuration(java.lang.String duration) throws OperationNotSupportedException
duration
- the period to setpublic void setHour(short hour) throws OperationNotSupportedException
hour
- the hour to setpublic void setMinute(short minute) throws OperationNotSupportedException
minute
- the minute to setpublic void setSecond(short second, short millsecond) throws OperationNotSupportedException
second
- the second to setmillsecond
- the millisecond to setpublic void setZone(short hour, short minute) throws OperationNotSupportedException
hour
- the time zone hour to setminute
- the time zone minute to setpublic void setValues(short[] values) throws OperationNotSupportedException
values
- an array of shorts with the values
the array is supposed to be of length 6 and ordered like that:
public void setNegative()
public void setZoneNegative() throws OperationNotSupportedException
public void setUTC()
public TimeDuration getPeriod()
public TimeDuration getDuration()
public short getHour()
public short getMinute()
public short getSeconds()
public short getMilli()
public short getZoneHour()
public short getZoneMinute()
public short[] getValues()
public boolean isUTC()
public boolean isNegative()
public boolean isZoneNegative()
public boolean equals(java.lang.Object object)
equal
public boolean equal(RecurringDurationBase reccD) throws ValidationException
Returns true if the present instance of Recurring Duration Base 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 instancepublic boolean isGreater(RecurringDurationBase reccD) throws ValidationException
Returns true if the present instance of RecurringDurationBase 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 base to compare with the present instance
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |