DateExtensionUtil (feilong-core 2.0.3 API create by feilong)

java.lang.Object
- com.feilong.core.date.DateExtensionUtil

public final class DateExtensionUtil
extends Object

日期扩展工具类.

和 `DateUtil` 的区别:

DateUtil是纯操作Date API的工具类,而 DateExtensionUtil类用于个性化输出结果,针对业务个性化显示.

格式化日期间隔字符串:

formatDuration(long)

formatDuration(Date)

formatDuration(Date, Date)

字段说明

获得两个日期间隔

getIntervalDay(Date, Date)

getIntervalWeek(Date, Date)

getIntervalHour(Date, Date)

getIntervalSecond(Date, Date)

getIntervalTime(Date, Date)

字段	说明
获得两个日期间隔	`getIntervalDay(Date, Date)` `getIntervalWeek(Date, Date)` `getIntervalHour(Date, Date)` `getIntervalSecond(Date, Date)` `getIntervalTime(Date, Date)`

Since:: 1.0.8
Author:: feilong

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`formatDuration(Date beginDate)` 将开始时间 `beginDate` 到当前时间 `now()`,两日期之间的绝对值间隔,格式化成直观的表示方式.
`static String`	`formatDuration(Date beginDate, Date endDate)` 将`beginDate`和 `endDate` 两日期之间的绝对值间隔,格式化成直观的表示方式.
`static String`	`formatDuration(long spaceMilliseconds)` 将间隔毫秒数 `spaceMilliseconds`,格式化成直观的表示方式.
`static Pair<Date,Date>`	`getDayStartAndEndPair(Date date)` 获得指定日的开始时间 `00:00:00.000` 及指定日的结束时间 `23:59:59.999`.
`static int`	`getIntervalDay(Date date1, Date date2)` 计算两个时间相差的的天数(绝对值).
`static int`	`getIntervalHour(Date date1, Date date2)` 两个时间相差的的小时数(绝对值).
`static int`	`getIntervalMinute(Date date1, Date date2)` 两个时间相差的分钟(绝对值).
`static int`	`getIntervalSecond(Date date1, Date date2)` 两个时间相差的秒数(绝对值).
`static long`	`getIntervalTime(Date date1, Date date2)` 两个时间相差的毫秒数 (绝对值).
`static int`	`getIntervalWeek(Date date1, Date date2)` 获得相差的星期数(绝对值).
`static Pair<Date,Date>`	`getMonthStartAndEndPair()` 获得当前月的开始时间 `00:00:00.000` 及当前月结束时间 `23:59:59.999`.
`static Pair<Date,Date>`	`getMonthStartAndEndPair(Date date)` 获得指定月的开始时间 `00:00:00.000` 及指定月的结束时间 `23:59:59.999`.
`static Pair<Date,Date>`	`getTodayStartAndEndPair()` 获得今天的开始时间 `00:00:00.000` 及今天的结束时间 `23:59:59.999`.
`static Pair<Date,Date>`	`getYearStartAndEndPair()` 获得当前年的开始时间 `00:00:00.000` 及当前年的结束时间 `23:59:59.999`.
`static Pair<Date,Date>`	`getYearStartAndEndPair(Date date)` 获得指定年的开始时间 `00:00:00.000` 及指定年的结束时间 `23:59:59.999`.
`static Pair<Date,Date>`	`getYesterdayStartAndEndPair()` 获得昨天的开始时间 `00:00:00.000` 及昨天的结束时间 `23:59:59.999`.

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

- Method Detail
  - getTodayStartAndEndPair
```
public static Pair<Date,Date> getTodayStartAndEndPair()
```
    获得今天的开始时间 00:00:00.000 及今天的结束时间 23:59:59.999.
    一般用于统计当天数据,between ... and ...
    
    示例:
    
    比如今天的是 2012-10-16 22:18:34
    返回: 2012-10-16 00:00:00.000, 2012-10-16 23:59:59.999
    
    Returns:
    左边,今天的开始时间 00:00:00.000
    右边,今天的结束时间 23:59:59.999
    Since:
    
    1.10.6
    
    See Also:
    "java.time.LocalDate#atStartOfDay()", "java.time.LocalDate#atStartOfDay()"
  - getYesterdayStartAndEndPair
