com.blibli.oss.common.helper

Class DateHelper

java.lang.Object

com.blibli.oss.common.helper.DateHelper

public class DateHelper
extends Object

Author:

william.s.setiadi on 2/19/2018.

Constructor Summary

Constructors

Constructor and Description
DateHelper()

Method Summary

Modifier and Type	Method and Description
static Date	add(Date date, int diff, TimeUnit unit) Adds the specified amount of time to the given date.
static boolean	is(Date firstDate, TimeComparator comparator, Date secondDate) Evaluates whether firstDate satisfies comparator when compared to secondDate.
static Date	minus(Date date, int diff, TimeUnit unit) Subtracts the specified amount of time from the given date.
static Date	now() Syntax sugar.
static String	now(String pattern) Returns string representation of the current time according to the given pattern.
static Date	toDate(String str, String pattern) Parses the given str using pattern to an instance of Date.
static long	toMilliseconds(long input, TimeUnit unit) Converts input to milliseconds with respect to the given unit.
static String	toString(Date date, String pattern) Returns string representation of the given date and formats it according to the given pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateHelper

public DateHelper()

Method Detail

add

public static Date add(Date date,
                       int diff,
                       TimeUnit unit)

Adds the specified amount of time to the given date.

Parameters:

date - to be added

diff - time difference (numeric), to be paired with unit

unit - TimeUnit

Returns:

new instance of Date with the added amount of time difference if the base date is not null, otherwise returns null

minus

public static Date minus(Date date,
                         int diff,
                         TimeUnit unit)

Subtracts the specified amount of time from the given date.

Parameters:

date - to be subtracted

diff - time difference (numeric), to be paired with unit

unit - TimeUnit

Returns:

new instance of Date with the subtracted amount of time difference if the base date is not null, otherwise returns null

is

public static boolean is(Date firstDate,
                         TimeComparator comparator,
                         Date secondDate)

Evaluates whether firstDate satisfies comparator when compared to secondDate.

Parameters:

firstDate - of type Date

comparator - of type TimeComparator

secondDate - of type Date

Returns:

true if firstDate satisfies comparator when compared to secondDate.
Returns false if one of the following is true:

• Both firstDate and secondDate are null and TimeComparator.EQUAL_TO is not used
• Both firstDate and secondDate are null and TimeComparator.NOT_EQUAL_TO is used
• Both firstDate and secondDate are not null and TimeComparator.NOT_EQUAL_TO is used
• Either firstDate or secondDate is null
• comparator is null
• firstDate does not satisfy comparator when compared to secondDate

now

public static Date now()

Syntax sugar. Returns new Date.

Returns:

new Date

now

public static String now(String pattern)

Returns string representation of the current time according to the given pattern.

Parameters:

pattern - must conform to the specifications of DateTimeFormat

Returns:

string representation of the current time

See Also:

now(), DateTimeFormat

toDate

public static Date toDate(String str,
                          String pattern)

Parses the given str using pattern to an instance of Date.

Parameters:

str - to be parsed

pattern - must conform to the specifications of DateTimeFormat. Common patterns can be found in CommonDateTimePatterns.

Returns:

new instance of Date with the parsed value if neither str nor pattern is blank, otherwise returns null

toString

public static String toString(Date date,
                              String pattern)

Returns string representation of the given date and formats it according to the given pattern.

Parameters:

date - to be converted to String

pattern - must conform to the specifications of DateTimeFormat. Common patterns can be found in CommonDateTimePatterns.

Returns:

string representation of the given date. Never returns null.

toMilliseconds

public static long toMilliseconds(long input,
                                  TimeUnit unit)

Converts input to milliseconds with respect to the given unit.

Parameters:

input - time, paired with unit

unit - of type TimeUnit. Passing null will return the input itself, without converting it into milliseconds

Returns:

milliseconds value of input.