net.sf.mmm.util.date.base

Class Iso8601UtilLimitedImpl

java.lang.Object

net.sf.mmm.util.date.base.Iso8601UtilLimitedImpl

All Implemented Interfaces:

Iso8601UtilLimited

Direct Known Subclasses:

Iso8601UtilImpl

public class Iso8601UtilLimitedImpl
extends Object
implements Iso8601UtilLimited

This is the implementation of the Iso8601UtilLimited interface. It does NOT use SimpleDateFormat. All methods of this class are fast and thread-safe.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Iso8601UtilImpl

Field Summary

Fields

Modifier and Type	Field and Description
private static Iso8601UtilLimitedImpl	instance
protected static int	MAX_DAY_OF_MONTH The maximum day of the month.
protected static int	MAX_MONTH The maximum month of the year.

Fields inherited from interface net.sf.mmm.util.date.api.Iso8601UtilLimited

PATTERN_STRING_ALL, PATTERN_STRING_DATE, PATTERN_STRING_TIME, PATTERN_STRING_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
Iso8601UtilLimitedImpl() The constructor.

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.
void	formatDate(int year, int month, int day, boolean extended, Appendable buffer)
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	formatTime(int hours, int minutes, int seconds, boolean extended, Appendable buffer)
void	formatTimeZone(int timezoneOffset, boolean extended, Appendable buffer) This method formats the given timezone according to ISO 8601.
static Iso8601UtilLimited	getInstance() This method gets the singleton instance of this Iso8601UtilImpl.
protected int[]	parseDate(CharSequenceScanner scanner) This method parses the date from the given scanner.
Date	parseDate(String dateIso8601) This method parses the given string date according to ISO 8601.
protected int[]	parseTime(CharSequenceScanner scanner) This method parses the time (or timezone offset) from the given scanner.
protected Integer	parseTimezoneOffset(CharSequenceScanner scanner) This method parses the timezone offset from the given scanner.
private int	read2Digits(CharSequenceScanner scanner) This method reads two digits from the given scanner.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DAY_OF_MONTH

protected static final int MAX_DAY_OF_MONTH

The maximum day of the month.

See Also:

Constant Field Values

MAX_MONTH

protected static final int MAX_MONTH

The maximum month of the year.

See Also:

Constant Field Values

instance

private static Iso8601UtilLimitedImpl instance

Constructor Detail

Iso8601UtilLimitedImpl

public Iso8601UtilLimitedImpl()

The constructor.

Method Detail

getInstance

public static Iso8601UtilLimited getInstance()

This method gets the singleton instance of this Iso8601UtilImpl.
ATTENTION:
Please read Cdi.GET_INSTANCE before using.

Returns:

the singleton instance.

Since:

6.0.0

formatDate

public String formatDate(Date date)

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDate in interface Iso8601UtilLimited

Parameters:

date - is the Date to format.

Returns:

the given date as date string.

formatDate

public String formatDate(Date date,
                         boolean extended)

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDate in interface Iso8601UtilLimited

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.

formatDate

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

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDate in interface Iso8601UtilLimited

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.

formatDate

public void formatDate(int year,
                       int month,
                       int day,
                       boolean extended,
                       Appendable buffer)

Parameters:

year - is the year

month - is the month (1-12).

day - is the day.

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.

See Also:

formatDate(Date, boolean, Appendable)

formatDateTime

public String formatDateTime(Date date)

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDateTime in interface Iso8601UtilLimited

Parameters:

date - is the date to format.

Returns:

the given calendar as date string.

formatDateTime

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

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDateTime in interface Iso8601UtilLimited

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.

formatDateTime

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

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatDateTime in interface Iso8601UtilLimited

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.

formatTime

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

Description copied from interface: Iso8601UtilLimited

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

Specified by:

formatTime in interface Iso8601UtilLimited

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.

formatTime

public void formatTime(int hours,
                       int minutes,
                       int seconds,
                       boolean extended,
                       Appendable buffer)

Parameters:

hours - are the hours.

minutes - are the minutes.

seconds - are the seconds.

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.

See Also:

formatTime(Date, boolean, Appendable)

formatTimeZone

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

Description copied from interface: Iso8601UtilLimited

This method formats the given timezone according to ISO 8601.

Specified by:

formatTimeZone in interface Iso8601UtilLimited

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

public Date parseDate(String dateIso8601)

Description copied from interface: Iso8601UtilLimited

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

Specified by:

parseDate in interface Iso8601UtilLimited

Parameters:

dateIso8601 - is the date to parse.

Returns:

the parsed date.

parseTimezoneOffset

protected Integer parseTimezoneOffset(CharSequenceScanner scanner)

This method parses the timezone offset from the given scanner.

Parameters:

scanner - is the parser pointing to the timezone or at the end of the string.

Returns:

the parsed timezone offset or null for UTC (Z) or if no timezone is present.

parseDate

protected int[] parseDate(CharSequenceScanner scanner)

This method parses the date from the given scanner. The format is yyyy[-]MM[-]dd.

Parameters:

scanner - is the parser pointing to the date.

Returns:

an array containing the year, month, and day in that order.

read2Digits

private int read2Digits(CharSequenceScanner scanner)
                 throws IllegalDateFormatException

This method reads two digits from the given scanner.

Parameters:

scanner - is the scanner potentially pointing to the digits.

Returns:

-1 if the scanner does NOT point to a digit or the number represented by the two digits consumed from the scanner.

Throws:

IllegalDateFormatException - if the scanner only contained a single digit.

parseTime

protected int[] parseTime(CharSequenceScanner scanner)

This method parses the time (or timezone offset) from the given scanner. The format is hh[[:]mm[[:]ss]].

Parameters:

scanner - is the parser pointing to the time.

Returns:

an int-array containing the hour, minute and second in that order.