```
public static Pair<Date,Date> getYesterdayStartAndEndPair()
```
    获得昨天的开始时间 00:00:00.000 及昨天的结束时间 23:59:59.999.
    一般用于统计昨天数据,between ... and ...
    
    示例:
    
    比如今天的是 2012-10-16 22:18:34
    返回: 2012-10-15 00:00:00.000, 2012-10-15 23:59:59.999
    
    Returns:
    左边,昨天的开始时间 00:00:00.000
    右边,昨天的结束时间 23:59:59.999
    Since:
    
    1.10.6
  - getDayStartAndEndPair
```
public static Pair<Date,Date> getDayStartAndEndPair(Date date)
```
    获得指定日的开始时间 00:00:00.000 及指定日的结束时间 23:59:59.999.
    一般用于统计指定日期数据,between ... and ...
    
    示例:
    
    比如传入的是 2012-10-16 22:18:34
    返回: 2012-10-16 00:00:00.000, 2012-10-16 23:59:59.999
    
    Parameters:
    date - the date
    
    Returns:
    如果 date 是null,抛出 NullPointerException
    左边,指定日的开始时间 00:00:00.000
    右边,指定日的结束时间 23:59:59.999
    Since:
    
    1.10.6
  - getMonthStartAndEndPair
```
public static Pair<Date,Date> getMonthStartAndEndPair()
```
    获得当前月的开始时间 00:00:00.000 及当前月结束时间 23:59:59.999.
    一般用于统计当前月的数据,between ... and ...
    
    示例:
    
    比如传入的是 2012-10-16 22:18:34
    返回: 2012-10-01 00:00:00.000, 2012-10-31 23:59:59.999
    
    Returns:
    左边,当前月的第一天 00:00:00.000
    右边,当前月最后一天 23:59:59.999
    Since:
    
    1.10.6
  - getMonthStartAndEndPair
```
public static Pair<Date,Date> getMonthStartAndEndPair(Date date)
```
    获得指定月的开始时间 00:00:00.000 及指定月的结束时间 23:59:59.999.
    一般用于统计指定月数据,between ... and ...
    
    示例:
    
    比如传入的是 2012-10-16 22:18:34
    返回: 2012-10-01 00:00:00.000, 2012-10-31 23:59:59.999
    
    Parameters:
    date - the date
    
    Returns:
    如果 date 是null,抛出 NullPointerException
    左边,当前月的第一天 00:00:00.000
    右边,当前月最后一天 23:59:59.999
    Since:
    
    1.10.6
  - getYearStartAndEndPair
```
public static Pair<Date,Date> getYearStartAndEndPair()
```
    获得当前年的开始时间 00:00:00.000 及当前年的结束时间 23:59:59.999.
    一般用于统计当前年数据,between ... and ...
    
    示例:
    
    比如传入的是 2012-10-16 22:18:34
    返回: 2012-01-01 00:00:00.000, 2012-12-31 23:59:59.999
    
    Returns:
    左边,当前年的第一天 00:00:00.000
    右边,当前年最后一天 23:59:59.999
    Since:
    
    1.10.6
  - getYearStartAndEndPair
```
public static Pair<Date,Date> getYearStartAndEndPair(Date date)
```
    获得指定年的开始时间 00:00:00.000 及指定年的结束时间 23:59:59.999.
    一般用于统计指定年数据,between ... and ...
    
    示例:
    
    比如传入的是 2012-10-16 22:18:34
    返回: 2012-01-01 00:00:00.000, 2012-12-31 23:59:59.999
    
    Parameters:
    date - the date
    
    Returns:
    如果 date 是null,抛出 NullPointerException
    左边,当前年的第一天 00:00:00.000
    右边,当前年最后一天 23:59:59.999
    Since:
    
    1.10.6
  - formatDuration
```
public static String formatDuration(Date beginDate)
```
    将开始时间 beginDate 到当前时间 now(),两日期之间的绝对值间隔,格式化成直观的表示方式.
    说明:
    常用于日志输出一段代码执行时长
    
    计算的是开始时间 beginDate 到当前时间 now() 绝对值间隔时间,也就是说不care 时间先后顺序
    
    间隔时间转成 天,小时,分钟,秒,毫秒 中文文字,月和较大的格式不使用
    示例:
    Date beginDate = now(); // do some logic // balabala logic LOGGER.info("use time: [{}]", DateExtensionUtil.getIntervalForView(beginDate));
    示例:
    如果当前时间是 2016-07-09 13:03:53.259
    
    Date date = toDate("2016-07-03 00:00:00", COMMON_DATE_AND_TIME); LOGGER.debug(getIntervalForView(date));
    返回:
    6天13小时3分钟53秒259毫秒
    和 DurationFormatUtils formatDurationWords 的区别:
    DurationFormatUtils formatDurationWords 显示的是英文,该方法显示的是中文
    
    DurationFormatUtils formatDurationWords 最小单位是秒,该方法最小单位是毫秒
    Parameters:
    beginDate - 开始日期
    
    Returns:
    如果 beginDate 是null,抛出 NullPointerException
    Since:
    
    1.8.4 change name from getIntervalForView
    
    See Also:
    formatDuration(Date, Date), DurationFormatUtils.formatDurationWords(long, boolean, boolean), how-to-format-a-duration- in-java-e-g-format-hmmss
  - formatDuration
```
public static String formatDuration(Date beginDate,
                    Date endDate)
```
    将beginDate和 endDate 两日期之间的绝对值间隔,格式化成直观的表示方式.
    说明:
    常用于日志输出一段代码执行时长
    
    计算的是开始时间 beginDate 到结束时间 endDate 绝对值间隔时间,也就是说不care 时间先后顺序
    
    间隔时间转成 天,小时,分钟,秒,毫秒 中文文字,月和较大的格式不使用
    示例:
    Date beginDate = now(); // do some logic // balabala logic LOGGER.info("use time: [{}]", DateExtensionUtil.getIntervalForView(beginDate, now()));
    示例:
    DateExtensionUtil.getIntervalForView(2011-05-19 8:30:40,2011-05-19 11:30:24) = 2小时59分44秒 DateExtensionUtil.getIntervalForView(2011-05-19 11:31:25.456,2011-05-19 11:30:24.895) = 1分钟1秒
    和 DurationFormatUtils formatDurationWords 的区别:
    DurationFormatUtils formatDurationWords 显示的是英文,该方法显示的是中文
    
    DurationFormatUtils formatDurationWords 最小单位是秒,该方法最小单位是毫秒
    Parameters:
    beginDate - 开始日期
    endDate - 结束日期
    
    Returns:
    如果 beginDate 是null,抛出 NullPointerException
    如果 endDate 是null,抛出 NullPointerException
    Since:
    
    1.8.4 change name from getIntervalForView
    
    See Also:
    formatDuration(long), getIntervalTime(Date, Date), DurationFormatUtils.formatDurationWords(long, boolean, boolean), how-to-format-a-duration- in-java-e-g-format-hmmss
  - formatDuration
```
public static String formatDuration(long spaceMilliseconds)
```
    将间隔毫秒数 spaceMilliseconds,格式化成直观的表示方式.
    说明:
    常用于日志输出一段代码执行时长
    
    间隔时间转成 天,小时,分钟,秒,毫秒 中文文字,月和较大的格式不使用
    示例:
    DateExtensionUtil.getIntervalForView(13516) = 13秒516毫秒 DateExtensionUtil.getIntervalForView(0) = 0
    和 DurationFormatUtils formatDurationWords 的区别:
    DurationFormatUtils formatDurationWords 显示的是英文,该方法显示的是中文
    
    DurationFormatUtils formatDurationWords 最小单位是秒,该方法最小单位是毫秒
    Parameters:
    spaceMilliseconds - 总共相差的毫秒数
    
    Returns:
    如果 spaceMilliseconds 是0 直接返回0
    如果 spaceMilliseconds < 0,抛出 IllegalArgumentException
    Since:
    
    1.8.4 change name from getIntervalForView
    
    See Also:
    getIntervalDay(long), getIntervalHour(long), getIntervalMinute(long), getIntervalSecond(long), DurationFormatUtils.formatDurationWords(long, boolean, boolean), how-to-format-a-duration- in-java-e-g-format-hmmss
  - getIntervalWeek
