com.jdroid.java.date

Class DateUtils

java.lang.Object

com.jdroid.java.date.DateUtils

public abstract class DateUtils
extends java.lang.Object

Utilities for Dates and Calendars

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DATE_TIME_FORMAT
static int	HOURS_PER_DAY Number of hours in a day
static long	MILLIS_PER_DAY Number of milliseconds in a day.
static long	MILLIS_PER_HOUR Number of milliseconds in a hour.
static long	MILLIS_PER_MINUTE Number of milliseconds in a minute.
static long	MILLIS_PER_SECOND Number of milliseconds in a second.
static long	MILLIS_PER_WEEK Number of milliseconds in a week.
static int	SECONDS_PER_DAY Seconds in a day
static int	SECONDS_PER_HOUR Seconds in an hour
static int	SECONDS_PER_MINUTE Seconds in a minute
static int	WEEK Seconds in a week

Constructor Summary

Constructors

Constructor and Description
DateUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Date	addDays(java.util.Date date, int days)
static java.util.Date	addHours(java.util.Date date, int hours)
static java.util.Date	addMonths(java.util.Date date, int days)
static java.util.Date	addSeconds(java.util.Date date, int seconds)
static java.util.Date	addYears(java.util.Date date, int years)
static boolean	containsPeriod(java.util.Date startDate1, java.util.Date endDate1, java.util.Date startDate2, java.util.Date endDate2) Returns true if the first period contains the second periods
static java.lang.Integer	differenceInDays(java.util.Date fromDate, java.util.Date toDate)
static double	differenceInHours(java.util.Date fromDate, java.util.Date toDate)
static java.lang.Integer	differenceInMinutes(java.util.Date fromDate, java.util.Date toDate)
static java.lang.String	format(java.util.Date date, java.text.DateFormat dateFormat) Transform the Date to a String using the received SimpleDateFormat
static java.lang.String	format(java.util.Date date, java.text.DateFormat dateFormat, boolean useUtc)
static java.lang.String	format(java.util.Date date, java.lang.String dateFormat)
static java.lang.String	format(java.util.Date date, java.lang.String dateFormat, boolean useUtc)
static java.lang.String	formatDate(java.util.Date date)
static java.lang.String	formatDateTime(java.util.Date date)
static java.lang.String	formatDuration(long duration)
static java.lang.String	formatTime(java.util.Date date)
static java.lang.String	formatToCardinal(java.util.Date date) Transform the Date to a String with a format like Friday November 5th
static java.util.Date	getDate(java.util.Date date, java.util.Date time)
static java.util.Date	getDate(java.util.Date date, java.util.Date time, java.lang.Boolean is24Hour)
static java.util.Date	getDate(int year, int monthOfYear, int dayOfMonth) Creates a Date for the specified day
static java.util.Date	getDate(long milliseconds)
static int	getDayOfMonth(java.util.Date date)
static DayOfWeek	getDayOfWeek()
static DayOfWeek	getDayOfWeek(java.util.Date date)
static int	getHour(java.util.Date date, java.lang.Boolean is24Hour)
static int	getHour(java.util.Date date, java.util.TimeZone timeZone, java.lang.Boolean is24Hour)
static java.util.Date	getLastDayOfMonth(java.util.Date date)
static int	getMinute(java.util.Date date)
static int	getMinute(java.util.Date date, java.util.TimeZone timeZone)
static int	getMonth(java.util.Date date)
static java.util.Date	getTime(int hour, int minutes)
static java.util.Date	getTime(int hour, int minutes, java.lang.Boolean is24Hour)
static int	getYear()
static int	getYear(java.util.Date date)
static void	init()
static boolean	isAfter(java.util.Date date, java.util.Date dateToCompare) Tests if the date is after than the specified dateToCompare.
static boolean	isAfterEquals(java.util.Date date, java.util.Date dateToCompare) Tests if the date is after or equals than the specified dateToCompare.
static boolean	isBefore(java.util.Date date, java.util.Date dateToCompare) Tests if the date is before than the specified dateToCompare.
static boolean	isBeforeEquals(java.util.Date date, java.util.Date dateToCompare) Tests if the date is before or equals than the specified dateToCompare.
static boolean	isBetween(java.util.Date date, java.util.Date startDate, java.util.Date endDate)
static boolean	isDateOnWeekend(java.util.Date date)
static java.lang.Long	millisecondsToDays(java.lang.Long timestamp)
static java.util.Date	monthsAway(int months)
static java.util.Date	now()
static long	nowMillis()
static java.util.Date	oneMonthInFuture()
static java.util.Date	oneMonthInPast()
static java.util.Date	parse(java.lang.String dateFormatted, java.text.SimpleDateFormat dateFormat)
static java.util.Date	parse(java.lang.String dateFormatted, java.text.SimpleDateFormat dateFormat, boolean useUtc)
static java.util.Date	parse(java.lang.String dateFormatted, java.lang.String dateFormat)
static java.util.Date	parse(java.lang.String dateFormatted, java.lang.String dateFormat, boolean useUtc)
static boolean	periodsOverlap(java.util.Date startDate1, java.util.Date endDate1, java.util.Date startDate2, java.util.Date endDate2) Returns true if two periods overlap
static void	setFakeNow(java.util.Date fakeNow)
static java.util.Date	setHour(java.util.Date date, int hours, java.lang.Boolean is24Hour)
static java.util.Date	today()
static java.util.Calendar	todayCalendar()
static java.util.Date	tomorrow()
static void	truncateDate(java.util.Calendar calendar) Truncate the Calendar date asigning it to 1st of January of 1980
static java.util.Date	truncateDate(java.util.Date date) Truncate the date asigning it to 1st of January of 1980
static void	truncateTime(java.util.Calendar calendar) Truncate the Calendar removing hours, minutes, seconds and milliseconds
static java.util.Date	truncateTime(java.util.Date date) Truncate the date removing hours, minutes, seconds and milliseconds
static java.util.Date	yesterday()

