org.exolab.castor.types
Class Month

java.lang.Object
  extended by org.exolab.castor.types.RecurringDurationBase
      extended by org.exolab.castor.types.RecurringDuration
          extended by org.exolab.castor.types.TimePeriod
              extended by org.exolab.castor.types.Month
All Implemented Interfaces:
java.io.Serializable

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

public class Month
extends TimePeriod

Describe an XML schema Month.

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

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:
Serialized Form

Constructor Summary
Month()
          Deprecated.  
 
Method Summary
static java.lang.Object parse(java.lang.String str)
          Deprecated.  
static Month parseMonth(java.lang.String str)
          Deprecated. parse a String and convert it into a Month
 void setDay(short day)
          Deprecated. set the Day Field
 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 setSecond(short second, short millsecond)
          Deprecated. set the second field for this recurringDuration
 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
 java.util.Date toDate()
          Deprecated. 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.
 java.lang.String toString()
          Deprecated. convert this Month to a string The format is defined by W3C XML Schema draft and ISO8601 i.e (+|-)CCYY-MM
 
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, setMonth, 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
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Month

public Month()
Deprecated. 
Method Detail

setDay

public void setDay(short day)
            throws java.lang.UnsupportedOperationException
Deprecated. 
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:
java.lang.UnsupportedOperationException

setHour

public void setHour(short hour)
             throws java.lang.UnsupportedOperationException
Deprecated. 
Description copied from class: RecurringDurationBase
set the hour field for this recurringDuration

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

setMinute

public void setMinute(short minute)
               throws java.lang.UnsupportedOperationException
Deprecated. 
Description copied from class: RecurringDurationBase
set the minute field for this recurringDuration

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

setSecond

public void setSecond(short second,
                      short millsecond)
               throws java.lang.UnsupportedOperationException
Deprecated. 
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:
java.lang.UnsupportedOperationException - this exception is thrown when changing the value of the second field is not allowed

setZone

public void setZone(short hour,
                    short minute)
             throws java.lang.UnsupportedOperationException
Deprecated. 
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:
java.lang.UnsupportedOperationException - this exception is thrown when changing the value of the time zone fields is not allowed

setZoneNegative

public void setZoneNegative()
                     throws java.lang.UnsupportedOperationException
Deprecated. 
Description copied from class: RecurringDurationBase
set the time zone negative field to true

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

toString

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

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
Deprecated. 
Throws:
java.text.ParseException

parseMonth

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

Parameters:
str - the string to parse
Returns:
the Month 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
Deprecated. 
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-2008. All rights reserved http://www.intalio.com