org.exolab.castor.types
Class Year

java.lang.Object
  extended byorg.exolab.castor.types.RecurringDurationBase
      extended byorg.exolab.castor.types.RecurringDuration
          extended byorg.exolab.castor.types.TimePeriod
              extended byorg.exolab.castor.types.Year
All Implemented Interfaces:
java.io.Serializable

public class Year
extends TimePeriod

Describe an XML schema Year

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

Version:
$Revision: 1.1.1.1 $
Author:
Arnaud Blandin
See Also:
Serialized Form

Constructor Summary
Year()
           
 
Method Summary
static java.lang.Object parse(java.lang.String str)
          parse a String and convert it into a java.lang.Object
static Year parseYear(java.lang.String str)
          parse a String and convert it into a Year
 void setDay(short day)
          set the Day Field
 void setHour(short hour)
          set the hour field for this recurringDuration
 void setMinute(short minute)
          set the minute field for this recurringDuration
 void setMonth(short month)
          set the Month Field
 void setSecond(short second, short millsecond)
          set the second field for this recurringDuration
 void setZone(short hour, short minute)
          set the time zone fields for this recurringDuration
 void setZoneNegative()
          set the time zone negative field to true
 java.util.Date toDate()
          convert this recurringDuration into a local Date
 java.lang.String toString()
          convert this Year to a string The format is defined by W3C XML Schema draft and ISO8601 i.e (+|-)CCYY
 
Methods inherited from class org.exolab.castor.types.TimePeriod
setFields, setPeriod
 
Methods inherited from class org.exolab.castor.types.RecurringDuration
equal, equals, getCentury, getDay, getMonth, getValues, getYear, isGreater, isLeap, parseRecurringDuration, setCentury, setValues, setYear
 
Methods inherited from class org.exolab.castor.types.RecurringDurationBase
equal, getDuration, getHour, getMilli, getMinute, getPeriod, getSeconds, getZoneHour, getZoneMinute, isGreater, isNegative, isUTC, isZoneNegative, setDuration, setDuration, setNegative, setPeriod, setUTC
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Year

public Year()
Method Detail

setMonth

public void setMonth(short month)
              throws OperationNotSupportedException
Description copied from class: RecurringDuration
set the Month Field

Overrides:
setMonth in class RecurringDuration
Parameters:
month - the value to set up Note 1<month<12
Throws:
OperationNotSupportedException

setDay

public void setDay(short day)
            throws OperationNotSupportedException
Description copied from class: RecurringDuration
set the Day Field

Overrides:
setDay in class RecurringDuration
Parameters:
day - the value to set up Note a validation is done on the day field
Throws:
OperationNotSupportedException

setHour

public void setHour(short hour)
             throws OperationNotSupportedException
Description copied from class: RecurringDurationBase
set the hour field for this recurringDuration

Overrides:
setHour in class RecurringDurationBase
Parameters:
hour - the hour to set
Throws:
OperationNotSupportedException - this exception is thrown when changing the value of the hour field is not allowed

setMinute

public void setMinute(short minute)
               throws OperationNotSupportedException
Description copied from class: RecurringDurationBase
set the minute field for this recurringDuration

Overrides:
setMinute in class RecurringDurationBase
Parameters:
minute - the minute to set
Throws:
OperationNotSupportedException - this exception is thrown when changing the value of the minute field is not allowed

setSecond

public void setSecond(short second,
                      short millsecond)
               throws OperationNotSupportedException
Description copied from class: RecurringDurationBase
set the second field for this recurringDuration

Overrides:
setSecond in class RecurringDurationBase
Parameters:
second - the second to set
millsecond - the millisecond to set
Throws:
OperationNotSupportedException - this exception is thrown when changing the value of the second field is not allowed

setZone

public void setZone(short hour,
                    short minute)
             throws OperationNotSupportedException
Description copied from class: RecurringDurationBase
set the time zone fields for this recurringDuration

Overrides:
setZone in class RecurringDurationBase
Parameters:
hour - the time zone hour to set
minute - the time zone minute to set
Throws:
OperationNotSupportedException - this exception is thrown when changing the value of the time zone fields is not allowed

setZoneNegative

public void setZoneNegative()
                     throws OperationNotSupportedException
Description copied from class: RecurringDurationBase
set the time zone negative field to true

Overrides:
setZoneNegative in class RecurringDurationBase
Throws:
OperationNotSupportedException - this exception is thrown when changing the time zone fields is not allowed

toString

public java.lang.String toString()
convert this Year to a string The format is defined by W3C XML Schema draft and ISO8601 i.e (+|-)CCYY

Overrides:
toString in class RecurringDuration
Returns:
a string representing this Month

parse

public static java.lang.Object parse(java.lang.String str)
                              throws java.text.ParseException
parse a String and convert it into a java.lang.Object

Parameters:
str - the string to parse
Returns:
the java.lang.Object represented by the string
Throws:
java.text.ParseException - a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

parseYear

public static Year parseYear(java.lang.String str)
                      throws java.text.ParseException
parse a String and convert it into a Year

Parameters:
str - the string to parse
Returns:
the Year represented by the string
Throws:
java.text.ParseException - a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

toDate

public java.util.Date toDate()
                      throws java.text.ParseException
Description copied from class: RecurringDuration
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

Overrides:
toDate in class RecurringDuration
Returns:
a local date representing this recurringDuration
Throws:
java.text.ParseException


Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com