Apache Ant Core 1.10.14 · org.apache.tools.ant.util.DateUtils

Field Summary

Modifier and Type	Field and Description
public static final DateFormat	DATE_HEADER_FORMAT Format used for SMTP (and probably other) Date headers.
private static final DateFormat	DATE_HEADER_FORMAT_INT
public static final ThreadLocal<DateFormat>	EN_US_DATE_FORMAT_MIN Provides a thread-local US-style date format.
public static final ThreadLocal<DateFormat>	EN_US_DATE_FORMAT_SEC Provides a thread-local US-style date format.
public static final String	ISO8601_DATE_PATTERN ISO8601-like pattern for date.
public static final String	ISO8601_DATETIME_PATTERN ISO8601-like pattern for date-time.
public static final String	ISO8601_TIME_PATTERN ISO8601-like pattern for time.
private static final Pattern	iso8601normalizer
private static final ThreadLocal<DateFormat>	iso8601WithTimeZone
private static final double[]	LIMITS
private static final MessageFormat	MINUTE_SECONDS
private static final ChoiceFormat	MINUTES_FORMAT
private static final String[]	MINUTES_PART
private static final int	ONE_HOUR
private static final int	ONE_MINUTE
private static final int	ONE_SECOND
private static final ChoiceFormat	SECONDS_FORMAT
private static final String[]	SECONDS_PART
private static final int	TEN

Constructor Summary

Access	Constructor and Description
private	DateUtils() private constructor

Method Summary

Modifier and Type	Method and Description
private static DateFormat	Returns: the configured format for this pattern. createDateFormat(String the pattern used for date/time formatting. pattern) return a lenient date format set to GMT time zone.
public static String	Returns: the formatted date. format(long the date to format expressed in milliseconds. date, String the pattern to use to format the date. pattern) Format a date/time into a specific pattern.
public static String	Returns: the formatted date. format(Date the date to format expressed in milliseconds. date, String the pattern to use to format the date. pattern) Format a date/time into a specific pattern.
public static String	Returns: the formatted text in minutes/seconds. formatElapsedTime(long the elapsed time to report in milliseconds. millis) Format an elapsed time into a pluralization correct string.
public static String	Returns: the current date. getDateForHeader() Returns the current Date in a format suitable for a SMTP date header.
public static int	Returns: The phase of the moon as a number between 0 and 7 with 0 meaning new moon and 4 meaning full moon. getPhaseOfMoon(Calendar the calendar. cal) Calculate the phase of the moon for a given date.
public static Date	Returns: a java.util.Date object as parsed by the format. parseDateFromHeader(String string to be parsed datestr) Parses the string in a format suitable for a SMTP date header.
public static Date	Returns: a java.util.Date object as parsed by the format. parseIso8601Date(String string to be parsed datestr) Parse a string as a date using the ISO8601_DATE format which is `yyyy-MM-dd`
public static Date	Returns: a java.util.Date object as parsed by the format. parseIso8601DateTime(String string to be parsed datestr) Parse a string as a datetime using the ISO8601_DATETIME format which is `yyyy-MM-dd'T'HH:mm:ss`
public static Date	Returns: a java.util.Date object as parsed by the formats. parseIso8601DateTimeOrDate(String string to be parsed datestr) Parse a string as a date using the either the ISO8601_DATETIME or ISO8601_DATE formats.
public static Date	Returns: Date parseLenientDateTime(String String dateStr) Parse a lenient ISO 8601, ms since epoch, or `<touch>`-style date.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DATE_HEADER_FORMAT	back to summary
public static final DateFormat DATE_HEADER_FORMAT Deprecated DateFormat is not thread safe, and we cannot guarantee that some other code is using the format in parallel. Deprecated since ant 1.8 Format used for SMTP (and probably other) Date headers. Annotations @Deprecated

DATE_HEADER_FORMAT_INT	back to summary
private static final DateFormat DATE_HEADER_FORMAT_INT

EN_US_DATE_FORMAT_MIN back to summary

EN_US_DATE_FORMAT_MIN	back to summary
public static final ThreadLocal<DateFormat> EN_US_DATE_FORMAT_MIN Provides a thread-local US-style date format. Exactly as used by `<touch>`, to minute precision: `SimpleDateFormat("MM/dd/yyyy hh:mm a", Locale.US)` Since Ant 1.10.2

public static final ThreadLocal<DateFormat> EN_US_DATE_FORMAT_MIN

Provides a thread-local US-style date format. Exactly as used by <touch>, to minute precision: SimpleDateFormat("MM/dd/yyyy hh:mm a", Locale.US)

Since: Ant 1.10.2

EN_US_DATE_FORMAT_SEC back to summary

EN_US_DATE_FORMAT_SEC	back to summary
public static final ThreadLocal<DateFormat> EN_US_DATE_FORMAT_SEC Provides a thread-local US-style date format. Exactly as used by `<touch>`, to second precision: `SimpleDateFormat("MM/dd/yyyy hh:mm:ss a", Locale.US)` Since Ant 1.10.2

public static final ThreadLocal<DateFormat> EN_US_DATE_FORMAT_SEC

Provides a thread-local US-style date format. Exactly as used by <touch>, to second precision: SimpleDateFormat("MM/dd/yyyy hh:mm:ss a", Locale.US)

Since: Ant 1.10.2

ISO8601_DATE_PATTERN	back to summary
public static final String ISO8601_DATE_PATTERN ISO8601-like pattern for date. `yyyy-MM-dd`

ISO8601_DATETIME_PATTERN	back to summary
public static final String ISO8601_DATETIME_PATTERN ISO8601-like pattern for date-time. It does not support timezone. `yyyy-MM-ddTHH:mm:ss`

ISO8601_TIME_PATTERN	back to summary
public static final String ISO8601_TIME_PATTERN ISO8601-like pattern for time. `HH:mm:ss`

iso8601normalizer	back to summary
private static final Pattern iso8601normalizer

iso8601WithTimeZone	back to summary
private static final ThreadLocal<DateFormat> iso8601WithTimeZone

LIMITS	back to summary
private static final double[] LIMITS

MINUTE_SECONDS	back to summary
private static final MessageFormat MINUTE_SECONDS

MINUTES_FORMAT	back to summary
private static final ChoiceFormat MINUTES_FORMAT

MINUTES_PART	back to summary
private static final String[] MINUTES_PART

ONE_HOUR	back to summary
private static final int ONE_HOUR

ONE_MINUTE	back to summary
private static final int ONE_MINUTE

ONE_SECOND	back to summary
private static final int ONE_SECOND

SECONDS_FORMAT	back to summary
private static final ChoiceFormat SECONDS_FORMAT

SECONDS_PART	back to summary
private static final String[] SECONDS_PART

TEN	back to summary
private static final int TEN

Constructor Detail

DateUtils	back to summary
private DateUtils() private constructor

Method Detail

createDateFormat	back to summary
private static DateFormat createDateFormat(String pattern) return a lenient date format set to GMT time zone. Parameters pattern:String the pattern used for date/time formatting. Returns:DateFormat the configured format for this pattern.

createDateFormat

back to summary

private static DateFormat createDateFormat(String pattern)

return a lenient date format set to GMT time zone.

Parameters

pattern:String: the pattern used for date/time formatting.

Returns:DateFormat

the configured format for this pattern.

format	back to summary
public static String format(long date, String pattern) Format a date/time into a specific pattern. Parameters date:long the date to format expressed in milliseconds. pattern:String the pattern to use to format the date. Returns:String the formatted date.

format

back to summary

public static String format(long date, String pattern)

Format a date/time into a specific pattern.

Parameters

date:long: the date to format expressed in milliseconds.
pattern:String: the pattern to use to format the date.

Returns:String

the formatted date.

format	back to summary
public static String format(Date date, String pattern) Format a date/time into a specific pattern. Parameters date:Date the date to format expressed in milliseconds. pattern:String the pattern to use to format the date. Returns:String the formatted date.

format

back to summary

public static String format(Date date, String pattern)

