Class TimePeriod

java.lang.Object

org.exolab.castor.types.RecurringDurationBase

org.exolab.castor.types.RecurringDuration

org.exolab.castor.types.TimePeriod

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Century, Month, Year

public class TimePeriod
extends RecurringDuration

Deprecated.

since Castor 1.0.6 since this type is not in any recommendation.

Describe an XML schema TimePeriod.

The time period type is derived from recurringDuration by setting up the facet:

• period to "P0Y"

Note: This datatype is not included in any recommendation. It was introduced in http://www.w3.org/TR/2000/WD-xmlschema-2-20000407/ and was last in http://www.w3.org/TR/2000/CR-xmlschema-2-20001024/ and was removed by http://www.w3.org/TR/2001/PR-xmlschema-2-20010316/. It was not in the final approved recommendation: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/

Version:

$Revision: 7289 $

Author:

Arnaud Blandin

See Also:

• RecurringDuration
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TimePeriod()	Deprecated.
TimePeriod(String duration)	Deprecated. returns a TimePeriod with the duration facet set up

Method Summary

Modifier and Type	Method	Description
void	setFields(String str)	Deprecated. parse a string to set the fields of a TimePeriod
void	setPeriod(TimeDuration period)	Deprecated. set the period facet for this recurringDuration

Methods inherited from class RecurringDuration

equal, equals, getCentury, getDay, getMonth, getValues, getYear, isGreater, isLeap, parse, parseRecurringDuration, setCentury, setDay, setMonth, setValues, setYear, toDate, toString

Modifier and Type	Method	Description
boolean	equal(RecurringDuration reccD)	Deprecated. Returns true if the present instance of Recurring Duration is equal to the parameter.
boolean	equals(Object object)	Deprecated. Override the java.lang.equals method
short	getCentury()	Deprecated.
short	getDay()	Deprecated.
short	getMonth()	Deprecated.
short[]	getValues()	Deprecated. returns an array of short with all the fields which describe a RecurringDuration
short	getYear()	Deprecated.
boolean	isGreater(RecurringDuration reccD)	Deprecated. Returns true if the present instance of RecurringDuration is greater than the parameter
boolean	isLeap()	Deprecated. 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
static Object	parse(String str)	Deprecated.
static RecurringDuration	parseRecurringDuration(String str)	Deprecated. Parse a String and convert it into a recurringDuration.
void	setCentury(short century)	Deprecated. set the century field
void	setDay(short day)	Deprecated. set the Day Field
void	setMonth(short month)	Deprecated. set the Month Field
void	setValues(short[] values)	Deprecated. set all the fields by reading the values in an array
void	setYear(short year)	Deprecated. set the Year field Note: 0000 is not allowed
Date	toDate()	Deprecated. convert this recurringDuration into a local Date
String	toString()	Deprecated. Convert this recurringDuration to a string

Methods inherited from class RecurringDurationBase

equal, getDuration, getHour, getMilli, getMinute, getPeriod, getSeconds, getZoneHour, getZoneMinute, isGreater, isNegative, isUTC, isZoneNegative, setDuration, setDuration, setHour, setMinute, setNegative, setPeriod, setSecond, setUTC, setZone, setZoneNegative

Modifier and Type	Method	Description
boolean	equal(RecurringDurationBase reccD)	Deprecated. Returns true if the present instance of Recurring Duration Base is equal to the parameter.
TimeDuration	getDuration()	Deprecated.
short	getHour()	Deprecated.
short	getMilli()	Deprecated.
short	getMinute()	Deprecated.
TimeDuration	getPeriod()	Deprecated.
short	getSeconds()	Deprecated.
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	setSecond(short second, short millsecond)	Deprecated. set the second field for this recurringDuration
void	setUTC()	Deprecated. set the UTC field to true
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

Methods inherited from class Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TimePeriod

public TimePeriod()

Deprecated.

TimePeriod

public TimePeriod(String duration)

Deprecated.

returns a TimePeriod with the duration facet set up

Parameters:

duration - the String value of the duration facet

Method Details

setFields

public void setFields(String str)
               throws ParseException

Deprecated.

parse a string to set the fields of a TimePeriod

Parameters:

str - the string to parse

Throws:

ParseException

setPeriod

public void setPeriod(TimeDuration period)
               throws UnsupportedOperationException

Deprecated.

Description copied from class: RecurringDurationBase

set the period facet for this recurringDuration

Overrides:

setPeriod in class RecurringDurationBase

Parameters:

period - the period to set

Throws:

UnsupportedOperationException