com.helger.datetime.util

Class PDTHelper

java.lang.Object

com.helger.datetime.util.PDTHelper

@Immutable
public final class PDTHelper
extends Object

Some date/time utility methods.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static int	birthdayCompare(LocalDate aDate1, LocalDate aDate2) Compare two dates by birthday.
static boolean	birthdayEquals(LocalDate aDate1, LocalDate aDate2) Check if the two birthdays are equal.
static DayOfWeek	getAsDayOfWeek(int nCalendarDayOfWeek) Convert from Calendar day of week to DayOfWeek enum.
static Month	getAsMonth(int nMonth) Get Month from int value in a non-throwing version.
static int	getCalendarDayOfWeek(DayOfWeek eDOW) Convert from DayOfWeek to Calendar day of week.
static LocalDate	getCurrentOrNextWeekday()
static LocalDate	getCurrentOrNextWeekday(LocalDate aStart) Get the next week day based on the provided date.
static LocalDate	getCurrentOrNextWeekendkDay() Get the next weekend day based on the provided date.
static LocalDate	getCurrentOrNextWeekendkDay(LocalDate aStart) Get the next weekend day based on the provided date.
static long	getDaysBetween(Temporal aStartIncl, Temporal aEndExcl)
static int	getEndWeekOfMonth(LocalDate aDT, Locale aLocale)
static int	getEndWeekOfMonth(LocalDateTime aDT, Locale aLocale) Get the end-week number for the passed year and month.
static int	getEndWeekOfMonth(ZonedDateTime aDT, Locale aLocale)
static LocalDate	getMax(LocalDate aDate1, LocalDate aDate2)
static LocalDateTime	getMax(LocalDateTime aDateTime1, LocalDateTime aDateTime2)
static LocalTime	getMax(LocalTime aTime1, LocalTime aTime2)
static OffsetDateTime	getMax(OffsetDateTime aDateTime1, OffsetDateTime aDateTime2)
static ZonedDateTime	getMax(ZonedDateTime aDateTime1, ZonedDateTime aDateTime2)
static LocalDate	getMin(LocalDate aDate1, LocalDate aDate2)
static LocalDateTime	getMin(LocalDateTime aDateTime1, LocalDateTime aDateTime2)
static LocalTime	getMin(LocalTime aTime1, LocalTime aTime2)
static OffsetDateTime	getMin(OffsetDateTime aDateTime1, OffsetDateTime aDateTime2)
static ZonedDateTime	getMin(ZonedDateTime aDateTime1, ZonedDateTime aDateTime2)
static int	getStartWeekOfMonth(LocalDate aDT, Locale aLocale)
static int	getStartWeekOfMonth(LocalDateTime aDT, Locale aLocale) Get the start--week number for the passed year and month.
static int	getStartWeekOfMonth(ZonedDateTime aDT, Locale aLocale)
static int	getWeekDays(LocalDate aStartDate, LocalDate aEndDate) Count all non-weekend days in the range.
static int	getWeekOfWeekBasedYear(TemporalAccessor aDT, Locale aLocale)
static boolean	isBetweenIncl(LocalDate aDate, LocalDate aLowerBound, LocalDate aUpperBound)
static boolean	isFirstDayOfWeek(DayOfWeek nDayOfWeek)
static boolean	isFirstDayOfWeek(LocalDate aDT)
static boolean	isFirstDayOfWeek(LocalDateTime aDT)
static boolean	isFirstDayOfWeek(ZonedDateTime aDT)
static boolean	isLastDayOfWeek(DayOfWeek nDayOfWeek)
static boolean	isLastDayOfWeek(LocalDate aDT)
static boolean	isLastDayOfWeek(LocalDateTime aDT)
static boolean	isLastDayOfWeek(ZonedDateTime aDT)
static boolean	isNewYearsEve(LocalDate aDate)
static boolean	isNullValue(LocalDate aDate)
static boolean	isNullValue(LocalDateTime aDateTime)
static boolean	isNullValue(LocalTime aTime)
static boolean	isNullValue(ZonedDateTime aDateTime)
static boolean	isSameMonthAndDay(LocalDate x, LocalDate y)
static boolean	isSameYearAndDay(LocalDate x, LocalDate y)
static boolean	isSameYearAndWeek(LocalDate x, LocalDate y, Locale aLocale)
static boolean	isWeekend(LocalDate aDT)
static boolean	isWeekend(LocalDateTime aDT)
static boolean	isWeekendDay(DayOfWeek nDayOfWeek)
static boolean	isWorkDay(LocalDate aDate)

Methods inherited from class java.lang.Object

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

Method Detail

isNullValue

public static boolean isNullValue(@Nullable
                                  LocalDate aDate)

isNullValue

public static boolean isNullValue(@Nullable
                                  LocalTime aTime)

isNullValue

public static boolean isNullValue(@Nullable
                                  LocalDateTime aDateTime)

isNullValue

public static boolean isNullValue(@Nullable
                                  ZonedDateTime aDateTime)

isWeekendDay

public static boolean isWeekendDay(DayOfWeek nDayOfWeek)

isWeekend

public static boolean isWeekend(@Nonnull
                                LocalDateTime aDT)

isWeekend

public static boolean isWeekend(@Nonnull
                                LocalDate aDT)

isFirstDayOfWeek

public static boolean isFirstDayOfWeek(DayOfWeek nDayOfWeek)

isFirstDayOfWeek

public static boolean isFirstDayOfWeek(@Nonnull
                                       ZonedDateTime aDT)

isFirstDayOfWeek

public static boolean isFirstDayOfWeek(@Nonnull
                                       LocalDateTime aDT)

isFirstDayOfWeek

public static boolean isFirstDayOfWeek(@Nonnull
                                       LocalDate aDT)

isLastDayOfWeek

public static boolean isLastDayOfWeek(DayOfWeek nDayOfWeek)

isLastDayOfWeek

public static boolean isLastDayOfWeek(@Nonnull
                                      ZonedDateTime aDT)

isLastDayOfWeek

public static boolean isLastDayOfWeek(@Nonnull
                                      LocalDateTime aDT)

isLastDayOfWeek

public static boolean isLastDayOfWeek(@Nonnull
                                      LocalDate aDT)

isWorkDay

public static boolean isWorkDay(@Nonnull
                                LocalDate aDate)

getWeekDays

public static int getWeekDays(@Nonnull
                              LocalDate aStartDate,
                              @Nonnull
                              LocalDate aEndDate)

Count all non-weekend days in the range. Does not consider holidays!

Parameters:

aStartDate - start date

aEndDate - end date

Returns:

days not counting Saturdays and Sundays. If start date is after end date, the value will be negative! If start date equals end date the return will be 1 if it is a week day.

isSameYearAndDay

public static boolean isSameYearAndDay(@Nonnull
                                       LocalDate x,
                                       @Nonnull
                                       LocalDate y)

isSameYearAndWeek

public static boolean isSameYearAndWeek(@Nonnull
                                        LocalDate x,
                                        @Nonnull
                                        LocalDate y,
                                        @Nonnull
                                        Locale aLocale)

isSameMonthAndDay

public static boolean isSameMonthAndDay(@Nonnull
                                        LocalDate x,
                                        @Nonnull
                                        LocalDate y)

isBetweenIncl

public static boolean isBetweenIncl(@Nullable
                                    LocalDate aDate,
                                    @Nullable
                                    LocalDate aLowerBound,
                                    @Nullable
                                    LocalDate aUpperBound)

getWeekOfWeekBasedYear

public static int getWeekOfWeekBasedYear(@Nonnull
                                         TemporalAccessor aDT,
                                         @Nonnull
                                         Locale aLocale)

getStartWeekOfMonth

public static int getStartWeekOfMonth(@Nonnull
                                      LocalDateTime aDT,
                                      @Nonnull
                                      Locale aLocale)

Get the start--week number for the passed year and month.

Parameters:

aDT - The object to use year and month from.

aLocale - Locale to use. May not be null.

Returns:

the start week number.

getStartWeekOfMonth

public static int getStartWeekOfMonth(@Nonnull
                                      LocalDate aDT,
                                      @Nonnull
                                      Locale aLocale)

getStartWeekOfMonth

public static int getStartWeekOfMonth(@Nonnull
                                      ZonedDateTime aDT,
                                      @Nonnull
                                      Locale aLocale)

getEndWeekOfMonth

public static int getEndWeekOfMonth(@Nonnull
                                    LocalDateTime aDT,
                                    @Nonnull
                                    Locale aLocale)

Get the end-week number for the passed year and month.

Parameters:

aDT - The object to use year and month from.

aLocale - Locale to use. May not be null.

Returns:

The end week number.

getEndWeekOfMonth

public static int getEndWeekOfMonth(@Nonnull
                                    LocalDate aDT,
                                    @Nonnull
                                    Locale aLocale)

getEndWeekOfMonth

public static int getEndWeekOfMonth(@Nonnull
                                    ZonedDateTime aDT,
                                    @Nonnull
                                    Locale aLocale)

getCurrentOrNextWeekday

@Nonnull
public static LocalDate getCurrentOrNextWeekday(@Nonnull
                                                          LocalDate aStart)

Get the next week day based on the provided date. If the provided date is a week day day, the provided date is returned. A week day is determined by not being a weekend day (usually Saturday or Sunday).

Parameters:

aStart - The date to start at. May not be null.

Returns:

The next matching date. Never null.

getCurrentOrNextWeekday

@Nonnull
public static LocalDate getCurrentOrNextWeekday()

getCurrentOrNextWeekendkDay

@Nonnull
public static LocalDate getCurrentOrNextWeekendkDay(@Nonnull
                                                              LocalDate aStart)

Get the next weekend day based on the provided date. If the provided date is a weekend day, the provided date is returned. Weekend day are Saturday or Sunday.

Parameters:

aStart - The date to start at. May not be null.

Returns:

The next matching date.

getCurrentOrNextWeekendkDay

@Nonnull
public static LocalDate getCurrentOrNextWeekendkDay()

Get the next weekend day based on the provided date. If the provided date is a weekend day, the provided date is returned. Weekend day are Saturday or Sunday.

Returns:

The next matching date.

birthdayCompare

public static int birthdayCompare(@Nullable
                                  LocalDate aDate1,
                                  @Nullable
                                  LocalDate aDate2)

Compare two dates by birthday. This means, the dates are only compared by day and month, and not by year!

Parameters:

aDate1 - First date. May be null.

aDate2 - Second date. May be null.

Returns:

same as Comparator.compare(Object, Object)

birthdayEquals

public static boolean birthdayEquals(@Nullable
                                     LocalDate aDate1,
                                     @Nullable
                                     LocalDate aDate2)

Check if the two birthdays are equal. Equal birthdays are identified by equal months and equal days.

Parameters:

aDate1 - First date. May be null.

aDate2 - Second date. May be null.

Returns:

true if month and day are equal

isNewYearsEve

public static boolean isNewYearsEve(@Nonnull
                                    LocalDate aDate)

getMax

@Nonnull
public static LocalDate getMax(@Nonnull
                                         LocalDate aDate1,
                                         @Nonnull
                                         LocalDate aDate2)

getMax

@Nonnull
public static LocalTime getMax(@Nonnull
                                         LocalTime aTime1,
                                         @Nonnull
                                         LocalTime aTime2)

getMax

@Nonnull
public static LocalDateTime getMax(@Nonnull
                                             LocalDateTime aDateTime1,
                                             @Nonnull
                                             LocalDateTime aDateTime2)

getMax

@Nonnull
public static ZonedDateTime getMax(@Nonnull
                                             ZonedDateTime aDateTime1,
                                             @Nonnull
                                             ZonedDateTime aDateTime2)

getMax

@Nonnull
public static OffsetDateTime getMax(@Nonnull
                                              OffsetDateTime aDateTime1,
                                              @Nonnull
                                              OffsetDateTime aDateTime2)

getMin

@Nonnull
public static LocalDate getMin(@Nonnull
                                         LocalDate aDate1,
                                         @Nonnull
                                         LocalDate aDate2)

getMin

@Nonnull
public static LocalTime getMin(@Nonnull
                                         LocalTime aTime1,
                                         @Nonnull
                                         LocalTime aTime2)

getMin

@Nonnull
public static LocalDateTime getMin(@Nonnull
                                             LocalDateTime aDateTime1,
                                             @Nonnull
                                             LocalDateTime aDateTime2)

getMin

@Nonnull
public static ZonedDateTime getMin(@Nonnull
                                             ZonedDateTime aDateTime1,
                                             @Nonnull
                                             ZonedDateTime aDateTime2)

getMin

@Nonnull
public static OffsetDateTime getMin(@Nonnull
                                              OffsetDateTime aDateTime1,
                                              @Nonnull
                                              OffsetDateTime aDateTime2)

getDaysBetween

public static long getDaysBetween(@Nonnull
                                  Temporal aStartIncl,
                                  @Nonnull
                                  Temporal aEndExcl)

getAsDayOfWeek

@Nonnull
public static DayOfWeek getAsDayOfWeek(int nCalendarDayOfWeek)

Convert from Calendar day of week to DayOfWeek enum.

Parameters:

nCalendarDayOfWeek - Day of week - must be between 1 and 7.

Returns:

DayOfWeek and never null.

Since:

8.6.3

getCalendarDayOfWeek

public static int getCalendarDayOfWeek(@Nonnull
                                       DayOfWeek eDOW)

Convert from DayOfWeek to Calendar day of week.

Parameters:

eDOW - Day of week. May not be null.

Returns:

Something between Calendar.SUNDAY and Calendar.SATURDAY

Since:

8.6.3

getAsMonth

@Nullable
public static Month getAsMonth(int nMonth)

Get Month from int value in a non-throwing version.

Parameters:

nMonth - Month to use. 1 == January, 12 == December

Returns:

null if invalid int was provided.