java.lang.Object

org.exolab.castor.types.DateTimeBase

org.exolab.castor.types.Date

All Implemented Interfaces:: Serializable, Cloneable

public class Date extends DateTimeBase

Describe an XML Schema Date.

The format is defined by W3C XML Schema Recommendation and ISO8601 i.e (-)CCYY-MM-DD(Z|(+|-)hh:mm)

Version:

$Revision: 7289 $

Author:

Arnaud Blandin, Edward Kuns

See Also:

Field Summary

Fields inherited from class DateTimeBase
EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, MAX_TIME_ZONE_COMPARISON_OFFSET, WRONGLY_PLACED

Modifier and Type

Field

Description

static final int

EQUALS

Public constant referring to a Date/Time comparison result of "equals".

static final int

GREATER_THAN

Public constant referring to a Date/Time comparison result of "greater than".

static final int

INDETERMINATE

Public constant referring to an indeterminate Date/Time comparison.

static final int

LESS_THAN

Public constant referring to a Date/Time comparison result of "less than".

protected static final int

MAX_TIME_ZONE_COMPARISON_OFFSET

When comparing a date/time with a time zone to one without, the recommendation says that 14 hours is the time zone offset to use for comparison.

protected static final String

WRONGLY_PLACED

Convenience String for complaints.
Constructor Summary

Constructors

Constructor

Description

Date()

No-arg constructor.

Date(long dateAsLong)

This constructor is used to convert a long value representing a Date to a new org.exolab.castor.types.Date instance.

Date(short[] values)

Constructs a XML Schema Date instance given all the values of the different fields.

Date(String date)

Constructs a date from a string.

Date(Date dateRef)

This constructor is used to convert a java.util.Date into a new org.exolab.castor.types.Date.
Method Summary

Modifier and Type

Method

Description

short

getHour()

short

getMilli()

short

getMinute()

short

getSeconds()

short[]

getValues()

Returns an array of short with all the fields that describe this Date type.

boolean

hasHour()

//////////////////////// DISALLOWED METHODS ///////////////////////////

boolean

hasMilli()

boolean

hasMinute()

boolean

hasSeconds()

static Object

parse(String str)

parse a String and convert it into an java.lang.Object

static Date

parseDate(String str)

parse a String and convert it into a Date.

void

setHour(short hour)

Sets the hour field for this date/time type.

void

setMilliSecond(short millisecond)

Sets the millisecond field for this date/time type.

void

setMinute(short minute)

set the minute field for this date/time type.

void

setSecond(short second)

Sets the seconds field for this date/time type, not including the fractional seconds.

void

setValues(short[] values)

Sets all the fields by reading the values in an array.

Date

toDate()

Converts this Date into a local java.util.Date.

long

toLong()

Converts this date into a long value.

String

toString()

convert this Date to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM-DD

Methods inherited from class DateTimeBase
addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getCentury, getDay, getMonth, getYear, getZoneHour, getZoneMinute, hasCentury, hasDay, hashCode, hasIsNegative, hasMonth, hasYear, isLeap, isNegative, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setCentury, setDateFormatTimeZone, setDateFormatTimeZone, setDay, setMonth, setNegative, setSecond, setUTC, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar

Modifier and Type

Method

Description

void

addDuration(Duration duration)

Adds a Duration to this Date/Time type as defined in Adding Duration to dateTimes (W3C XML Schema, part 2 appendix E). This version uses the algorithm defined in the document from W3C.

protected void

appendDateString(StringBuffer result)

protected void

appendTimeString(StringBuffer result)

protected void

appendTimeZoneString(StringBuffer result)

DateTimeBase

clone(DateTimeBase dateTime)

int

compareTo(DateTimeBase dateTime)

Compares two date/time data types.

protected boolean

equal(DateTimeBase dateTime)

Returns true if the present instance of date/time type is equal to the parameter.

boolean

equals(Object object)

Overrides the java.lang.Object#equals method.

short

getCentury()

short

