info.bliki.wiki.template.dates

Class StringToTime

java.lang.Object

java.util.Date

info.bliki.wiki.template.dates.StringToTime

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Date>

public class StringToTime
extends Date

A Java implementation of the PHP function strtotime(String, int): accepts various expressions of time in String format, and instantiates a Date object.

There are two ways to use StringToTime to parse dates:

• static methods (time(Object), date(Object), cal(Object))
• creating an instance of StringToTime with StringToTime(Object)

The static methods provide a UNIX-style timestamp, a Date instance, or a Calendar instance. In the event the time expression provided is invalid, these methods return Boolean.FALSE.

Instances of StringToTime inherit from Date; so, when instantiated with an expression that the algorithm recognizes, the resulting instance of StringToTime can be passed to any method or caller requiring a Date object. Unlike the static methods, attempting to create a StringToTime instance with an invalid expression of time results in a StringToTimeException.

Valid expressions of time

All expressions are case-insensitive.

• now (equal to new Date())
• today (equal to StringToTime("00:00:00.000"))
• midnight (equal to StringToTime("00:00:00.000 +24 hours"))
• morning or this morning (by default, equal to StringToTime("07:00:00.000"))
• noon (by default, equal to StringToTime("12:00:00.000")
• afternoon or this afternoon (by default, equal to StringToTime("13:00:00.000")
• evening or this evening (by default, equal to StringToTime("17:00:00.000")
• tonight (by default, equal to StringToTime("20:00:00.000")
• tomorrow (by default, equal to StringToTime("now +24 hours"))
• tomorrow morning (by default, equal to StringToTime("morning +24 hours"))
• noon tomorrow or tomorrow noon (by default, equal to StringToTime("noon +24 hours"))
• tomorrow afternoon (by default, equal to StringToTime("afternoon +24 hours"))
• yesterday (by default, equal to StringToTime("now -24 hours"))
• all the permutations of yesterday and morning, noon, afternoon, and evening
• October 26, 1981 or Oct 26, 1981
• October 26 or Oct 26
• 26 October 1981
• 26 Oct 1981
• 26 Oct 81
• 10/26/1981 or 10-26-1981
• 10/26/81 or 10-26-81
• 1981/10/26 or 1981-10-26
• 10/26 or 10-26

Copied from github.com/collegeman/stringtotime

Since:

JRE 1.5.0

Author:

Aaron Collegeman acollegeman@clutch-inc.com

See Also:

"https://us3.php.net/manual/en/function.strtotime.php", Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringToTime()
StringToTime(Date date)
StringToTime(Object dateTimeString)
StringToTime(Object dateTimeString, Date now)
StringToTime(Object dateTimeString, Date now, String simpleDateFormat)
StringToTime(Object dateTimeString, Integer now)
StringToTime(Object dateTimeString, Long now)
StringToTime(Object dateTimeString, String simpleDateFormat)

Method Summary

Modifier and Type	Method and Description
static Object	cal(Object dateTimeString)
static Object	cal(Object dateTimeString, Date now)
static Object	date(Object dateTimeString)
static Object	date(Object dateTimeString, Date now)
String	format(String simpleDateFormat)
Calendar	getCal()
long	getTime()
static Object	time(Object dateTimeString) A single parameter version of time(Object, Date), passing a new instance of Date as the second parameter.
static Object	time(Object dateTimeString, Date now) Parse dateTimeString and produce a timestamp.
String	toString()

Methods inherited from class java.util.Date

after, before, clone, compareTo, equals, from, getDate, getDay, getHours, getMinutes, getMonth, getSeconds, getTimezoneOffset, getYear, hashCode, parse, setDate, setHours, setMinutes, setMonth, setSeconds, setTime, setYear, toGMTString, toInstant, toLocaleString, UTC

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StringToTime

public StringToTime()

StringToTime

public StringToTime(Date date)

StringToTime

public StringToTime(Object dateTimeString)

StringToTime

public StringToTime(Object dateTimeString,
                    String simpleDateFormat)

StringToTime

public StringToTime(Object dateTimeString,
                    Date now)

StringToTime

public StringToTime(Object dateTimeString,
                    Long now)

StringToTime

public StringToTime(Object dateTimeString,
                    Integer now)

StringToTime

public StringToTime(Object dateTimeString,
                    Date now,
                    String simpleDateFormat)

Method Detail

getTime

public long getTime()

Overrides:

getTime in class Date

Returns:

Date.getTime()

getCal

public Calendar getCal()

Returns:

Calendar set to timestamp Date.getTime()

format

public String format(String simpleDateFormat)

Parameters:

simpleDateFormat -

Returns:

Date formatted according to simpleDateFormat

See Also:

SimpleDateFormat

toString

public String toString()

Overrides:

toString in class Date

Returns:

If simpleDateFormat provided in constructor, then attempts to format date accordingly; otherwise, returns the String value of Date.getTime().

time

public static Object time(Object dateTimeString)

A single parameter version of time(Object, Date), passing a new instance of Date as the second parameter.

Parameters:

dateTimeString -

Returns:

A Long timestamp representative of dateTimeString, or Boolean false.

See Also:

time(Object, Date)

time

public static Object time(Object dateTimeString,
                          Date now)

Parse dateTimeString and produce a timestamp.

Parameters:

dateTimeString -

now -

Returns:

• If equal to "now", return the number of milliseconds since January 1, 1970 or the value of now.
• If an incremental or decremental statement, e.g., +1 hour or -1 week, or a composite thereof, e.g., +1 hour 1 minute 1 second, returns a date equal to the increment/decrement plus the value of now.

date

public static Object date(Object dateTimeString)

date

public static Object date(Object dateTimeString,
                          Date now)

cal

public static Object cal(Object dateTimeString)

cal

public static Object cal(Object dateTimeString,
                         Date now)