Year (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.types.RecurringDurationBase
- - org.exolab.castor.types.RecurringDuration
  - - org.exolab.castor.types.TimePeriod
    - - org.exolab.castor.types.Year

All Implemented Interfaces:

java.io.Serializable
```
public class Year
extends TimePeriod
```
Deprecated.
since Castor 1.0.6 since this type is not in any recommendation.
Describe an XML schema Year.
The date type is derived from time period by setting up the facet :
- duration to "P1Y"
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

Constructors
Constructor Description

Year()
Deprecated.

Constructors
Constructor	Description
`Year()`	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static java.lang.Object`	`parse(java.lang.String str)`	Deprecated. parse a String and convert it into a java.lang.Object
`static Year`	`parseYear(java.lang.String str)`	Deprecated. parse a String and convert it into a Year
`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`	`setMonth(short month)`	Deprecated. set the Month Field
`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
`java.lang.String`	`toString()`	Deprecated. convert this Year to a string The format is defined by W3C XML Schema draft and ISO8601 i.e (+\|-)CCYY

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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 org.exolab.castor.types.TimePeriod
setFields, setPeriod

- Constructor Detail
  - Year
```
public Year()
```
    Deprecated.
- Method Detail
  - setMonth
```
public void setMonth(short month)
              throws java.lang.UnsupportedOperationException
```
    Deprecated.
    
    Description copied from class: RecurringDuration
    
    set the Month Field
    
    Overrides:
    
    setMonth in class RecurringDuration
    
    Parameters:
    
    month - the value to set up Note 1
    Throws:
    
    java.lang.UnsupportedOperationException
  - 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 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
```
    Deprecated.
    
    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
```
    Deprecated.
    
    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
```
    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

Class Year

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.exolab.castor.types.RecurringDuration

Methods inherited from class org.exolab.castor.types.RecurringDurationBase

Methods inherited from class org.exolab.castor.types.TimePeriod

Constructor Detail

Year

Method Detail

setMonth

setDay

setHour

setMinute

setSecond

setZone

setZoneNegative

toString

parse

parseYear

toDate