getDay()

short

getMonth()

short

getYear()

short

getZoneHour()

short

getZoneMinute()

boolean

hasCentury()

boolean

hasDay()

int

hashCode()

Overrides the java.lang.Object#hashcode method.

boolean

hasIsNegative()

/////////////////////Getter methods//////////////////////////////////////

boolean

hasMonth()

boolean

hasYear()

final boolean

isLeap(int year)

Returns true if the given year represents a leap year.

boolean

isNegative()

/////////////////////Getter methods//////////////////////////////////////

boolean

isUTC()

Returns true if this date/time type is UTC, that is, has a time zone assigned.

boolean

isZoneNegative()

void

normalize()

Normalizes a date/time datatype as defined in W3C XML Schema Recommendation document: if a timeZone is present but it is not Z then we convert the date/time datatype to Z using the addition operation defined in Adding Duration to dateTimes (W3C XML Schema, part 2 appendix E).

protected static int

parseDay(String str, DateTimeBase result, char[] chars, int index, String complaint)

protected static int

parseMonth(String str, DateTimeBase result, char[] chars, int index, String complaint)

protected static int

parseTime(String str, DateTimeBase result, char[] chars, int index, String complaint)

protected static int

parseTimeZone(String str, DateTimeBase result, char[] chars, int index, String complaint)

protected static int

parseYear(String str, DateTimeBase result, char[] chars, int index, String complaint)

/////////// COMMON CODE USED BY EXTENDING CLASSES ///////////////////////

void

setCentury(short century)

Set the century field.

protected void

setDateFormatTimeZone(DateFormat df)

Sets the time zone in the provided DateFormat.

protected void

setDateFormatTimeZone(Calendar calendar)

Sets the time zone in the provided Calendar.

void

setDay(short day)

Sets the Day Field.

void

setMonth(short month)

Sets the Month Field.

void

setNegative()

Set the negative field to true.

void

setSecond(short second, short millsecond)

Sets the seconds field for this date/time type, including fractional seconds.

void

setUTC()

Sets the UTC field.

void

setYear(short year)

Sets the Year field.

void

setZone(short hour, short minute)

Sets the time zone fields for this date/time type.

void

setZoneHour(short hour)

Sets the time zone hour field for this date/time type.

void

setZoneMinute(short minute)

Sets the time zone minute field for this date/time type.

void

setZoneNegative(boolean zoneNegative)

Sets the time zone negative field to true.

Calendar

toCalendar()

converts this Date/Time into a local java Calendar.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- Date
  
  public Date()
  
  No-arg constructor.
- Date
  
  public Date(short[] values)
  
  Constructs a XML Schema Date instance given all the values of the different fields. By default a Date is not UTC and is local.
  
  Parameters:
  
  values - an array of shorts that represent the different fields of Time.
- Date
  
  public Date(long dateAsLong)
  
  This constructor is used to convert a long value representing a Date to a new org.exolab.castor.types.Date instance.
  Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY
  
  Parameters:
  
  dateAsLong - Date represented in from of a long value.
- Date
  
  public Date(Date dateRef)
  
  This constructor is used to convert a java.util.Date into a new org.exolab.castor.types.Date.
  Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY.
  
  Parameters:
  
  dateRef - the java.util.Date to use to construct a new org.exolab.castor.types.Date
- Date
  
  public Date(String date) throws ParseException
  
  Constructs a date from a string.
  
  Parameters:
  
  date - the string representing the date
  
  Throws:
  
  ParseException - a parse exception is thrown if the string to parse does not follow the right format (see the description of this class)
Method Details
- setValues
  public void setValues(short[] values)
  
  Sets all the fields by reading the values in an array.
  If a Time Zone is specified, it has to be set by using setZone.
  
  Specified by:
  
  setValues in class DateTimeBase
  
  Parameters:
  
  values - an array of shorts with the values the array is supposed to be of length 4 and ordered like the following:
  
  century
  
  year
  
  month
  
  day