Methods inherited from class java.lang.Object

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

Field Detail

SECONDS_PER_MINUTE

public static final int SECONDS_PER_MINUTE

Seconds in a minute

See Also:

Constant Field Values

SECONDS_PER_HOUR

public static final int SECONDS_PER_HOUR

Seconds in an hour

See Also:

Constant Field Values

SECONDS_PER_DAY

public static final int SECONDS_PER_DAY

Seconds in a day

See Also:

Constant Field Values

WEEK

public static final int WEEK

Seconds in a week

See Also:

Constant Field Values

MILLIS_PER_SECOND

public static final long MILLIS_PER_SECOND

Number of milliseconds in a second.

See Also:

Constant Field Values

MILLIS_PER_MINUTE

public static final long MILLIS_PER_MINUTE

Number of milliseconds in a minute.

See Also:

Constant Field Values

MILLIS_PER_HOUR

public static final long MILLIS_PER_HOUR

Number of milliseconds in a hour.

See Also:

Constant Field Values

MILLIS_PER_DAY

public static final long MILLIS_PER_DAY

Number of milliseconds in a day.

See Also:

Constant Field Values

MILLIS_PER_WEEK

public static final long MILLIS_PER_WEEK

Number of milliseconds in a week.

See Also:

Constant Field Values

HOURS_PER_DAY

public static final int HOURS_PER_DAY

Number of hours in a day

See Also:

Constant Field Values

DEFAULT_DATE_TIME_FORMAT

public static java.lang.String DEFAULT_DATE_TIME_FORMAT

Constructor Detail

DateUtils

public DateUtils()

Method Detail

init

public static void init()

parse

public static java.util.Date parse(java.lang.String dateFormatted,
                   java.lang.String dateFormat)

Parameters:

dateFormatted - The formatted string to parse

dateFormat -

Returns:

A date that represents the formatted string

parse

public static java.util.Date parse(java.lang.String dateFormatted,
                   java.lang.String dateFormat,
                   boolean useUtc)

parse

public static java.util.Date parse(java.lang.String dateFormatted,
                   java.text.SimpleDateFormat dateFormat)

Parameters:

dateFormatted - The formatted string to parse

dateFormat -

Returns:

A date that represents the formatted string

parse

public static java.util.Date parse(java.lang.String dateFormatted,
                   java.text.SimpleDateFormat dateFormat,
                   boolean useUtc)

