org.archive.util

Class DateUtils

java.lang.Object

org.archive.util.DateUtils

public class DateUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_INT_CHAR_WIDTH
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
DateUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	byteArrayEquals(byte[] lhs, byte[] rhs) check that two byte arrays are equal.
static java.lang.String	doubleToString(double val, int maxFractionDigits) Converts a double to a string.
static java.lang.String	formatBytesForDisplay(long amount) Takes a byte size and formats it for display with 'friendly' units.
static java.lang.String	formatMillisecondsToConventional(long time) Convert milliseconds value to a human-readable duration
static java.lang.String	formatMillisecondsToConventional(long duration, int unitCount) Convert milliseconds value to a human-readable duration of mixed units, using units no larger than days.
static java.lang.String	get12DigitDate() Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm.
static java.lang.String	get12DigitDate(java.util.Date d) Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm.
static java.lang.String	get12DigitDate(long date) Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm.
static java.lang.String	get14DigitDate() Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss.
static java.lang.String	get14DigitDate(java.util.Date d) Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss.
static java.lang.String	get14DigitDate(long date) Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss.
static java.lang.String	get17DigitDate() Utility function for creating arc-style date stamps in the format yyyMMddHHmmssSSS.
static java.lang.String	get17DigitDate(java.util.Date date) Utility function for creating warc-style date stamps in the format yyyyMMddHHmmssSSS.
static java.lang.String	get17DigitDate(long date) Utility function for creating warc-style date stamps in the format yyyyMMddHHmmssSSS.
static java.util.Date	getDate(java.lang.String d) Parses an ARC-style date.
static java.lang.String	getLog14Date() Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getLog14Date(java.util.Date date) Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getLog14Date(long date) Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getLog17Date() Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getLog17Date(java.util.Date date) Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getLog17Date(long date) Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC.
static java.lang.String	getRFC1123Date(java.util.Date date) Utility function for creating HTTP header style date strings, specifically, RFC 1123: EEE, dd MMM yyyy HH:mm:ss z.
static java.util.Date	getSecondsSinceEpoch(java.lang.String timestamp)
static java.lang.String	getUnique14DigitDate() Utility function for creating UNIQUE-from-this-class arc-style date stamps in the format yyyMMddHHmmss.
static java.lang.String	padTo(int i, int pad) Convert an int to a String, and pad it to pad spaces.
static java.lang.String	padTo(java.lang.String s, int pad) Pad the given String to pad characters wide by pre-pending spaces.
static java.lang.String	padTo(java.lang.String s, int pad, char padChar) Pad the given String to pad characters wide by pre-pending padChar.
static java.util.Date	parse12DigitDate(java.lang.String date) Utility function for parsing arc-style date stamps in the format yyyMMddHHmm.
static java.util.Date	parse14DigitDate(java.lang.String date) Utility function for parsing arc-style date stamps in the format yyyMMddHHmmss.
static java.util.Date	parse17DigitDate(java.lang.String date) Utility function for parsing arc-style date stamps in the format yyyMMddHHmmssSSS.
static java.lang.String	secondsSinceEpoch(java.lang.String timestamp)
static java.lang.String	zeroPadInteger(int i)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

MAX_INT_CHAR_WIDTH

public static int MAX_INT_CHAR_WIDTH

Constructor Detail

DateUtils

public DateUtils()

Method Detail

getRFC1123Date

public static java.lang.String getRFC1123Date(java.util.Date date)

Utility function for creating HTTP header style date strings, specifically, RFC 1123: EEE, dd MMM yyyy HH:mm:ss z. Date stamps are in the UTC time zone

Returns:

the date stamp

get17DigitDate

public static java.lang.String get17DigitDate()

Utility function for creating arc-style date stamps in the format yyyMMddHHmmssSSS. Date stamps are in the UTC time zone

Returns:

the date stamp for NOW

get17DigitDate

public static java.lang.String get17DigitDate(long date)

Utility function for creating warc-style date stamps in the format yyyyMMddHHmmssSSS. Date stamps are in the UTC time zone

Parameters:

date - milliseconds since epoc

Returns:

the date stamp

get17DigitDate

public static java.lang.String get17DigitDate(java.util.Date date)

Utility function for creating warc-style date stamps in the format yyyyMMddHHmmssSSS. Date stamps are in the UTC time zone

Parameters:

date - Date object

Returns:

the date stamp

get14DigitDate

public static java.lang.String get14DigitDate()

Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss. Date stamps are in the UTC time zone

Returns:

the date stamp for NOW

get14DigitDate

public static java.lang.String get14DigitDate(long date)

Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss. Date stamps are in the UTC time zone

Parameters:

date - milliseconds since epoc

Returns:

the date stamp

get14DigitDate

public static java.lang.String get14DigitDate(java.util.Date d)

Utility function for creating arc-style date stamps in the format yyyyMMddHHmmss. Date stamps are in the UTC time zone

Parameters:

date - Date for timestamp

Returns:

the date stamp

get12DigitDate

public static java.lang.String get12DigitDate()

Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm. Date stamps are in the UTC time zone

Returns:

the date stamp for NOW

get12DigitDate

public static java.lang.String get12DigitDate(long date)

Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm. Date stamps are in the UTC time zone

Parameters:

date - milliseconds since epoc

Returns:

the date stamp

get12DigitDate

public static java.lang.String get12DigitDate(java.util.Date d)

Utility function for creating 12-digit(no seconds!) date stamps in the format yyyyMMddHHmm. Date stamps are in the UTC time zone

Parameters:

date - Date object to format

Returns:

the date stamp

getLog17Date

public static java.lang.String getLog17Date()

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Use current time. Format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Returns:

the date stamp for NOW

getLog17Date

public static java.lang.String getLog17Date(long date)

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Parameters:

date - milliseconds since epoc.

Returns:

the date stamp

getLog17Date

public static java.lang.String getLog17Date(java.util.Date date)

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Parameters:

date - Date to format.

Returns:

the date stamp

getLog14Date

public static java.lang.String getLog14Date()

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Use current time. Format is yyyy-MM-dd'T'HH:mm:ss'Z'

Returns:

the date stamp for NOW

getLog14Date

public static java.lang.String getLog14Date(long date)

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Format is yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:

date - long timestamp to format.

Returns:

the date stamp

getLog14Date

public static java.lang.String getLog14Date(java.util.Date date)

Utility function for creating log timestamps, in W3C/ISO8601 format, assuming UTC. Format is yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:

date - Date to format.

Returns:

the date stamp

getDate

public static java.util.Date getDate(java.lang.String d)
                              throws java.text.ParseException

Parses an ARC-style date. If passed String is < 12 characters in length, we pad. At a minimum, String should contain a year (>=4 characters). Parse will also fail if day or month are incompletely specified. Depends on the above getXXDigitDate methods.

Parameters:

A - 4-17 digit date in ARC style (yyyy to yyyyMMddHHmmssSSS) formatting.

Returns:

A Date object representing the passed String.

Throws:

java.text.ParseException

parse17DigitDate

public static java.util.Date parse17DigitDate(java.lang.String date)
                                       throws java.text.ParseException

Utility function for parsing arc-style date stamps in the format yyyMMddHHmmssSSS. Date stamps are in the UTC time zone. The whole string will not be parsed, only the first 17 digits.

Parameters:

date - an arc-style formatted date stamp

Returns:

the Date corresponding to the date stamp string

Throws:

java.text.ParseException - if the inputstring was malformed

parse14DigitDate

public static java.util.Date parse14DigitDate(java.lang.String date)
                                       throws java.text.ParseException

Utility function for parsing arc-style date stamps in the format yyyMMddHHmmss. Date stamps are in the UTC time zone. The whole string will not be parsed, only the first 14 digits.

Parameters:

date - an arc-style formatted date stamp

Returns:

the Date corresponding to the date stamp string

Throws:

java.text.ParseException - if the inputstring was malformed

parse12DigitDate

public static java.util.Date parse12DigitDate(java.lang.String date)
                                       throws java.text.ParseException

Utility function for parsing arc-style date stamps in the format yyyMMddHHmm. Date stamps are in the UTC time zone. The whole string will not be parsed, only the first 12 digits.

Parameters:

date - an arc-style formatted date stamp

Returns:

the Date corresponding to the date stamp string

Throws:

java.text.ParseException - if the inputstring was malformed

secondsSinceEpoch

public static java.lang.String secondsSinceEpoch(java.lang.String timestamp)
                                          throws java.text.ParseException

Parameters:

timestamp - A 14-digit timestamp or the suffix for a 14-digit timestamp: E.g. '20010909014640' or '20010101' or '1970'.

Returns:

Seconds since the epoch as a string zero-pre-padded so always Integer.MAX_VALUE wide (Makes it so sorting of resultant string works properly).

Throws:

java.text.ParseException

getSecondsSinceEpoch

public static java.util.Date getSecondsSinceEpoch(java.lang.String timestamp)
                                           throws java.text.ParseException

Parameters:

timestamp - A 14-digit timestamp or the suffix for a 14-digit timestamp: E.g. '20010909014640' or '20010101' or '1970'.

Returns:

A date.

Throws:

java.text.ParseException

See Also:

secondsSinceEpoch(String)

zeroPadInteger

public static java.lang.String zeroPadInteger(int i)

Parameters:

i - Integer to add prefix of zeros too. If passed 2005, will return the String 0000002005. String width is the width of Integer.MAX_VALUE as a string (10 digits).

Returns:

Padded String version of i.

padTo

public static java.lang.String padTo(int i,
                                     int pad)

Convert an int to a String, and pad it to pad spaces.

Parameters:

i - the int

pad - the width to pad to.

Returns:

String w/ padding.

padTo

public static java.lang.String padTo(java.lang.String s,
                                     int pad)

Pad the given String to pad characters wide by pre-pending spaces. s should not be null. If s is already wider than pad no change is done.

Parameters:

s - the String to pad

pad - the width to pad to.

Returns:

String w/ padding.

padTo

public static java.lang.String padTo(java.lang.String s,
                                     int pad,
                                     char padChar)

Pad the given String to pad characters wide by pre-pending padChar. s should not be null. If s is already wider than pad no change is done.

Parameters:

s - the String to pad

pad - the width to pad to.

padChar - The pad character to use.

Returns:

String w/ padding.

byteArrayEquals

public static boolean byteArrayEquals(byte[] lhs,
                                      byte[] rhs)

check that two byte arrays are equal. They may be null.

Parameters:

lhs - a byte array

rhs - another byte array.

Returns:

true if they are both equal (or both null)

doubleToString

public static java.lang.String doubleToString(double val,
                                              int maxFractionDigits)

Converts a double to a string.

Parameters:

val - The double to convert

precision - How many characters to include after '.'

Returns:

the double as a string.

formatBytesForDisplay

public static java.lang.String formatBytesForDisplay(long amount)

Takes a byte size and formats it for display with 'friendly' units.

This involves converting it to the largest unit (of B, KiB, MiB, GiB, TiB) for which the amount will be > 1.

Additionally, at least 2 significant digits are always displayed.

Negative numbers will be returned as '0 B'.

Parameters:

amount - the amount of bytes

Returns:

A string containing the amount, properly formated.

formatMillisecondsToConventional

public static java.lang.String formatMillisecondsToConventional(long time)

Convert milliseconds value to a human-readable duration

Parameters:

time -

Returns:

Human readable string version of passed time

formatMillisecondsToConventional

public static java.lang.String formatMillisecondsToConventional(long duration,
                                                                int unitCount)

Convert milliseconds value to a human-readable duration of mixed units, using units no larger than days. For example, "5d12h13m12s113ms" or "19h51m".

Parameters:

duration -

unitCount - how many significant units to show, at most for example, a value of 2 would show days+hours or hours+seconds but not hours+second+milliseconds

Returns:

Human readable string version of passed time

getUnique14DigitDate

public static java.lang.String getUnique14DigitDate()

Utility function for creating UNIQUE-from-this-class arc-style date stamps in the format yyyMMddHHmmss. Rather than giving a duplicate datestamp on a subsequent call, will increment the seconds until a unique value is returned. Date stamps are in the UTC time zone

Returns:

the date stamp