Dates (enterprisemath-utils 2.4.0 API)

java.lang.Object
- com.enterprisemath.utils.Dates

```
public class Dates
extends Object
```
Class with utility methods for work with dates and times.

Author:

radek.hecl

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Date`	`createDate(int year, Month month, int day)` Creates date according the Gregorian calendar input.
`static Date`	`createTime(int year, Month month, int day, int hour, int minute, int second)` Creates time according the Gregorian calendar input.
`static Date`	`createTime(int year, Month month, int day, int hour, int minute, int second, int millisecond)` Creates time according the Gregorian calendar input.
`static String`	`format(Date date, String pattern)` Formats date into string.
`static Date`	`fromToday(int numDays)` Returns the date which is shifted for a particular number of days from today.
`static int`	`getDayOfMonth(Date date)` Returns day of month.
`static DayOfWeek`	`getDayOfWeek(Date date)` Returns day of week.
`static int`	`getDayOfYear(Date date)` Takes the time in a given date and returns how many days past from the beginning of the year.
`static int`	`getDifferenceInDays(Date first, Date second)` Returns the difference in days between two dates.
`static int`	`getHourOfDay(Date date)` Takes the time in a given date and returns how many hours past from the specified day from 0 : 0 : 0.
`static int`	`getMinuteOfDay(Date date)` Takes the time in a given date and returns how many minutes past from the specified day from 0 : 0 : 0.
`static Month`	`getMonth(Date date)` Returns month.
`static int`	`getYear(Date date)` Returns year.
`static Date`	`now()` Returns the current timestamp.
`static Date`	`parse(String date, String... patterns)` Parses date.
`static boolean`	`safeEqualsToSeconds(Date date1, Date date2)` Null safe equals method which ignores anything less than seconds.
`static Date`	`today()` Returns todays date.
`static Date`	`tomorrow()` Returns the tomorrows date.
`static Date`	`yesterday()` Returns the yesterdays date.

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

- Method Detail
  - now
```
public static Date now()
```
    Returns the current timestamp.
    
    Returns:
    
    current timestamp
  - today
```
public static Date today()
```
    Returns todays date. This is current timestamp which is truncated to days.
    
    Returns:
    
    todays date
  - yesterday
```
public static Date yesterday()
```
    Returns the yesterdays date. This is truncated to date.
    
    Returns:
    
    yesterdays date
  - tomorrow
```
public static Date tomorrow()
```
    Returns the tomorrows date. This is truncated to date.
    
    Returns:
    
    tomorrows date
  - fromToday
```
public static Date fromToday(int numDays)
```
    Returns the date which is shifted for a particular number of days from today. This is truncated to date.
    
    Parameters:
    
    numDays - the number of days to shift
    
    Returns:
    
    date shifted from today
  - createDate
```
public static Date createDate(int year,
                              Month month,
                              int day)
```
    Creates date according the Gregorian calendar input.
    
    Parameters:
    
    year - year
    
    month - month
    
    day - day of the month (1-31, range depends on the month and year)
    
    Returns:
    
    created date
  - createTime
```
public static Date createTime(int year,
                              Month month,
                              int day,
                              int hour,
                              int minute,
                              int second)
```
    Creates time according the Gregorian calendar input.
    
    Parameters:
    
    year - year
    
    month - month
    
    day - day of the month (1-31, range depends on the month and year)
    
    hour - hour (0 - 23)
    
    minute - minute (0 - 59)
    
    second - second (0 - 59)
    
    Returns:
    
    created time
  - createTime
```
public static Date createTime(int year,
                              Month month,
                              int day,
                              int hour,
                              int minute,
                              int second,
                              int millisecond)
```
    Creates time according the Gregorian calendar input.
    
    Parameters:
    
    year - year
    
    month - month
    
    day - day of the month (1-31, range depends on the month and year)
    
    hour - hour (0 - 23)
    
    minute - minute (0 - 59)
    
    second - second (0 - 59)
    
    millisecond - millisecond (0-999)
    
    Returns:
    
    created time
  - getMinuteOfDay
```
public static int getMinuteOfDay(Date date)
```
    Takes the time in a given date and returns how many minutes past from the specified day from 0 : 0 : 0. Examples:
    - 1st January 2012 00 : 00 : 00 => 0
    - 1st January 2012 00 : 00 : 14 => 0
    - 1st January 2012 00 : 59 : 14 => 59
    - 1st January 2012 01 : 00 : 35 => 60
    - 1st January 2012 01 : 12 : 35 => 72
    - 1st January 2012 23 : 59 : 59 => 1439 (23 * 60 + 59)
    Parameters:
    
    date - input date
    
    Returns:
    
    how many minutes past from the noon of the day in the specified timestamp
  - getHourOfDay
```
public static int getHourOfDay(Date date)
```
    Takes the time in a given date and returns how many hours past from the specified day from 0 : 0 : 0. Examples:
    - 1st January 2012 00 : 00 : 00 => 0
    - 1st January 2012 00 : 00 : 14 => 0
    - 1st January 2012 00 : 59 : 14 => 0
    - 1st January 2012 01 : 00 : 35 => 1
    - 1st January 2012 01 : 12 : 35 => 1
    - 1st January 2012 23 : 59 : 59 => 23
    Parameters:
    
    date - input date
    
    Returns:
    
    how many hours past from the noon of the day in the specified timestamp
  - getDayOfYear
```
public static int getDayOfYear(Date date)
```
    Takes the time in a given date and returns how many days past from the beginning of the year. This is value in range <1, 365> for the year which does not have 29 February and value in rage <1, 366> for the year which has 29 February. Examples:
    - 1st January 2011 => 1
    - 31th January 2011 => 31
    - 1st August 2011 => 213
    - 31st December 2011 => 365
    - 1st January 2012 => 1
    - 31th January 2012 => 31
    - 1st August 2012 => 214
    - 31st December 2012 => 366
    Parameters:
    
    date - input date
    
    Returns:
    
    how many days past from the beginning of the year
  - getYear
```
public static int getYear(Date date)
```
    Returns year.
    
    Parameters:
    
    date - input date
    
    Returns:
    
    year
  - getMonth
```
public static Month getMonth(Date date)
```
    Returns month.
    
    Parameters:
    
    date - input date
    
    Returns:
    
    month
  - getDayOfMonth
```
public static int getDayOfMonth(Date date)
```
    Returns day of month. Starting from 1.
    
    Parameters:
    
    date - input date
    
    Returns:
    
    day of month, starting from 1
  - getDayOfWeek
```
public static DayOfWeek getDayOfWeek(Date date)
```
    Returns day of week.
    
    Parameters:
    
    date - input date
    
    Returns:
    
    day of week
  - getDifferenceInDays
```
public static int getDifferenceInDays(Date first,
                                      Date second)
```
    Returns the difference in days between two dates. Only the date and more significant fields are included in the calculation. The formula is: numberOfDays(truncToDays(second) - truncToDays(first)). Examples:
    - (1st January 2012 00 : 00 : 00, 1st January 2012 00 : 00 : 00) => 0
    - (1st January 2012 00 : 00 : 00, 1st January 2012 23 : 59 : 59) => 0
    - (1st January 2012 23 : 59 : 59, 1st January 2012 00 : 00 : 00) => 0
    - (1st January 2012 00 : 00 : 00, 2nd January 2012 00 : 00 : 00) => 1
    - (1st January 2012 23 : 59 : 59, 2nd January 2012 00 : 00 : 00) => 1
    - (1st January 2012 23 : 59 : 59, 2nd January 2012 23 : 59 : 59) => 1
    - (2nd January 2012 00 : 00 : 00, 1st January 2012 23 : 59 : 59) => -1
    - (1st January 2012 00 : 00 : 00, 1st February 2012 00 : 00 : 00) => 31
    Parameters:
    
    first - first date
    
    second - second date
    
    Returns:
    
    the days difference
  - format
```
public static String format(Date date,
                            String pattern)
```
    Formats date into string.
    
    Parameters:
    
    date - date which will be formatted
    
    pattern - pattern which will be used
    
    Returns:
    
    string with formatted date
  - parse
```
public static Date parse(String date,
                         String... patterns)
```
    Parses date.
    
    Parameters:
    
    date - date string which will be parsed
    
    patterns - patterns which will be used, result is returned from the first pattern which can parse the string
    
    Returns:
    
    created date
  - safeEqualsToSeconds
```
public static boolean safeEqualsToSeconds(Date date1,
                                          Date date2)
```
    Null safe equals method which ignores anything less than seconds. Returns true if both objects are null or represents the same date up to the seconds. Ignores anything less than second. Examples:
    - (null, null) => true
    - (2012/01/02 00:00:01.000, null) => false
    - (null, 2012/01/02 00:00:01.999) => false
    - (2012/01/02 00:00:01.000, 2012/01/02 00:00:01.999) => true
    - (2012/01/02 00:00:01.000, 2012/01/02 00:00:00.999) => false
    - (2012/01/02 00:00:01.000, 2012/01/02 00:00:02.000) => false
    Parameters:
    
    date1 - first date
    
    date2 - second date
    
    Returns:
    
    true if both dates are null or if they equals up to second, false otherwise

Class Dates

Method Summary

Methods inherited from class java.lang.Object

Method Detail

now

today

yesterday

tomorrow

fromToday

createDate

createTime

createTime

getMinuteOfDay

getHourOfDay

getDayOfYear

getYear

getMonth

getDayOfMonth

getDayOfWeek

getDifferenceInDays

format

parse

safeEqualsToSeconds