public abstract class RecurringDurationBase extends Object implements Serializable
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 FormModifier | Constructor and Description |
---|---|
protected |
RecurringDurationBase()
Deprecated.
No-arg constructor.
|
protected |
RecurringDurationBase(String duration,
String period)
Deprecated.
returns a recurringDurationBase with the facets duration and period set
up
|
protected |
RecurringDurationBase(String duration,
String period,
short[] values)
Deprecated.
returns a recurringDurationBase with the facets duration and period set
up but also the fields
|
protected |
RecurringDurationBase(TimeDuration duration,
TimeDuration period)
Deprecated.
Returns a recurringDurationBase with the facets duration and period set.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equal(RecurringDurationBase reccD)
Deprecated.
Returns true if the present instance of Recurring Duration Base is equal
to the parameter.
|
boolean |
equals(Object object)
Deprecated.
Override the java.lang.equals method
|
TimeDuration |
getDuration()
Deprecated.
|
short |
getHour()
Deprecated.
|
short |
getMilli()
Deprecated.
|
short |
getMinute()
Deprecated.
|
TimeDuration |
getPeriod()
Deprecated.
|
short |
getSeconds()
Deprecated.
|
short[] |
getValues()
Deprecated.
returns an array of short with all the fields which describe a
RecurringDurationBase
|
short |
getZoneHour()
Deprecated.
|
short |
getZoneMinute()
Deprecated.
|
boolean |
isGreater(RecurringDurationBase reccD)
Deprecated.
Returns true if the present instance of RecurringDurationBase is greater
than the parameter
|
boolean |
isNegative()
Deprecated.
|
boolean |
isUTC()
Deprecated.
return true if this recurring Duration type is UTC i.e if there is no time zone.
|
boolean |
isZoneNegative()
Deprecated.
|
void |
setDuration(String duration)
Deprecated.
set the duration facet for this recurringDuration
|
void |
setDuration(TimeDuration duration)
Deprecated.
set the duration facet for this recurringDuration
|
void |
setHour(short hour)
Deprecated.
set the hour field for this recurringDuration
|
void |
setMinute(short minute)
Deprecated.
set the minute field for this recurringDuration
|
void |
setNegative()
Deprecated.
set the negative field to true
|
void |
setPeriod(String period)
Deprecated.
set the period facet for this recurringDuration
|
void |
setPeriod(TimeDuration period)
Deprecated.
set the period facet for this recurringDuration
|
void |
setSecond(short second,
short millsecond)
Deprecated.
set the second field for this recurringDuration
|
void |
setUTC()
Deprecated.
set the UTC field to true
|
void |
setValues(short[] values)
Deprecated.
set all the fields by reading the values in an array
|
void |
setZone(short hour,
short minute)
Deprecated.
set the time zone fields for this recurringDuration
|
void |
setZoneNegative()
Deprecated.
set the time zone negative field to true
|
protected RecurringDurationBase()
protected RecurringDurationBase(TimeDuration duration, TimeDuration period)
duration
- the TimeDuration representing the duration facetperiod
- the TimeDuration reprensenting the period facetprotected RecurringDurationBase(String duration, String period) throws IllegalArgumentException
duration
- the String representing the duration facetperiod
- the String reprensenting the period facetIllegalArgumentException
- this exception is thrown when the parameter strings are not
corresponding to valid TimeDurationprotected RecurringDurationBase(String duration, String period, short[] values) throws OperationNotSupportedException
duration
- the String representing the duration facetperiod
- the String reprensenting the period facetvalues
- an array of shorts which contains the values of the fieldsIllegalArgumentException
- this exception is thrown when the values array is not of
length 6.OperationNotSupportedException
setValues(short[])
public void setPeriod(TimeDuration period) throws UnsupportedOperationException
period
- the period to setOperationNotSupportedException
- this exception is thrown when changing the value of the
period facet is not allowedUnsupportedOperationException
public void setPeriod(String period) throws UnsupportedOperationException
period
- the period to setUnsupportedOperationException
- this exception is thrown when changing the value of the
period facet is not allowedpublic void setDuration(TimeDuration duration) throws UnsupportedOperationException
duration
- the period to setUnsupportedOperationException
- this exception is thrown when changing the value of the
duration facet is not allowedpublic void setDuration(String duration) throws UnsupportedOperationException
duration
- the period to setUnsupportedOperationException
- this exception is thrown when changing the value of the
duration facet is not allowedpublic void setHour(short hour) throws UnsupportedOperationException
hour
- the hour to setUnsupportedOperationException
- this exception is thrown when changing the value of the hour
field is not allowedpublic void setMinute(short minute) throws UnsupportedOperationException
minute
- the minute to setUnsupportedOperationException
- this exception is thrown when changing the value of the
minute field is not allowedpublic void setSecond(short second, short millsecond) throws UnsupportedOperationException
second
- the second to setmillsecond
- the millisecond to setUnsupportedOperationException
- this exception is thrown when changing the value of the
second field is not allowedpublic void setZone(short hour, short minute) throws UnsupportedOperationException
hour
- the time zone hour to setminute
- the time zone minute to setUnsupportedOperationException
- this exception is thrown when changing the value of the time
zone fields is not allowedpublic void setValues(short[] values) throws UnsupportedOperationException
values
- an array of shorts with the values the array is supposed to be
of length 6 and ordered like that:
UnsupportedOperationException
- this exception is thrown when changing the value of a time
related field is not allowedpublic void setNegative()
public void setZoneNegative() throws UnsupportedOperationException
UnsupportedOperationException
- this exception is thrown when changing the time zone fields
is not allowedpublic 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(Object object)
equals
in class Object
equal(org.exolab.castor.types.RecurringDurationBase)
public boolean equal(RecurringDurationBase reccD) throws ValidationException
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 instanceValidationException
public boolean isGreater(RecurringDurationBase reccD) throws ValidationException
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
instanceValidationException
Copyright © 2013. All rights reserved.