com.sapportals.wcm.protocol.ice.util

Class ICEDateFormat

java.lang.Object

com.sapportals.wcm.protocol.ice.util.ICEDateFormat

public class ICEDateFormat
extends Object

Implements the date format defined in the ICE specification. This format is the Extended Format described in [ISO8601] section 5.2.1.1, with the separator as described in [ISO8601] section 4.4. Actually, it's based on a selected profile of options from ISO8601:1988 (with Technical Corrigendum 1 applied).

The format for a date string in ICE Date Format is: CCYY-MM-DD where CCYY is the four digit year (century and year, as described in [ISO8601]), MM is a two digit month number, DD is the two digit ordinal number of the day within the calendar month, and the separator character is a "-" (hyphen).

Copyright 2004 SAP AG

Constructor Summary

Constructors

Constructor and Description
ICEDateFormat()

Method Summary

Modifier and Type	Method and Description
static String	format(Date date) Formats the specified java.util.Date object as a string adhering to the ICE Date Format.
static Date	parse(String str) Parses the specified string (which must be in ICE Date Format) and returns it as a java.util.Date object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ICEDateFormat

public ICEDateFormat()

Method Detail

format

public static String format(Date date)

Formats the specified java.util.Date object as a string adhering to the ICE Date Format.

Note, that the date will be converted to UTC (if not already in UTC) prior formatting it to the ICE Date format. This is done although the time contained in the java.util.Date object is not included in the final string. For example, the date July 1st 2002 01:00:00 AM (GMT+2) will be converted to June 30th 2002 11:00:00 PM (UTC) and returned as "2002-06-30".

Parameters:

date - the date to be formatted

Returns:

a string representation in ICE Date Format

parse

public static Date parse(String str)
                  throws ParseException

Parses the specified string (which must be in ICE Date Format) and returns it as a java.util.Date object.

Note, as the string does not contain a time, a value of 00:00:00 AM (UTC) will be assumed before converting the resulting date to local time. For example, on a machine with local timezone GMT+2, the string "2002-06-30" will be interpreted as June 30th 2002 00:00:00 AM (UTC) and converted to June 30th 2002 02:00:00 AM (GMT+2).

To conclude, this method is NOT the exact inverse of the method format.

Parameters:

str - the string to be parsed

Returns:

a java.util.Date object containing the parsed date

Throws:

ParseException - when specifying an illegally formatted string