net.sf.mmm.util.date.api

Interface Iso8601UtilLimited

All Known Subinterfaces:

Iso8601Util

All Known Implementing Classes:

Iso8601UtilImpl, Iso8601UtilLimitedImpl

@ComponentSpecification
public interface Iso8601UtilLimited

This is a limited subset of Iso8601Util that is GWT compatible.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Iso8601Util

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATTERN_STRING_ALL The regex-pattern for the full date-format (date with optional time and optional timezone).
static String	PATTERN_STRING_DATE The regex-pattern for the date-format.
static String	PATTERN_STRING_TIME The regex-pattern for the time-format.
static String	PATTERN_STRING_TIMEZONE The regex-pattern for the timezone-format.

Method Summary

Modifier and Type	Method and Description
String	formatDate(Date date) This method formats the given date in the format "yyyy-MM-dd" in GMT according to ISO 8601.
String	formatDate(Date date, boolean extended) This method formats the given calendar as a date in the format "yyyy-MM-dd" according to ISO 8601.
void	formatDate(Date date, boolean extended, Appendable buffer) This method formats the given date as a date according to ISO 8601.
String	formatDateTime(Date date) This method formats the given date as a date and time in the format "yyyy-MM-ddTHH:mm:ssZ" (UTC) according to ISO 8601.
String	formatDateTime(Date date, boolean extendedDate, boolean extendedTime, boolean extendedTimezone) This method formats the given date as a date according to ISO 8601.
void	formatDateTime(Date date, boolean extendedDate, boolean extendedTime, boolean extendedTimezone, Appendable buffer) This method formats the given date as a date and time according to ISO 8601.
void	formatTime(Date date, boolean extended, Appendable buffer) This method formats the given date as time according to ISO 8601.
void	formatTimeZone(int timezoneOffset, boolean extended, Appendable buffer) This method formats the given timezone according to ISO 8601.
Date	parseDate(String date) This method parses the given string date according to ISO 8601.

Field Detail

PATTERN_STRING_DATE

static final String PATTERN_STRING_DATE

The regex-pattern for the date-format.

See Also:

Constant Field Values

PATTERN_STRING_TIME

static final String PATTERN_STRING_TIME

The regex-pattern for the time-format.

See Also:

Constant Field Values

PATTERN_STRING_TIMEZONE

static final String PATTERN_STRING_TIMEZONE

The regex-pattern for the timezone-format.

See Also:

Constant Field Values

PATTERN_STRING_ALL

static final String PATTERN_STRING_ALL

The regex-pattern for the full date-format (date with optional time and optional timezone).

See Also:

Constant Field Values

Method Detail

formatDate

String formatDate(Date date)

This method formats the given date in the format "yyyy-MM-dd" in GMT according to ISO 8601.

Parameters:

date - is the Date to format.

Returns:

the given date as date string.

Since:

1.0.2

formatDate

String formatDate(Date date,
                  boolean extended)

This method formats the given calendar as a date in the format "yyyy-MM-dd" according to ISO 8601.

Parameters:

date - is the Date to format.

extended - if false the basic format ("yyyyMMdd") is used, if true the extended format ("yyyy-MM-dd") is used.

Returns:

the given calendar as date string.

Since:

3.0.0

formatDate

void formatDate(Date date,
                boolean extended,
                Appendable buffer)

This method formats the given date as a date according to ISO 8601.

Parameters:

date - is the Date to format.

extended - if false the basic date format ("yyyyMMdd") is used, if true the extended date format ("yyyy-MM-dd") is used.

buffer - is where to append the formatted date.

Since:

3.0.0

formatDateTime

String formatDateTime(Date date)

This method formats the given date as a date and time in the format "yyyy-MM-ddTHH:mm:ssZ" (UTC) according to ISO 8601.

Parameters:

date - is the date to format.

Returns:

the given calendar as date string.

Since:

1.0.2

formatDateTime

String formatDateTime(Date date,
                      boolean extendedDate,
                      boolean extendedTime,
                      boolean extendedTimezone)

This method formats the given date as a date according to ISO 8601.

Parameters:

date - is the Date to format.

extendedDate - if false the basic date format ("yyyyMMdd") is used, if true the extended date format ("yyyy-MM-dd") is used.

extendedTime - if false the basic time format ("HHmmss") is used, if true the extended time format ("HH:mm:ss") is used.

extendedTimezone - if false the basic timezone format ("±HHmm[ss]") is used, if true the extended timezone format ("±HH:mm[:ss]") is used.

Returns:

the given calendar as date string.

Since:

3.0.0

formatDateTime

void formatDateTime(Date date,
                    boolean extendedDate,
                    boolean extendedTime,
                    boolean extendedTimezone,
                    Appendable buffer)

This method formats the given date as a date and time according to ISO 8601.

Parameters:

date - is the Date to format.

extendedDate - if false the basic date format ("yyyyMMdd") is used, if true the extended date format ("yyyy-MM-dd") is used.

extendedTime - if false the basic time format ("HHmmss") is used, if true the extended time format ("HH:mm:ss") is used.

extendedTimezone - if false the basic timezone format ("±HHmm[ss]") is used, if true the extended timezone format ("±HH:mm[:ss]") is used.

buffer - is where to append the formatted date and time.

Since:

3.0.0

formatTime

void formatTime(Date date,
                boolean extended,
                Appendable buffer)

This method formats the given date as time according to ISO 8601.

Parameters:

date - is the Date to format.

extended - if false the basic time format ("HHmmss") is used, if true the extended time format ("HH:mm:ss") is used.

buffer - is where to append the formatted date.

Since:

3.0.0

formatTimeZone

void formatTimeZone(int timezoneOffset,
                    boolean extended,
                    Appendable buffer)

This method formats the given timezone according to ISO 8601.

Parameters:

timezoneOffset - is the timezone-offset in milliseconds.

extended - - if false the basic timezone format ("±HHmm[ss]") is used, if true the extended timezone format ("±HH:mm[:ss]") is used.

buffer - is where to append the formatted timezone.

parseDate

Date parseDate(String date)

This method parses the given string date according to ISO 8601.

Parameters:

date - is the date to parse.

Returns:

the parsed date.

Since:

1.0.2