- getValues
  
  public short[] getValues()
  
  Returns an array of short with all the fields that describe this Date type.
  Note:the time zone is not included.
  
  Specified by:
  
  getValues in class DateTimeBase
  
  Returns:
  
  an array of short with all the fields that describe this Date type.
- toDate
  
  public Date toDate()
  
  Converts this Date into a local java.util.Date.
  
  Specified by:
  
  toDate in class DateTimeBase
  
  Returns:
  
  a local date representing this Date.
- toLong
  
  public long toLong()
  
  Converts this date into a long value.
  
  Returns:
  
  This date instance as a long value.
- toString
  
  public String toString()
  
  convert this Date to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM-DD
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a string representing this Date
- parse
  
  public static Object parse(String str) throws ParseException
  
  parse a String and convert it into an java.lang.Object
  
  Parameters:
  
  str - the string to parse
  
  Returns:
  
  an Object represented by the string
  
  Throws:
  
  ParseException - a parse exception is thrown if the string to parse does not follow the right format (see the description of this class)
- parseDate
  
  public static Date parseDate(String str) throws ParseException
  
  parse a String and convert it into a Date.
  
  Parameters:
  
  str - the string to parse
  
  Returns:
  
  the Date represented by the string
  
  Throws:
  
  ParseException - a parse exception is thrown if the string to parse does not follow the right format (see the description of this class)
- hasHour
  
  public boolean hasHour()
  
  //////////////////////// DISALLOWED METHODS ///////////////////////////
  
  Overrides:
  
  hasHour in class DateTimeBase
- getHour
  
  public short getHour()
  
  Overrides:
  
  getHour in class DateTimeBase
- setHour
  
  public void setHour(short hour)
  
  Description copied from class: DateTimeBase
  
  Sets the hour field for this date/time type.
  
  Overrides:
  
  setHour in class DateTimeBase
  
  Parameters:
  
  hour - the hour to set
- hasMinute
  
  public boolean hasMinute()
  
  Overrides:
  
  hasMinute in class DateTimeBase
- getMinute
  
  public short getMinute()
  
  Overrides:
  
  getMinute in class DateTimeBase
- setMinute
  
  public void setMinute(short minute)
  
  Description copied from class: DateTimeBase
  
  set the minute field for this date/time type.
  
  Overrides:
  
  setMinute in class DateTimeBase
  
  Parameters:
  
  minute - the minute to set.
- hasSeconds
  
  public boolean hasSeconds()
  
  Overrides:
  
  hasSeconds in class DateTimeBase
- getSeconds
  
  public short getSeconds()
  
  Overrides:
  
  getSeconds in class DateTimeBase
- setSecond
  
  public void setSecond(short second)
  
  Description copied from class: DateTimeBase
  
  Sets the seconds field for this date/time type, not including the fractional seconds. Any fractional seconds previously set is unmodified.
  
  Overrides:
  
  setSecond in class DateTimeBase
  
  Parameters:
  
  second - the second to set
- hasMilli
  
  public boolean hasMilli()
  
  Overrides:
  
  hasMilli in class DateTimeBase
- getMilli
  
  public short getMilli()
  
  Overrides:
  
  getMilli in class DateTimeBase
- setMilliSecond
  
  public void setMilliSecond(short millisecond)
  
  Description copied from class: DateTimeBase
  
  Sets the millisecond field for this date/time type.
  
  Overrides:
  
  setMilliSecond in class DateTimeBase
  
  Parameters:
  
  millisecond - the millisecond to set

Class Date

Field Summary

Fields inherited from class DateTimeBase

Constructor Summary

Method Summary

Methods inherited from class DateTimeBase

Methods inherited from class Object

Constructor Details

Date

Date

Date

Date

Date

Method Details

setValues

getValues

toDate

toLong

toString

parse

parseDate

hasHour

getHour

setHour

hasMinute

getMinute

setMinute

hasSeconds

getSeconds

setSecond

hasMilli

getMilli

setMilliSecond