biweekly.util

Enum ICalDateFormat

java.lang.Object

java.lang.Enum<ICalDateFormat>

biweekly.util.ICalDateFormat

All Implemented Interfaces:

Serializable, Comparable<ICalDateFormat>

public enum ICalDateFormat
extends Enum<ICalDateFormat>

Defines all of the date formats that are used in iCalendar objects, and also parses/formats iCalendar dates. These date formats are defined in the ISO8601 specification.

Author:

Michael Angstadt

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATE_BASIC Example: 20120701
DATE_EXTENDED Example: 2012-07-01
DATE_TIME_BASIC Example: 20120701T142110-0500
DATE_TIME_BASIC_WITHOUT_TZ Example: 20120701T142110
DATE_TIME_EXTENDED Example: 2012-07-01T14:21:10-05:00
DATE_TIME_EXTENDED_WITHOUT_TZ Example: 2012-07-01T14:21:10
UTC_TIME_BASIC Example: 20120701T192110Z
UTC_TIME_EXTENDED Example: 2012-07-01T19:21:10Z

Field Summary

Fields

Modifier and Type	Field and Description
protected String	formatStr The SimpleDateFormat format string used for parsing dates.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	dateHasTime(String dateStr) Determines whether a date string has a time component.
static boolean	dateHasTimezone(String dateStr) Determines whether a date string is in UTC time or has a timezone offset.
static ICalDateFormat	find(String dateStr) Determines the ISO format a date string is in.
String	format(Date date) Formats a date in this ISO format.
String	format(Date date, TimeZone timezone) Formats a date in this ISO format.
DateFormat	getDateFormat() Builds a DateFormat object for parsing and formating dates in this ISO format.
DateFormat	getDateFormat(TimeZone timezone) Builds a DateFormat object for parsing and formating dates in this ISO format.
static boolean	isUTC(String dateStr) Determines if a date string is in UTC time.
boolean	matches(String dateStr) Determines whether a date string is in this ISO format.
static Date	parse(String dateStr) Parses an iCalendar date.
static Date	parse(String dateStr, TimeZone timezone) Parses an iCalendar date.
static TimeZone	parseTimeZoneId(String timezoneId) Gets the TimeZone object that corresponds to the given ID.
static ICalDateFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ICalDateFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATE_BASIC

public static final ICalDateFormat DATE_BASIC

Example: 20120701

DATE_EXTENDED

public static final ICalDateFormat DATE_EXTENDED

Example: 2012-07-01

DATE_TIME_BASIC

public static final ICalDateFormat DATE_TIME_BASIC

Example: 20120701T142110-0500

DATE_TIME_BASIC_WITHOUT_TZ

public static final ICalDateFormat DATE_TIME_BASIC_WITHOUT_TZ

Example: 20120701T142110

DATE_TIME_EXTENDED

public static final ICalDateFormat DATE_TIME_EXTENDED

Example: 2012-07-01T14:21:10-05:00

DATE_TIME_EXTENDED_WITHOUT_TZ

public static final ICalDateFormat DATE_TIME_EXTENDED_WITHOUT_TZ

Example: 2012-07-01T14:21:10

UTC_TIME_BASIC

public static final ICalDateFormat UTC_TIME_BASIC

Example: 20120701T192110Z

UTC_TIME_EXTENDED

public static final ICalDateFormat UTC_TIME_EXTENDED

Example: 2012-07-01T19:21:10Z

Field Detail

formatStr

protected final String formatStr

The SimpleDateFormat format string used for parsing dates.

Method Detail

values

public static ICalDateFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ICalDateFormat c : ICalDateFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ICalDateFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

matches

public boolean matches(String dateStr)

Determines whether a date string is in this ISO format.

Parameters:

dateStr - the date string

Returns:

true if it matches the date format, false if not

getDateFormat

public DateFormat getDateFormat()

Builds a DateFormat object for parsing and formating dates in this ISO format.

Returns:

the DateFormat object

getDateFormat

public DateFormat getDateFormat(TimeZone timezone)

Builds a DateFormat object for parsing and formating dates in this ISO format.

Parameters:

timezone - the timezone the date is in or null for the default timezone

Returns:

the DateFormat object

format

public String format(Date date)

Formats a date in this ISO format.

Parameters:

date - the date to format

Returns:

the date string

format

public String format(Date date,
            TimeZone timezone)

Formats a date in this ISO format.

Parameters:

date - the date to format

timezone - the timezone to format the date in or null for the default timezone

Returns:

the date string

find

public static ICalDateFormat find(String dateStr)

Determines the ISO format a date string is in.

Parameters:

dateStr - the date string (e.g. "20140322T120000Z")

Returns:

the ISO format (e.g. DATETIME_BASIC) or null if not found

parse

public static Date parse(String dateStr)

Parses an iCalendar date.

Parameters:

dateStr - the date string to parse (e.g. "20130609T181023Z")

Returns:

the parsed date

Throws:

IllegalArgumentException - if the date string isn't in one of the accepted ISO8601 formats

parse

public static Date parse(String dateStr,
         TimeZone timezone)

Parses an iCalendar date.

Parameters:

dateStr - the date string to parse (e.g. "20130609T181023Z")

timezone - the timezone to parse the date as or null to use the JVM's default timezone (if the date string contains its own timezone, then that timezone will be used instead)

Returns:

the parsed date

Throws:

IllegalArgumentException - if the date string isn't in one of the accepted ISO8601 formats

dateHasTime

public static boolean dateHasTime(String dateStr)

Determines whether a date string has a time component.

Parameters:

dateStr - the date string (e.g. "20130601T120000")

Returns:

true if it has a time component, false if not

dateHasTimezone

public static boolean dateHasTimezone(String dateStr)

Determines whether a date string is in UTC time or has a timezone offset.

Parameters:

dateStr - the date string (e.g. "20130601T120000Z", "20130601T120000-0400")

Returns:

true if it has a timezone, false if not

isUTC

public static boolean isUTC(String dateStr)

Determines if a date string is in UTC time.

Parameters:

dateStr - the date string (e.g. "20130601T120000Z")

Returns:

true if it's in UTC, false if not

parseTimeZoneId

public static TimeZone parseTimeZoneId(String timezoneId)

Gets the TimeZone object that corresponds to the given ID.

Parameters:

timezoneId - the timezone ID (e.g. "America/New_York")

Returns:

the timezone object or null if not found