formatToCardinal

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

Transform the Date to a String with a format like Friday November 5th

Parameters:

date - The Date to be formatted

Returns:

A String that represent the date with the pattern

format

public static java.lang.String format(java.util.Date date,
                      java.lang.String dateFormat)

Parameters:

date - The Date to be formatted

dateFormat - The DateFormat used to format the Date

Returns:

A String that represent the date with the pattern

format

public static java.lang.String format(java.util.Date date,
                      java.lang.String dateFormat,
                      boolean useUtc)

format

public static java.lang.String format(java.util.Date date,
                      java.text.DateFormat dateFormat)

Transform the Date to a String using the received SimpleDateFormat

Parameters:

date - The Date to be formatted

dateFormat - The DateFormat used to format the Date

Returns:

A String that represent the date with the pattern

format

public static java.lang.String format(java.util.Date date,
                      java.text.DateFormat dateFormat,
                      boolean useUtc)

formatDateTime

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

formatDate

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

formatTime

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

getDate

public static java.util.Date getDate(int year,
                     int monthOfYear,
                     int dayOfMonth)

Creates a Date for the specified day

Parameters:

year - The year

monthOfYear - The month number (starting on 0)

dayOfMonth - The day of the month

Returns:

The Date

getDate

public static java.util.Date getDate(java.util.Date date,
                     java.util.Date time,
                     java.lang.Boolean is24Hour)

getDate

public static java.util.Date getDate(java.util.Date date,
                     java.util.Date time)

getDate

public static java.util.Date getDate(long milliseconds)

getTime

public static java.util.Date getTime(int hour,
                     int minutes)

getTime

public static java.util.Date getTime(int hour,
                     int minutes,
                     java.lang.Boolean is24Hour)

getYear

public static int getYear()

getYear

public static int getYear(java.util.Date date)

getMonth

public static int getMonth(java.util.Date date)

getDayOfMonth

public static int getDayOfMonth(java.util.Date date)

getHour

public static int getHour(java.util.Date date,
          java.lang.Boolean is24Hour)

getHour

public static int getHour(java.util.Date date,
          java.util.TimeZone timeZone,
          java.lang.Boolean is24Hour)

getMinute

public static int getMinute(java.util.Date date)

getMinute

public static int getMinute(java.util.Date date,
            java.util.TimeZone timeZone)

getDayOfWeek

public static DayOfWeek getDayOfWeek()

getDayOfWeek

public static DayOfWeek getDayOfWeek(java.util.Date date)

isDateOnWeekend

public static boolean isDateOnWeekend(java.util.Date date)

setHour

public static java.util.Date setHour(java.util.Date date,
                     int hours,
                     java.lang.Boolean is24Hour)

addSeconds

public static java.util.Date addSeconds(java.util.Date date,
                        int seconds)

addHours

public static java.util.Date addHours(java.util.Date date,
                      int hours)

addDays

public static java.util.Date addDays(java.util.Date date,
                     int days)

addMonths

public static java.util.Date addMonths(java.util.Date date,
                       int days)

addYears

public static java.util.Date addYears(java.util.Date date,
                      int years)

truncateDate

public static java.util.Date truncateDate(java.util.Date date)

Truncate the date asigning it to 1st of January of 1980

Parameters:

date - The Date to truncate

Returns:

The truncated Date

truncateDate

public static void truncateDate(java.util.Calendar calendar)

Truncate the Calendar date asigning it to 1st of January of 1980

Parameters:

calendar - The Calendar to truncate

truncateTime

public static java.util.Date truncateTime(java.util.Date date)

Truncate the date removing hours, minutes, seconds and milliseconds

Parameters:

date - The Date to truncate

Returns:

The truncated Date

truncateTime

public static void truncateTime(java.util.Calendar calendar)

Truncate the Calendar removing hours, minutes, seconds and milliseconds

Parameters:

calendar - The Calendar to truncate

now

public static java.util.Date now()

Returns:

the current moment

nowMillis

public static long nowMillis()

isBetween

public static boolean isBetween(java.util.Date date,
                java.util.Date startDate,
                java.util.Date endDate)

Parameters:

date - The date to compare

startDate - The left between' side

endDate - The right between's side

Returns:

true if the date is in the middle of startDate and endDate

isBefore

public static boolean isBefore(java.util.Date date,
               java.util.Date dateToCompare)

Tests if the date is before than the specified dateToCompare.

Parameters:

date - the date to compare with the dateToCompare.

dateToCompare - the date to compare with the date.

Returns:

true if the instant of time represented by date object is earlier than the instant represented by dateToCompare; false otherwise.

isBeforeEquals

public static boolean isBeforeEquals(java.util.Date date,
                     java.util.Date dateToCompare)

Tests if the date is before or equals than the specified dateToCompare.

Parameters:

date - the date to compare with the dateToCompare.

dateToCompare - the date to compare with the date.

Returns:

true if the instant of time represented by date object is earlier or equal than the instant represented by dateToCompare; false otherwise.

isAfterEquals

public static boolean isAfterEquals(java.util.Date date,
                    java.util.Date dateToCompare)

Tests if the date is after or equals than the specified dateToCompare.

Parameters:

date - the date to compare with the dateToCompare.

dateToCompare - the date to compare with the date.

Returns:

true if the instant of time represented by date object is later or equal than the instant represented by dateToCompare; false otherwise.

isAfter

public static boolean isAfter(java.util.Date date,
              java.util.Date dateToCompare)

Tests if the date is after than the specified dateToCompare.

Parameters:

date - the date to compare with the dateToCompare.

dateToCompare - the date to compare with the date.

Returns:

true if the instant of time represented by date object is later than the instant represented by dateToCompare; false otherwise.

periodsOverlap

public static boolean periodsOverlap(java.util.Date startDate1,
                     java.util.Date endDate1,
                     java.util.Date startDate2,
                     java.util.Date endDate2)

Returns true if two periods overlap

Parameters:

startDate1 - the period one start date

endDate1 - the period one end date

startDate2 - the period two start date

endDate2 - the period two end date

Returns:

true if overlap

containsPeriod

public static boolean containsPeriod(java.util.Date startDate1,
                     java.util.Date endDate1,
                     java.util.Date startDate2,
                     java.util.Date endDate2)

Returns true if the first period contains the second periods

Parameters:

startDate1 - the period one start date

endDate1 - the period one end date

startDate2 - the period two start date

endDate2 - the period two end date

Returns:

true if the first period contains the second period

todayCalendar

public static java.util.Calendar todayCalendar()

tomorrow

public static java.util.Date tomorrow()

Returns:

a day after today

today

public static java.util.Date today()

yesterday

public static java.util.Date yesterday()

Returns:

a day before today

monthsAway

public static java.util.Date monthsAway(int months)

Parameters:

months - amount of months to move the calendar

Returns:

a date that is months in the future/past. Use negative values for past dates.

oneMonthInFuture

public static java.util.Date oneMonthInFuture()

Returns:

a date that is one month in the future

oneMonthInPast

public static java.util.Date oneMonthInPast()

Returns:

a date that is one month in the past

getLastDayOfMonth

public static java.util.Date getLastDayOfMonth(java.util.Date date)

Parameters:

date - Date that includes the desired month in order to calculate the last day of that month

Returns:

the date of the last day of the month

differenceInDays

public static java.lang.Integer differenceInDays(java.util.Date fromDate,
                                 java.util.Date toDate)

Parameters:

fromDate - the start date

toDate - the end date

Returns:

an integer representing the amount of days between fromDate and toDate

differenceInHours

public static double differenceInHours(java.util.Date fromDate,
                       java.util.Date toDate)

Parameters:

fromDate - the start date

toDate - the end date

Returns:

an double representing the amount of hours between fromDate and toDate

differenceInMinutes

public static java.lang.Integer differenceInMinutes(java.util.Date fromDate,
                                    java.util.Date toDate)

Parameters:

fromDate - the start date

toDate - the end date

Returns:

an integer representing the amount of minutes between fromDate and toDate

formatDuration

public static java.lang.String formatDuration(long duration)

millisecondsToDays

public static java.lang.Long millisecondsToDays(java.lang.Long timestamp)

setFakeNow

public static void setFakeNow(java.util.Date fakeNow)