Format a date/time into a specific pattern.

Parameters

date:Date: the date to format expressed in milliseconds.
pattern:String: the pattern to use to format the date.

Returns:String

the formatted date.

formatElapsedTime	back to summary
public static String formatElapsedTime(long millis) Format an elapsed time into a pluralization correct string. It is limited only to report elapsed time in minutes and seconds and has the following behavior. minutes are not displayed when 0. (ie: "45 seconds") seconds are always displayed in plural form (ie "0 seconds" or "10 seconds") except for 1 (ie "1 second") Parameters millis:long the elapsed time to report in milliseconds. Returns:String the formatted text in minutes/seconds.

formatElapsedTime

back to summary

public static String formatElapsedTime(long millis)

Format an elapsed time into a pluralization correct string. It is limited only to report elapsed time in minutes and seconds and has the following behavior.

minutes are not displayed when 0. (ie: "45 seconds")
seconds are always displayed in plural form (ie "0 seconds" or "10 seconds") except for 1 (ie "1 second")

Parameters

millis:long: the elapsed time to report in milliseconds.

Returns:String

the formatted text in minutes/seconds.

getDateForHeader	back to summary
public static String getDateForHeader() Returns the current Date in a format suitable for a SMTP date header. Returns:String the current date. Since Ant 1.5.2

getDateForHeader

back to summary

public static String getDateForHeader()

Returns the current Date in a format suitable for a SMTP date header.

Returns:String: the current date.
Since: Ant 1.5.2

getPhaseOfMoon	back to summary
public static int getPhaseOfMoon(Calendar cal) Calculate the phase of the moon for a given date. Code heavily influenced by hacklib.c in Nethack The Algorithm: moon period = 29.53058 days ~= 30, year = 365.2422 days days moon phase advances on first day of year compared to preceding year = 365.2422 - 12 * 29.53058 ~= 11 years in Metonic cycle (time until same phases fall on the same days of the month) = 18.6 ~= 19 moon phase on first day of year (epact) ~= (11(year%19) + 18) % 30 (18 as initial condition for 1900) current phase in days = first day phase + days elapsed in year 6 moons ~= 177 days 177 ~= 8 reported phases 22 + 11 / 22 for rounding Parameters cal:Calendar the calendar. Returns:int The phase of the moon as a number between 0 and 7 with 0 meaning new moon and 4 meaning full moon. Since 1.2, Ant 1.5

getPhaseOfMoon

back to summary

public static int getPhaseOfMoon(Calendar cal)

Calculate the phase of the moon for a given date.

Code heavily influenced by hacklib.c in Nethack

The Algorithm:

moon period = 29.53058 days ~= 30, year = 365.2422 days

days moon phase advances on first day of year compared to preceding year
 = 365.2422 - 12 * 29.53058 ~= 11

years in Metonic cycle (time until same phases fall on the same days of
 the month) = 18.6 ~= 19

moon phase on first day of year (epact) ~= (11*(year%19) + 18) % 30
 (18 as initial condition for 1900)

current phase in days = first day phase + days elapsed in year

6 moons ~= 177 days
177 ~= 8 reported phases * 22
+ 11 / 22 for rounding

Parameters

cal:Calendar: the calendar.

Returns:int

The phase of the moon as a number between 0 and 7 with 0 meaning new moon and 4 meaning full moon.

Since

1.2, Ant 1.5

parseDateFromHeader	back to summary
public static Date parseDateFromHeader(String datestr) throws ParseException Parses the string in a format suitable for a SMTP date header. Parameters datestr:String string to be parsed Returns:Date a java.util.Date object as parsed by the format. Exceptions ParseException: if the supplied string cannot be parsed by this pattern. Since Ant 1.8.0

parseDateFromHeader

back to summary

public static Date parseDateFromHeader(String datestr) throws ParseException

Parses the string in a format suitable for a SMTP date header.

Parameters

datestr:String: string to be parsed

Returns:Date

a java.util.Date object as parsed by the format.

Exceptions

ParseException:: if the supplied string cannot be parsed by this pattern.

Since

Ant 1.8.0

parseIso8601Date back to summary

parseIso8601Date	back to summary
public static Date parseIso8601Date(String datestr) throws ParseException Parse a string as a date using the ISO8601_DATE format which is `yyyy-MM-dd` Parameters datestr:String string to be parsed Returns:Date a java.util.Date object as parsed by the format. Exceptions ParseException: if the supplied string cannot be parsed by this pattern. Since Ant 1.6

public static Date parseIso8601Date(String datestr) throws ParseException

Parse a string as a date using the ISO8601_DATE format which is yyyy-MM-dd

Parameters

datestr:String: string to be parsed

Returns:Date

a java.util.Date object as parsed by the format.

Exceptions

ParseException:: if the supplied string cannot be parsed by this pattern.

Since

Ant 1.6

parseIso8601DateTime back to summary

parseIso8601DateTime	back to summary
public static Date parseIso8601DateTime(String datestr) throws ParseException Parse a string as a datetime using the ISO8601_DATETIME format which is `yyyy-MM-dd'T'HH:mm:ss` Parameters datestr:String string to be parsed Returns:Date a java.util.Date object as parsed by the format. Exceptions ParseException: if the supplied string cannot be parsed by this pattern. Since Ant 1.6

public static Date parseIso8601DateTime(String datestr) throws ParseException

Parse a string as a datetime using the ISO8601_DATETIME format which is yyyy-MM-dd'T'HH:mm:ss

Parameters

datestr:String: string to be parsed

Returns:Date

a java.util.Date object as parsed by the format.

Exceptions

ParseException:: if the supplied string cannot be parsed by this pattern.

Since

Ant 1.6

parseIso8601DateTimeOrDate	back to summary
public static Date parseIso8601DateTimeOrDate(String datestr) throws ParseException Parse a string as a date using the either the ISO8601_DATETIME or ISO8601_DATE formats. Parameters datestr:String string to be parsed Returns:Date a java.util.Date object as parsed by the formats. Exceptions ParseException: if the supplied string cannot be parsed by either of these patterns. Since Ant 1.6

parseIso8601DateTimeOrDate

back to summary

public static Date parseIso8601DateTimeOrDate(String datestr) throws ParseException

Parse a string as a date using the either the ISO8601_DATETIME or ISO8601_DATE formats.

Parameters

datestr:String: string to be parsed

Returns:Date

a java.util.Date object as parsed by the formats.

Exceptions

ParseException:: if the supplied string cannot be parsed by either of these patterns.

Since

Ant 1.6

parseLenientDateTime back to summary

parseLenientDateTime	back to summary
public static Date parseLenientDateTime(String dateStr) throws ParseException Parse a lenient ISO 8601, ms since epoch, or `<touch>`-style date. That is: Milliseconds since 1970-01-01 00:00 `YYYY-MM-DD{T\| }HH:MM[:SS[.SSS]][ ][±ZZ[[:]ZZ]]` `MM/DD/YYYY HH:MM[:SS] {AM\|PM}` where {a\|b} indicates that you must choose one of a or b, and [c] indicates that you may use or omit c. ±ZZZZ is the timezone offset, and may be literally "Z" to mean GMT. Parameters dateStr:String String Returns:Date Date Exceptions ParseException: if date string does not match ISO 8601 Since Ant 1.10.2

public static Date parseLenientDateTime(String dateStr) throws ParseException

Parse a lenient ISO 8601, ms since epoch, or <touch>-style date. That is:

Milliseconds since 1970-01-01 00:00
YYYY-MM-DD{T| }HH:MM[:SS[.SSS]][ ][±ZZ[[:]ZZ]]
MM/DD/YYYY HH:MM[:SS] {AM|PM}

where {a|b} indicates that you must choose one of a or b, and [c] indicates that you may use or omit c. ±ZZZZ is the timezone offset, and may be literally "Z" to mean GMT.

Parameters

dateStr:String: String

Returns:Date

Date

Exceptions

ParseException:: if date string does not match ISO 8601

Since

Ant 1.10.2

public final Class DateUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail