DateUtils (Codelogger Utils 1.0.0 API)

java.lang.Object
- org.codelogger.utils.DateUtils

```
public class DateUtils
extends Object
```
A useful tools to handle dates, likes get date from string, date format, get date back, calculate date between, get first/last day of month, get year/month/week/day/hour/minute/second and so on...

Author:

DengDefei

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APRIL`
`static int`	`AUGUST`
`static int`	`DECEMBER`
`static int`	`FEBRUARY`
`static int`	`FRIDAY`
`static int`	`JANUARY`
`static int`	`JULY`
`static int`	`JUNE`
`static int`	`MARCH`
`static int`	`MAY`
`static int`	`MONDAY`
`static int`	`NOVEMBER`
`static int`	`OCTOBER`
`static int`	`SATURDAY`
`static int`	`SEPTEMBER`
`static int`	`SUNDAY`
`static int`	`THURSDAY`
`static int`	`TUESDAY`
`static int`	`WEDNESDAY`

Method Summary

Methods
Modifier and Type	Method and Description
`static Date`	`BuildDate(long times)` Allocates a Date object and initializes it to represent the specified number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
`static Date`	`formatToStartOfDay(Date date)` Returns the beginning of the given day.
`static Date`	`getCurrentDate()` Return current system date.
`static String`	`getDateFormat(Date date, String pattern)` Format date by given pattern.
`static String`	`getDateFormat(String date, String datePattern, String formatPattern)` Format date from given date string and date pattern by format pattern.
`static Date`	`getDateFromString(String dateString)` The date format pattern is "yyyy-MM-dd HH:mm:ss", so you must put data like this: '2012-12-21 00:00:00'
`static Date`	`getDateFromString(String dateString, String pattern)` Get data from data string using the given pattern and the default date format symbols for the default locale.
`static Date`	`getDateOfDaysBack(int daysBack, Date date)` Get specify days back from given date.
`static Date`	`getDateOfHoursBack(int hoursBack, Date date)` Get specify hours back form given date.
`static Date`	`getDateOfMinutesBack(int minutesBack, Date date)` Get specify minutes back form given date.
`static Date`	`getDateOfMonthsBack(int monthsBack, Date date)` Get specify months back from given date.
`static Date`	`getDateOfSecondsBack(int secondsBack, Date date)` Get specify seconds back form given date.
`static Date`	`getDateOfWeeksBack(int weeksBack, Date date)` Get specify weeks back from given date.
`static Date`	`getDateOfYearsBack(int yearsBack, Date date)` Get specify years back from given date.
`static int`	`getDayOfMonth(Date date)` Get the day of the month by given date.
`static int`	`getDayOfWeek(Date date)` Get the day of the week by given date.
`static int`	`getDayOfYear(Date date)` Get the day number within the year by given date.
`static int`	`getHourOfDay(Date date)` Get the hour of the day by given date.
`static int`	`getMinuteOfHour(Date date)` Get the minute within the hour by given date. E.g.: at 10:04:15.250 PM the MINUTE is 4.
`static int`	`getMonthOfYear(Date date)` Get the month of year by given date.
`static int`	`getSecondOfMinute(Date date)` Get the second within the minute by given date. E.g.: at 10:04:15.250 PM the SECOND is 15.
`static int`	`getWeekOfMonth(Date date)` Get the week of the month by given date.
`static int`	`getWeekOfYear(Date date)` Get the week number within the year by given date.
`static int`	`getYear(Date date)` Get the year by given date.
`static boolean`	`isFirstDayOfTheMonth(Date date)` Return true when if the given date is the first day of the month; false otherwise.
`static boolean`	`isLastDayOfTheMonth(Date date)` Return true if the given date is the last day of the month; false otherwise.
`static long`	`subDays(Date date1, Date date2)` Get how many days between two date.
`static long`	`subDays(String dateString1, String dateString2)` Get how many days between two date, the date pattern is 'yyyy-MM-dd'.
`static long`	`subHours(Date date1, Date date2)` Get how many hours between two date.
`static long`	`subMinutes(Date date1, Date date2)` Get how many minutes between two date.
`static long`	`subMonths(Date date1, Date date2)` Get how many months between two date.
`static long`	`subMonths(String dateString1, String dateString2)` Get how many months between two date, the date pattern is 'yyyy-MM-dd'.
`static long`	`subSeconds(Date date1, Date date2)` Get how many seconds between two date.
`static long`	`subYears(Date date1, Date date2)` Get how many years between two date.
`static long`	`subYears(String dateString1, String dateString2)` Get how many years between two date, the date pattern is 'yyyy-MM-dd'.

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

- Field Detail
  - SUNDAY
```
public static final int SUNDAY
```
    See Also:
    Constant Field Values
  - MONDAY
```
public static final int MONDAY
```
    See Also:
    Constant Field Values
  - TUESDAY
```
public static final int TUESDAY
```
    See Also:
    Constant Field Values
  - WEDNESDAY
```
public static final int WEDNESDAY
```
    See Also:
    Constant Field Values
  - THURSDAY
```
public static final int THURSDAY
```
    See Also:
    Constant Field Values
  - FRIDAY
```
public static final int FRIDAY
```
    See Also:
    Constant Field Values
  - SATURDAY
```
public static final int SATURDAY
```
    See Also:
    Constant Field Values
  - JANUARY
```
public static final int JANUARY
```
    See Also:
    Constant Field Values
  - FEBRUARY
```
public static final int FEBRUARY
```
    See Also:
    Constant Field Values
  - MARCH
```
public static final int MARCH
```
    See Also:
    Constant Field Values
  - APRIL
```
public static final int APRIL
```
    See Also:
    Constant Field Values
  - MAY
```
public static final int MAY
```
    See Also:
    Constant Field Values
  - JUNE
```
public static final int JUNE
```
    See Also:
    Constant Field Values
  - JULY
```
public static final int JULY
```
    See Also:
    Constant Field Values
  - AUGUST
```
public static final int AUGUST
```
    See Also:
    Constant Field Values
  - SEPTEMBER
```
public static final int SEPTEMBER
```
    See Also:
    Constant Field Values
  - OCTOBER
```
public static final int OCTOBER
```
    See Also:
    Constant Field Values
  - NOVEMBER
```
public static final int NOVEMBER
```
    See Also:
    Constant Field Values
  - DECEMBER
```
public static final int DECEMBER
```
    See Also:
    Constant Field Values
- Method Detail
  - getDateFromString
```
public static Date getDateFromString(String dateString)
```
    The date format pattern is "yyyy-MM-dd HH:mm:ss", so you must put data like this: '2012-12-21 00:00:00'
    
    Parameters:
    dateString - date string to be handled.
    
    Returns:
    a new Date object by given date string.
    
    Throws:
    
    DateException
  - getDateFromString
```
public static Date getDateFromString(String dateString,
                     String pattern)
