java.lang.Object

org.exolab.castor.types.DateTimeBase

org.exolab.castor.types.DateTime

All Implemented Interfaces:: Serializable, Cloneable

public class DateTime extends DateTimeBase

Describe an XML schema DateTime.

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

Version:

$Revision: 0000 $

Author:

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

DateTime()

Default constructor.

DateTime(long dateAsLong)

Creates a new XML Schema DateTime instance from a long that represents a Date.

DateTime(short[] values)

Constructs a XML Schema DateTime instance given all the values of the different date and time (but not time zone) fields.

DateTime(String date)

Constructs a DateTime from a String.

DateTime(Date dateRef)

Creates a new XML Schema DateTime instance from a java.util.Date.
Method Summary

Modifier and Type

Method

Description

short[]

getValues()

Returns an array of shorts with all the fields that describe this DateTime type.

static DateTime

parse(String str)

Parses a String into a new DateTime instance.

static DateTime

parseDateTime(String str)

Parses a String into a new DateTime instance.

void

setValues(short[] values)

Sets all the fields to the values provided in an Array.

Date

toDate()

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

long

toLong()

Converts this DateTime into a long value representing a java.util.Date.

String

toString()

Converts this DateTime to a string.

Methods inherited from class DateTimeBase
addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getCentury, getDay, getHour, getMilli, getMinute, getMonth, getSeconds, getYear, getZoneHour, getZoneMinute, hasCentury, hasDay, hashCode, hasHour, hasIsNegative, hasMilli, hasMinute, hasMonth, hasSeconds, hasYear, isLeap, isNegative, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setCentury, setDateFormatTimeZone, setDateFormatTimeZone, setDay, setHour, setMilliSecond, setMinute, setMonth, setNegative, setSecond, 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

getHour()

short

getMilli()

short

getMinute()

short

getMonth()

short

getSeconds()

short

getYear()

short

getZoneHour()

short

getZoneMinute()

boolean

hasCentury()

boolean

hasDay()

int

hashCode()

Overrides the java.lang.Object#hashcode method.

boolean

hasHour()

boolean

hasIsNegative()

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

boolean

hasMilli()

boolean

hasMinute()

boolean

hasMonth()

boolean

hasSeconds()

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

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

setMonth(short month)

Sets the Month Field.

void

setNegative()

Set the negative field to true.

void

setSecond(short second)

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

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
- DateTime
  
  public DateTime()
  
  Default constructor.
- DateTime
  public DateTime(short[] values)
  
  Constructs a XML Schema DateTime instance given all the values of the different date and time (but not time zone) fields.
  By default a DateTime is not UTC, and is local. To set a timezone, you need to separately call DateTimeBase.setZone(short, short).
  
  Parameters:
  
  values - an array of shorts that represent the different fields of Time.
  
  See Also:
  
  setValues(short[])
- DateTime
  
  public DateTime(long dateAsLong)
  
  Creates a new XML Schema DateTime instance from a long that represents a Date. No time zone information is set.
  By default a DateTime is not UTC, and is local. To set a timezone, you need to separately call DateTimeBase.setZone(short, short).
  
  Parameters:
  
  dateAsLong - java.util.Date represented as a long.
- DateTime
  
  public DateTime(Date dateRef)
  
  Creates a new XML Schema DateTime instance from a java.util.Date. No time zone information is set.
  By default a DateTime is not UTC, and is local. To set a timezone, you need to separately call DateTimeBase.setZone(short, short).
  
  Parameters:
  
  dateRef - a java.util.Date to convert.
- DateTime
  
  public DateTime(String date) throws ParseException
  
  Constructs a DateTime from a String. The String is expected to be in W3C Schema DateTime format.
  
  Parameters:
  
  date - the string representing the date
  
  Throws:
  
  ParseException - if we are passed an illegal value
Method Details
- setValues
  public void setValues(short[] values)
  
  Sets all the fields to the values provided in an Array. The Array must be at least eight entries long. Extra entries are ignored. The order of entries in the array is as follows:
  
  century
  
  year
  
  month
  
  day
  
  hour
  
  minute
  
  second
  
  millisecond
  
  If a Time Zone is to be specified, it has to be set separately by using setZone. A time zone previously set will not be cleared.
  
  Specified by:
  
  setValues in class DateTimeBase
  
  Parameters:
  
  values - An array of shorts containing the values for the DateTime
- getValues
  public short[] getValues()
  
  Returns an array of shorts with all the fields that describe this DateTime type. The order of entries in the array is as follows:
  
  century
  
  year
  
  month
  
  day
  
  hour
  
  minute
  
  second
  
  millisecond
  
  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 DateTime into a local java.util.Date.
  
  Specified by:
  
  toDate in class DateTimeBase
  
  Returns:
  
  a local java.util.Date representing this DateTime.
- toLong
  
  public long toLong()
  
  Converts this DateTime into a long value representing a java.util.Date.
  
  Returns:
  
  This DateTime instance as a long value representing a java.util.Date.
- toString
  
  public String toString()
  
  Converts this DateTime to a string. The format is defined by W3C XML Schema recommendation and ISO8601: (+|-)CCYY-MM-DDTHH:MM:SS.SSS(+/-)HH:SS
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a string representing this Date
- parse
  
  public static DateTime parse(String str) throws ParseException
  
  Parses a String into a new DateTime instance.
  
  Parameters:
  
  str - the string to parse
  
  Returns:
  
  a new DateTime instance with the value of the parsed string.
  
  Throws:
  
  ParseException - If the string to parse does not follow the right format
- parseDateTime
  
  public static DateTime parseDateTime(String str) throws ParseException
  
  Parses a String into a new DateTime instance.
  
  Parameters:
  
  str - the string to parse
  
  Returns:
  
  a new DateTime instance with the value of the parsed string.
  
  Throws:
  
  ParseException - If the string to parse does not follow the right format

Class DateTime

Field Summary

Fields inherited from class DateTimeBase

Constructor Summary

Method Summary

Methods inherited from class DateTimeBase

Methods inherited from class Object

Constructor Details

DateTime

DateTime

DateTime

DateTime

DateTime

Method Details

setValues

getValues

toDate

toLong

toString

parse

parseDateTime