```
public static int getIntervalWeek(Date date1,
                  Date date2)
```
    获得相差的星期数(绝对值).
    说明:
    值=两个时间相差毫秒的绝对值/TimeInterval.MILLISECOND_PER_WEEK
    
    当两者时间差不足1星期,返回0
    示例:
    DateExtensionUtil.getIntervalWeek( toDate("2014-01-01 00:00:00",COMMON_DATE_AND_TIME), toDate("2014-02-01 00:00:00",COMMON_DATE_AND_TIME)) = 4 DateExtensionUtil.getIntervalWeek( toDate("2016-08-01",COMMON_DATE), toDate("2016-08-07",COMMON_DATE)) = 0 DateExtensionUtil.getIntervalWeek( toDate("2016-08-01",COMMON_DATE), toDate("2016-08-08",COMMON_DATE)) = 1 DateExtensionUtil.getIntervalWeek( toDate("2016-08-21",COMMON_DATE), toDate("2016-08-21",COMMON_DATE)) = 0
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.6.0
    
    See Also:
    getIntervalWeek(long)
  - getIntervalDay
```
public static int getIntervalDay(Date date1,
                 Date date2)
```
    计算两个时间相差的的天数(绝对值).
    说明:
    值=两个时间相差毫秒的绝对值/TimeInterval.MILLISECOND_PER_DAY
    
    当两者时间差不足1天,返回0
    示例:
    DateExtensionUtil.getIntervalDay( toDate("2008-08-24",COMMON_DATE), toDate("2008-08-27",COMMON_DATE)) = 3 DateExtensionUtil.getIntervalDay( toDate("2016-08-21 12:00:00",COMMON_DATE_AND_TIME), toDate("2016-08-22 11:00:00",COMMON_DATE_AND_TIME)) = 0 DateExtensionUtil.getIntervalDay( toDate("2016-08-21",COMMON_DATE), toDate("2016-08-22",COMMON_DATE)) = 1 DateExtensionUtil.getIntervalDay( toDate("2016-02-28",COMMON_DATE), toDate("2016-03-02",COMMON_DATE)) = 3 DateExtensionUtil.getIntervalDay( toDate("2016-08-31",COMMON_DATE), toDate("2016-09-02",COMMON_DATE)) = 2
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.6.0
    
    See Also:
    getIntervalTime(Date, Date), getIntervalDay(long)
  - getIntervalHour
```
public static int getIntervalHour(Date date1,
                  Date date2)
```
    两个时间相差的的小时数(绝对值).
    说明:
    值=两个时间相差毫秒的绝对值/TimeInterval.MILLISECOND_PER_HOUR
    
    当两者时间差不足1小时,返回0
    示例:
    DateExtensionUtil.getIntervalHour( toDate("2014-01-01 00:00:00",COMMON_DATE_AND_TIME), toDate("2014-01-01 01:00:00",COMMON_DATE_AND_TIME)) = 1 DateExtensionUtil.getIntervalHour( toDate("2014-01-01 00:00:00",COMMON_DATE_AND_TIME), toDate("2014-01-01 00:59:00",COMMON_DATE_AND_TIME)) = 0 DateExtensionUtil.getIntervalHour( toDate("2014-01-01 00:59:00",COMMON_DATE_AND_TIME), toDate("2014-01-01 00:00:00",COMMON_DATE_AND_TIME)) = 0 DateExtensionUtil.getIntervalHour( toDate("2016-08-21 23:00:00",COMMON_DATE_AND_TIME), toDate("2016-08-22 01:00:00",COMMON_DATE_AND_TIME)) = 2
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.6.0
    
    See Also:
    getIntervalTime(Date, Date), getIntervalHour(long)
  - getIntervalMinute
```
public static int getIntervalMinute(Date date1,
                    Date date2)
```
    两个时间相差的分钟(绝对值).
    说明:
    值=两个时间相差毫秒的绝对值/TimeInterval.MILLISECOND_PER_MINUTE
    
    当两者时间差不足1分钟,返回0
    示例:
    DateExtensionUtil.getIntervalMinute( toDate("2008-08-24 00:00:00",COMMON_DATE_AND_TIME), toDate("2008-08-24 01:00:00",COMMON_DATE_AND_TIME)) = 60 DateExtensionUtil.getIntervalMinute( toDate("2008-08-24 00:00:00",COMMON_DATE_AND_TIME), toDate("2008-08-24 00:00:00",COMMON_DATE_AND_TIME)) = 0 DateExtensionUtil.getIntervalMinute( toDate("2008-08-24 00:00:00",COMMON_DATE_AND_TIME), toDate("2008-08-24 00:00:50",COMMON_DATE_AND_TIME)) = 0 DateExtensionUtil.getIntervalMinute( toDate("2008-08-24 00:00:00",COMMON_DATE_AND_TIME), toDate("2008-08-23 00:00:00",COMMON_DATE_AND_TIME)) = SECONDS_PER_DAY / 60
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.8.6
    
    See Also:
    getIntervalTime(Date, Date), getIntervalMinute(long)
  - getIntervalSecond
```
public static int getIntervalSecond(Date date1,
                    Date date2)
```
    两个时间相差的秒数(绝对值).
    说明:
    值=两个时间相差毫秒的绝对值/TimeInterval.MILLISECOND_PER_SECONDS
    
    不足1秒返回0
    示例:
    DateExtensionUtil.getIntervalSecond( toDate("2016-08-22 00:00:00",COMMON_DATE_AND_TIME), toDate("2016-08-22 00:00:08",COMMON_DATE_AND_TIME)) = 8 DateExtensionUtil.getIntervalSecond( toDate("2016-08-21 23:59:20",COMMON_DATE_AND_TIME), toDate("2016-08-22 00:00:20",COMMON_DATE_AND_TIME)) = 60
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.6.0
    
    See Also:
    getIntervalTime(Date, Date), getIntervalSecond(long)
  - getIntervalTime
```
public static long getIntervalTime(Date date1,
                   Date date2)
```
    两个时间相差的毫秒数 (绝对值).
    示例:
    DateExtensionUtil.getIntervalTime( toDate("2016-07-16 15:21:00",COMMON_DATE_AND_TIME), toDate("2016-07-16 15:21:01",COMMON_DATE_AND_TIME)) = 1000 DateExtensionUtil.getIntervalTime( toDate("2016-07-16 15:21:00",COMMON_DATE_AND_TIME), toDate("2016-07-16 15:22:00",COMMON_DATE_AND_TIME)) = 60000
    Parameters:
    date1 - 第一个时间
    date2 - 第二个时间
    
    Returns:
    如果 date1 是null,抛出 NullPointerException
    如果 date2 是null,抛出 NullPointerException
    Since:
    
    1.6.0
    
    See Also:
    DateUtil.getTime(Date), Math.abs(long)

Class DateExtensionUtil

和 DateUtil 的区别:

格式化日期间隔字符串:

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTodayStartAndEndPair

示例:

getYesterdayStartAndEndPair

示例:

getDayStartAndEndPair

示例:

getMonthStartAndEndPair

示例:

getMonthStartAndEndPair

示例:

getYearStartAndEndPair

示例:

getYearStartAndEndPair

示例:

formatDuration

说明:

示例:

示例:

和 DurationFormatUtils formatDurationWords 的区别:

formatDuration

说明:

示例:

示例:

和 DurationFormatUtils formatDurationWords 的区别:

formatDuration

说明:

示例:

和 DurationFormatUtils formatDurationWords 的区别:

getIntervalWeek

说明:

示例:

getIntervalDay

说明:

示例:

getIntervalHour

说明:

示例:

getIntervalMinute

说明:

示例:

getIntervalSecond

说明:

示例:

getIntervalTime

示例:

和 `DateUtil` 的区别:

和 `DurationFormatUtils formatDurationWords` 的区别:

和 `DurationFormatUtils formatDurationWords` 的区别:

和 `DurationFormatUtils formatDurationWords` 的区别: