DateHelper (Plugin basics for external printing 1.33 API)

java.lang.Object
- com.secutix.plugin.externalprinting.v1_0.catalog.dto.DateHelper

public final class DateHelper
extends Object

Helper to handle with dates.

Field Summary

Fields
Modifier and Type	Field and Description
`static Date`	`DAY_END_TIME` is 24:00
`static Date`	`DAY_START_TIME` is 00:00
`static Date`	`INFINITE_FUTURE` Value `new Date(Long.MAX)` doesn't work because the value will be truncated when it is saved into database.
`static Date`	`INFINITE_FUTURE_DATE`
`static Date`	`INFINITE_FUTURE_TIME`
`static Date`	`INFINITE_PAST` Value `new Date(Long.MIN)` doesn't work because the value will be truncated when it is saved into database.
`static Date`	`INFINITE_PAST_DATE`
`static Date`	`INFINITE_PAST_TIME`
`static String`	`ISO_DATE_FORMAT` The ISO format for a date.
`static String`	`ISO_DATETIME_FORMAT` The ISO format for a date with time (until seconds).
`static String`	`ISO_TIME_FORMAT` The ISO format for time (until seconds).

Constructor Summary

Constructors
Constructor and Description

DateHelper()

Constructors
Constructor and Description
`DateHelper()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addDaysToDate(Date date, int noOfDays)`
`static void`	`addMonthToDate(Date date, int monthAmount)`
`static void`	`addTimeSpanToDate(Date date, TimeSpan timeSpan)`
`static void`	`addYearToDate(Date date, int yearAmount)`
`static boolean`	`after(Date baseDate, Date compareDate)` Deprecated.
`static boolean`	`before(Date baseDate, Date compareDate)` Deprecated.
`static boolean`	`dateAfter(Date baseDate, Date compareDate)`
`static boolean`	`dateAfterOrEqual(Date baseDate, Date compareDate)`
`static boolean`	`dateBefore(Date baseDate, Date compareDate)`
`static boolean`	`dateBeforeOrEqual(Date baseDate, Date compareDate)`
`static boolean`	`dateEquals(Date d1, Date d2)` Compares two dates for equality based on their dates only.
`static boolean`	`equals(Date d1, Date d2)` Deprecated.
`static Date`	`futureInfinite()`
`static Calendar`	`getCalendarInstance()`
`static Date`	`getDate(Calendar calendar)` Converts the given `Calendar` into a `Date`.
`static Date`	`getDate(Date date)` Extracts only the date part of `Date`.
`static Date`	`getDate(int year, int month, int day)` Creates a `Date` out of the given parameters.
`static int`	`getDayOfMonth(Date date)`
`static Date`	`getEndOfTheDay(Date date)` Deprecated.
`static int`	`getMonth(Date date)`
`static Date`	`getStartOfTheDay(Date date)` Deprecated.
`static Date`	`getTime(Calendar calendar)` Converts the given `Calendar` into a `Date`.
`static Date`	`getTime(Date date)` Extracts only the date part of `Date`.
`static Date`	`getTime(int hour, int min, int sec)`
`static int`	`getYear(Date date)`
`static boolean`	`isAnySet(Date date)`
`static boolean`	`isDateBetween(Date date, Date from, Date to)` Returns true if the given `date` is between the `from` and the `to` date (from and to included).
`static boolean`	`isDateSet(Date date)`
`static boolean`	`isDateTimeSet(Date date)` Deprecated.
`static Date`	`isoDateStringToDate(String isoDateString)`
`static Date`	`isoDateTimeStringToDate(String isoDateString)`
`static boolean`	`isTimeSet(Date date)`
`static boolean`	`isWithinBounds(Date date)` Checks if the given date is within the allowed bounds, i.e.
`static Date`	`now()` Deprecated.
`static Date`	`pastInfinite()`
`static Date`	`stringToDate(String date)` Deprecated.
`static boolean`	`timeAfter(Date base, Date compare)`
`static boolean`	`timeAfterOrEqual(Date base, Date compare)`
`static boolean`	`timeBefore(Date base, Date compare)`
`static boolean`	`timeBeforeOrEqual(Date base, Date compare)`
`static boolean`	`timeEquals(Date d1, Date d2)` Compares two times for equality based on their times only.
`static Date`	`today()`
`static Date`	`tomorrow()` Returns the `Date` of tomorrow with the current time.
`static Date`	`tomorrow(Date date)` Returns the given `Date` plus one day with the same time.
`static Date`	`yesterday()` Returns the `Date` of yesterday with the current time.
`static Date`	`yesterday(Date date)` Returns the given `Date` minus one day with the same time.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ISO_DATE_FORMAT
```
public static final String ISO_DATE_FORMAT
```
    The ISO format for a date.
    
    See Also:
    
    Constant Field Values
  - ISO_DATETIME_FORMAT
```
public static final String ISO_DATETIME_FORMAT
```
    The ISO format for a date with time (until seconds).
    
    See Also:
    
    Constant Field Values
  - ISO_TIME_FORMAT
```
public static final String ISO_TIME_FORMAT
```
    The ISO format for time (until seconds). The valid range is 00:00:00 to 23:59:59.
    
    See Also:
    
    Constant Field Values
  - INFINITE_PAST
```
public static final Date INFINITE_PAST
```
    Value new Date(Long.MIN) doesn't work because the value will be truncated when it is saved into database. The used date is 1 January 0001.
  - INFINITE_PAST_DATE
```
public static final Date INFINITE_PAST_DATE
```
  - INFINITE_PAST_TIME
```
public static final Date INFINITE_PAST_TIME
```
  - INFINITE_FUTURE
```
public static final Date INFINITE_FUTURE
```
    Value new Date(Long.MAX) doesn't work because the value will be truncated when it is saved into database. The used date is 31 December 2999. The time measure is cyclic, so, we cannot flag a specific value. So, we use a hack and put a flag on the millisecond value.
  - INFINITE_FUTURE_DATE
```
public static final Date INFINITE_FUTURE_DATE
```
  - INFINITE_FUTURE_TIME
```
public static final Date INFINITE_FUTURE_TIME
```
  - DAY_START_TIME
```
public static final Date DAY_START_TIME
```
    is 00:00
  - DAY_END_TIME
```
public static final Date DAY_END_TIME
```
    is 24:00
- Constructor Detail
  - DateHelper
```
public DateHelper()
```
- Method Detail
  - getCalendarInstance
```
public static Calendar getCalendarInstance()
```
    Returns:
    
    a Calendar instance
  - getDate
```
public static Date getDate(Date date)
```
    Extracts only the date part of Date. The time component of the given Date will be ignored.
    
    Parameters:
    
    date - Is the date to manage.
    
    Returns:
    
    Returns the date.
  - getDate
```
public static Date getDate(Calendar calendar)
```
    Converts the given Calendar into a Date. The time component of the given calendar will be ignored.
    
    Parameters:
    
    calendar - Is the calendar to convert.
    
    Returns:
    
    Returns the date.
  - getTime
```
public static Date getTime(Date date)
```
    Extracts only the date part of Date. The time component of the given Date will be ignored.
    
    Parameters:
    
    date - Is the date to manage.
    
    Returns:
    
    Returns the date.
  - getTime
```
public static Date getTime(Calendar calendar)
```
    Converts the given Calendar into a Date. The time component of the given calendar will be ignored.
    
    Parameters:
    
    calendar - Is the calendar to convert.
    
    Returns:
    
    Returns the date.
  - getDate
```
public static Date getDate(int year,
                           int month,
                           int day)
```
    Creates a Date out of the given parameters.
    
    Parameters:
    
    year - Is the year part of the date.
    
    month - Is the month part of the date.
    
    day - Is the day part of the date.
    
    Returns:
    
    Returns the created date; time of the date is 00:00:00
  - getTime
```
public static Date getTime(int hour,
                           int min,
                           int sec)
```
  - isWithinBounds
```
public static boolean isWithinBounds(Date date)
```
    Checks if the given date is within the allowed bounds, i.e. between INFINITE_PAST and INFINITE_FUTURE.
    
    Parameters:
    
    date - the date to check
    
    Returns:
    
    true if within bounds
  - pastInfinite
```
public static Date pastInfinite()
```
    Returns:
    
    Returns the Date 1 January 0001 00:00:00.666.
  - futureInfinite
```
public static Date futureInfinite()
```
    Returns:
    
    Returns the Date 31 December 2999 00:00:00.666.
  - yesterday
```
public static Date yesterday(Date date)
```
    Returns the given Date minus one day with the same time.
    
    Parameters:
    
    date - Is the given date.
    
    Returns:
    
    Returns the calculated date (time will be 00:00:00).
  - yesterday
```
public static Date yesterday()
```
    Returns the Date of yesterday with the current time.
    
    Returns:
    
    Returns the calculated date (time will be 00:00:00).
  - today
```
public static Date today()
```
    Returns:
    
    Returns the Date of today with time 00:00:00.
  - tomorrow
```
public static Date tomorrow(Date date)
```
    Returns the given Date plus one day with the same time.
    
    Parameters:
    
    date - Is the given date.
    
    Returns:
    
    Returns the calculated date (time will be 00:00:00).
  - tomorrow
```
public static Date tomorrow()
```
    Returns the Date of tomorrow with the current time.
    
    Returns:
    
    Returns the calculated date (time will be 00:00:00).
  - isDateBetween
```
public static boolean isDateBetween(Date date,
                                    Date from,
                                    Date to)
```
    Returns true if the given date is between the from and the to date (from and to included).
    
    Parameters:
    
    date - Is the date to test.
    
    from - Is the region start date.
    
    to - Is the region stop date.
    
    Returns:
    
    Returns true if the given date is between the from and the to date (from and to included).
  - dateEquals
```
public static boolean dateEquals(Date d1,
                                 Date d2)
```
    Compares two dates for equality based on their dates only.
    
    Parameters:
    
    d1 - base date
    
    d2 - the date to compare with
    
    Returns:
    
    true if the objects are the same; false otherwise.
  - timeEquals
```
public static boolean timeEquals(Date d1,
                                 Date d2)
```
    Compares two times for equality based on their times only.
    
    Parameters:
    
    d1 - base time
    
    d2 - the time to compare with
    
    Returns:
    
    true if the objects are the same; false otherwise.
  - dateBefore
```
public static boolean dateBefore(Date baseDate,
                                 Date compareDate)
```
  - dateBeforeOrEqual
```
public static boolean dateBeforeOrEqual(Date baseDate,
                                        Date compareDate)
```
  - timeBefore
```
public static boolean timeBefore(Date base,
                                 Date compare)
```
  - timeBeforeOrEqual
```
public static boolean timeBeforeOrEqual(Date base,
                                        Date compare)
```
  - dateAfter
```
public static boolean dateAfter(Date baseDate,
                                Date compareDate)
```
  - dateAfterOrEqual
```
public static boolean dateAfterOrEqual(Date baseDate,
                                       Date compareDate)
```
  - timeAfter
```
public static boolean timeAfter(Date base,
                                Date compare)
```
  - timeAfterOrEqual
```
public static boolean timeAfterOrEqual(Date base,
                                       Date compare)
```
  - isDateSet
```
public static boolean isDateSet(Date date)
```
  - isTimeSet
```
public static boolean isTimeSet(Date date)
```
  - isAnySet
```
public static boolean isAnySet(Date date)
```
  - isoDateTimeStringToDate
```
public static Date isoDateTimeStringToDate(String isoDateString)
```
  - isoDateStringToDate
```
public static Date isoDateStringToDate(String isoDateString)
```
  - getDayOfMonth
```
public static int getDayOfMonth(Date date)
```
  - getMonth
```
public static int getMonth(Date date)
```
  - getYear
```
public static int getYear(Date date)
```
  - addDaysToDate
```
public static void addDaysToDate(Date date,
                                 int noOfDays)
```
  - addMonthToDate
```
public static void addMonthToDate(Date date,
                                  int monthAmount)
```
  - addYearToDate
```
public static void addYearToDate(Date date,
                                 int yearAmount)
```
  - addTimeSpanToDate
```
public static void addTimeSpanToDate(Date date,
                                     TimeSpan timeSpan)
```
  - stringToDate
```
@Deprecated
public static Date stringToDate(String date)
```
    Deprecated.
  - isDateTimeSet
```
@Deprecated
public static boolean isDateTimeSet(Date date)
```
    Deprecated.
  - after
```
@Deprecated
public static boolean after(Date baseDate,
                                         Date compareDate)
```
    Deprecated.
    
    Tests if this date is after the specified date.
    
    Parameters:
    
    baseDate - base date
    
    compareDate - the date to compare with
    
    Returns:
    
    true if and only if the instant represented by this Date object is strictly later than the instant represented by when; false otherwise.
  - equals
```
@Deprecated
public static boolean equals(Date d1,
                                          Date d2)
```
    Deprecated.
    
    Compares two dates for equality.
    
    Parameters:
    
    d1 - base date
    
    d2 - the date to compare with
    
    Returns:
    
    true if the objects are the same; false otherwise.
  - before
```
@Deprecated
public static boolean before(Date baseDate,
                                          Date compareDate)
```
    Deprecated.
    
    Tests if this date is before the specified date.
    
    Parameters:
    
    baseDate - base date
    
    compareDate - the date to compare with
    
    Returns:
    
    true if and only if the instant of time represented by this Date object is strictly earlier than the instant represented by when; false otherwise.
  - now
```
@Deprecated
public static Date now()
```
    Deprecated.
    
    Returns the current date and time.
    
    Returns:
    
    current date and time
  - getStartOfTheDay
```
@Deprecated
public static Date getStartOfTheDay(Date date)
```
    Deprecated.
    
    Create a date with the start daytime of the given date.
    
    Parameters:
    
    date - date to process
    
    Returns:
    
    a date with the start daytime of the given date
  - getEndOfTheDay
```
@Deprecated
public static Date getEndOfTheDay(Date date)
```
    Deprecated.
    
    Create a date with the last daytime of the given date.
    
    Parameters:
    
    date - date to process
    
    Returns:
    
    a date with the last daytime of the given date

Class DateHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ISO_DATE_FORMAT

ISO_DATETIME_FORMAT

ISO_TIME_FORMAT

INFINITE_PAST

INFINITE_PAST_DATE

INFINITE_PAST_TIME

INFINITE_FUTURE

INFINITE_FUTURE_DATE

INFINITE_FUTURE_TIME

DAY_START_TIME

DAY_END_TIME

Constructor Detail

DateHelper

Method Detail

getCalendarInstance

getDate

getDate

getTime

getTime

getDate

getTime

isWithinBounds

pastInfinite

futureInfinite

yesterday

yesterday

today

tomorrow

tomorrow

isDateBetween

dateEquals

timeEquals

dateBefore

dateBeforeOrEqual

timeBefore

timeBeforeOrEqual

dateAfter

dateAfterOrEqual

timeAfter

timeAfterOrEqual

isDateSet

isTimeSet

isAnySet

isoDateTimeStringToDate

isoDateStringToDate

getDayOfMonth

getMonth

getYear

addDaysToDate

addMonthToDate

addYearToDate

addTimeSpanToDate

stringToDate

isDateTimeSet

after

equals

before

now

getStartOfTheDay

getEndOfTheDay