```
    Get data from data string using the given pattern and the default date format symbols for the default locale.
    
    Parameters:
    dateString - date string to be handled.
    pattern - pattern to be formated.
    
    Returns:
    a new Date object by given date string and pattern.
    
    Throws:
    
    DateException
  - getDateFormat
```
public static String getDateFormat(Date date,
                   String pattern)
```
    Format date by given pattern.
    
    Parameters:
    date - date to be handled.
    pattern - pattern use to handle given date.
    
    Returns:
    a string object of format date by given pattern.
  - getDateFormat
```
public static String getDateFormat(String date,
                   String datePattern,
                   String formatPattern)
```
    Format date from given date string and date pattern by format pattern.
    
    e.g:
    date: '2012-12-21 13:14:20'
    datePattern: 'yyyy-MM-dd'
    formatPattern: 'yyyy-MM-dd 23:59:59'
    result: "2012-12-21 23:59:59"
    
    Parameters:
    date - date string to be handled.
    datePattern - pattern to handle date string to date object.
    formatPattern - pattern use to format given date.
    
    Returns:
    format date from given date string and date pattern by format pattern.
    
    Throws:
    
    DateException
  - getDateOfSecondsBack
```
public static Date getDateOfSecondsBack(int secondsBack,
                        Date date)
```
    Get specify seconds back form given date.
    
    Parameters:
    secondsBack - how many second want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfMinutesBack
```
public static Date getDateOfMinutesBack(int minutesBack,
                        Date date)
```
    Get specify minutes back form given date.
    
    Parameters:
    minutesBack - how many minutes want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfHoursBack
```
public static Date getDateOfHoursBack(int hoursBack,
                      Date date)
```
    Get specify hours back form given date.
    
    Parameters:
    hoursBack - how many hours want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfDaysBack
```
public static Date getDateOfDaysBack(int daysBack,
                     Date date)
```
    Get specify days back from given date.
    
    Parameters:
    daysBack - how many days want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfWeeksBack
```
public static Date getDateOfWeeksBack(int weeksBack,
                      Date date)
```
    Get specify weeks back from given date.
    
    Parameters:
    weeksBack - how many weeks want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfMonthsBack
```
public static Date getDateOfMonthsBack(int monthsBack,
                       Date date)
```
    Get specify months back from given date.
    
    Parameters:
    monthsBack - how many months want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getDateOfYearsBack
```
public static Date getDateOfYearsBack(int yearsBack,
                      Date date)
```
    Get specify years back from given date.
    
    Parameters:
    yearsBack - how many years want to be back.
    date - date to be handled.
    
    Returns:
    a new Date object.
  - getSecondOfMinute
```
public static int getSecondOfMinute(Date date)
```
    Get the second within the minute by given date.
    E.g.: at 10:04:15.250 PM the SECOND is 15.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    second within the minute by given date.
  - getMinuteOfHour
```
public static int getMinuteOfHour(Date date)
```
    Get the minute within the hour by given date.
    E.g.: at 10:04:15.250 PM the MINUTE is 4.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    minute within the hour by given date.
  - getHourOfDay
```
public static int getHourOfDay(Date date)
```
    Get the hour of the day by given date. HOUR_OF_DAY is used for the 24-hour clock(0-23).
    E.g.: at 10:04:15.250 PM the HOUR_OF_DAY is 22.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the hour of the day by given date.
  - getDayOfWeek
```
public static int getDayOfWeek(Date date)
```
    Get the day of the week by given date. This field takes values SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, and SATURDAY = 7.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the day of the week by given date.
  - getDayOfMonth
```
public static int getDayOfMonth(Date date)
```
    Get the day of the month by given date. The first day of the month has value 1.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the day of the month by given date.
  - getDayOfYear
```
public static int getDayOfYear(Date date)
```
    Get the day number within the year by given date. The first day of the year has value 1.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the day number within the year by given date.
  - getWeekOfMonth
```
public static int getWeekOfMonth(Date date)
```
    Get the week of the month by given date. The first week of the month has value 1.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the week of the month by given date.
  - getWeekOfYear
```
public static int getWeekOfYear(Date date)
```
    Get the week number within the year by given date. The first week of the year, the first week of the year value is 1. Subclasses define the value of WEEK_OF_YEAR for days before the first week of the year.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the week number within the year by given date.
  - getMonthOfYear
```
public static int getMonthOfYear(Date date)
```
    Get the month of year by given date. This is a calendar-specific value. The first month of the year in the calendars is JANUARY which is 1; the last depends on the number of months in a year.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the month of year by given date.
  - getYear
```
public static int getYear(Date date)
```
    Get the year by given date.
    
    Parameters:
    date - date to be handled.
    
    Returns:
    the year by given date.
  - isFirstDayOfTheMonth
```
public static boolean isFirstDayOfTheMonth(Date date)
```
    Return true when if the given date is the first day of the month; false otherwise.
    
    Parameters:
    date - date to be tested.
    
    Returns:
    true when if the given date is the first day of the month; false otherwise.
  - isLastDayOfTheMonth
```
public static boolean isLastDayOfTheMonth(Date date)
```
    Return true if the given date is the last day of the month; false otherwise.
    
    Parameters:
    date - date to be tested.
    
    Returns:
    true if the given date is the last day of the month; false otherwise.
  - getCurrentDate
```
public static Date getCurrentDate()
```
    Return current system date.
    
    Returns:
    a new date object which date is current system date.
  - BuildDate
```
public static Date BuildDate(long times)
```
    Allocates a Date object and initializes it to represent the specified number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
    
    Parameters:
    times - number of milliseconds.
    
    Returns:
    a Date object and initializes it to represent the specified number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
  - subSeconds
```
public static long subSeconds(Date date1,
              Date date2)
```
    Get how many seconds between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many seconds between two date.
  - subMinutes
```
public static long subMinutes(Date date1,
              Date date2)
```
    Get how many minutes between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many minutes between two date.
  - subHours
```
public static long subHours(Date date1,
            Date date2)
```
    Get how many hours between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many hours between two date.
  - subDays
```
public static long subDays(String dateString1,
           String dateString2)
```
    Get how many days between two date, the date pattern is 'yyyy-MM-dd'.
    
    Parameters:
    dateString1 - date string to be tested.
    dateString2 - date string to be tested.
    
    Returns:
    how many days between two date.
    
    Throws:
    
    DateException
  - subDays
```
public static long subDays(Date date1,
           Date date2)
```
    Get how many days between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many days between two date.
  - subMonths
```
public static long subMonths(String dateString1,
             String dateString2)
```
    Get how many months between two date, the date pattern is 'yyyy-MM-dd'.
    
    Parameters:
    dateString1 - date string to be tested.
    dateString2 - date string to be tested.
    
    Returns:
    how many months between two date.
    
    Throws:
    
    DateException
  - subMonths
```
public static long subMonths(Date date1,
             Date date2)
```
    Get how many months between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many months between two date.
  - subYears
```
public static long subYears(String dateString1,
            String dateString2)
```
    Get how many years between two date, the date pattern is 'yyyy-MM-dd'.
    
    Parameters:
    dateString1 - date string to be tested.
    dateString2 - date string to be tested.
    
    Returns:
    how many years between two date.
    
    Throws:
    
    DateException
  - subYears
```
public static long subYears(Date date1,
            Date date2)
```
    Get how many years between two date.
    
    Parameters:
    date1 - date to be tested.
    date2 - date to be tested.
    
    Returns:
    how many years between two date.
  - formatToStartOfDay
```
public static Date formatToStartOfDay(Date date)
```
    Returns the beginning of the given day.
    e.g: '2012-12-21 21:21:21' => '2012-12-21 00:00:00'
    
    Parameters:
    date - date to be handled.
    
    Returns:
    a new date is beginning of the given day.
    
    Throws:
    
    DateException

Class DateUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

JANUARY

FEBRUARY

MARCH

APRIL

MAY

JUNE

JULY

AUGUST

SEPTEMBER

OCTOBER

NOVEMBER

DECEMBER

Method Detail

getDateFromString

getDateFromString

getDateFormat

getDateFormat

getDateOfSecondsBack

getDateOfMinutesBack

getDateOfHoursBack

getDateOfDaysBack

getDateOfWeeksBack

getDateOfMonthsBack

getDateOfYearsBack

getSecondOfMinute

getMinuteOfHour

getHourOfDay

getDayOfWeek

getDayOfMonth

getDayOfYear

getWeekOfMonth

getWeekOfYear

getMonthOfYear

getYear

isFirstDayOfTheMonth

isLastDayOfTheMonth

getCurrentDate

BuildDate

subSeconds

subMinutes

subHours

subDays

subDays

subMonths

subMonths

subYears

subYears

formatToStartOfDay