DateTime (bus-core 3.0.0 API)

java.lang.Object
- java.util.Date
- - org.aoju.bus.core.date.DateTime

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Date>
```
public class DateTime
extends Date
```
包装java.utils.Date

Since:

JDK 1.8

Version:

3.0.0

Author:

Kimi Liu

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DateTime()` 当前时间
`DateTime(Calendar calendar)` 给定日期的构造
`DateTime(Date date)` 给定日期的构造
`DateTime(Date date, TimeZone timeZone)` 给定日期的构造
`DateTime(long timeMillis)` 给定日期毫秒数的构造
`DateTime(long timeMillis, TimeZone timeZone)` 给定日期毫秒数的构造
`DateTime(String dateStr, DateFormat dateFormat)` 构造
`DateTime(String dateStr, DateParser dateParser)` 构造
`DateTime(String dateStr, String format)` 构造
`DateTime(TimeZone timeZone)` 当前时间

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Between`	`between(Date date)` 计算相差时长
`long`	`between(Date date, Fields.Unit unit)` 计算相差时长
`String`	`between(Date date, Fields.Unit unit, BetweenFormat.Level formatLevel)` 计算相差时长
`int`	`dayOfMonth()` 获得指定日期是这个日期所在月份的第几天
`int`	`dayOfWeek()` 获得指定日期是星期几，1表示周日，2表示周一
`Fields.Week`	`dayOfWeekEnum()` 获得指定日期是星期几
`int`	`dayOfWeekInMonth()` 获得天所在的周是这个月的第几周
`int`	`getField(Fields.DateField field)` 获得日期的某个部分例如获得年的部分，则使用 getField(DatePart.YEAR)
`int`	`getField(int field)` 获得日期的某个部分例如获得年的部分，则使用 getField(Calendar.YEAR)
`Fields.Week`	`getFirstDayOfWeek()` 获得一周的第一天，默认为周一
`int`	`hour(boolean is24HourClock)` 获得指定日期的小时数部分
`boolean`	`isAfter(Date date)` 是否在给定日期之后或与给定日期相等
`boolean`	`isAfterOrEquals(Date date)` 是否在给定日期之后或与给定日期相等
`boolean`	`isAM()` 是否为上午
`boolean`	`isBefore(Date date)` 是否在给定日期之前
`boolean`	`isBeforeOrEquals(Date date)` 是否在给定日期之前或与给定日期相等
`boolean`	`isIn(Date beginDate, Date endDate)` 当前日期是否在日期指定范围内起始日期和结束日期可以互换
`boolean`	`isLeapYear()` 是否闰年
`boolean`	`isMutable()` 对象是否可变如果为不可变对象，以下方法将返回新方法：如果为不可变对象，`setTime(long)`将抛出异常
`boolean`	`isPM()` 是否为下午
`int`	`millsecond()` 获得指定日期的毫秒数部分
`int`	`minute()` 获得指定日期的分钟数部分例如：10:04:15.250 =》 4
`int`	`month()` 获得月份，从0开始计数
`Fields.Month`	`monthEnum()` 获得月份
`int`	`monthStartFromOne()` 获得月份，从1开始计数由于`Calendar` 中的月份按照0开始计数，导致某些需求容易误解，因此如果想用1表示一月，2表示二月则调用此方法
`static DateTime`	`now()` 现在的时间
`static DateTime`	`of(Calendar calendar)` 转换 `Calendar` 为 DateTime
`static DateTime`	`of(Date date)` 转换JDK date为 DateTime
`static DateTime`	`of(String dateStr, String format)` 构造
`int`	`quarter()` 获得当前日期所属季度，从1开始计数
`Fields.Quarter`	`quarterEnum()` 获得当前日期所属季度
`int`	`second()` 获得指定日期的秒数部分
`DateTime`	`setFirstDayOfWeek(Fields.Week firstDayOfWeek)` 设置一周的第一天 JDK的Calendar中默认一周的第一天是周日，将此默认值设置为周一设置一周的第一天主要影响`weekOfMonth()`和`weekOfYear()` 两个方法
`DateTime`	`setMutable(boolean mutable)` 设置对象是否可变如果为不可变对象，以下方法将返回新方法：如果为不可变对象，`setTime(long)`将抛出异常
`void`	`setTime(long time)`
`DateTime`	`setTimeZone(TimeZone timeZone)` 设置时区
`Calendar`	`toCalendar()` 转换为Calendar, 默认 `Locale`
`Calendar`	`toCalendar(Locale locale)` 转换为Calendar
`Calendar`	`toCalendar(TimeZone zone)` 转换为Calendar
`Calendar`	`toCalendar(TimeZone zone, Locale locale)` 转换为Calendar
`String`	`toDateStr()` 转为"yyyy-MM-dd " 格式字符串
`Date`	`toJdkDate()` 转换为 `Date` 考虑到很多框架（例如Hibernate）的兼容性，提供此方法返回JDK原生的Date对象
`String`	`toMsStr()`
`Date`	`toSqlDate()` 转为 `Date`
`String`	`toString()` 转为"yyyy-MM-dd yyyy-MM-dd HH:mm:ss " 格式字符串
`String`	`toString(DateFormat format)` 转为字符串
`String`	`toString(DatePrinter format)` 转为字符串
`String`	`toString(String format)` 转为字符串
`Timestamp`	`toTimestamp()` 转为`Timestamp`
`String`	`toTimeStr()` 转为"HH:mm:ss" 格式字符串
`int`	`weekOfMonth()` 获得指定日期是所在月份的第几周此方法返回值与一周的第一天有关，比如： 2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）如果一周的第一天为周一，那这天是第一周（返回1）
`int`	`weekOfYear()` 获得指定日期是所在年份的第几周此方法返回值与一周的第一天有关，比如： 2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）如果一周的第一天为周一，那这天是第一周（返回1）
`int`	`year()` 获得年的部分

Methods inherited from class java.util.Date
after, before, clone, compareTo, equals, from, getDate, getDay, getHours, getMinutes, getMonth, getSeconds, getTime, getTimezoneOffset, getYear, hashCode, parse, setDate, setHours, setMinutes, setMonth, setSeconds, setYear, toGMTString, toInstant, toLocaleString, UTC

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DateTime
```
public DateTime()
```
    当前时间
  - DateTime
```
public DateTime(TimeZone timeZone)
```
    当前时间
    
    Parameters:
    
    timeZone - 时区
    
    Since:
    
    4.1.2
  - DateTime
```
public DateTime(Date date)
```
    给定日期的构造
    
    Parameters:
    
    date - 日期
  - DateTime
```
public DateTime(Date date,
                TimeZone timeZone)
```
    给定日期的构造
    
    Parameters:
    
    date - 日期
    
    timeZone - 时区
    
    Since:
    
    4.1.2
  - DateTime
```
public DateTime(Calendar calendar)
```
    给定日期的构造
    
    Parameters:
    
    calendar - Calendar
  - DateTime
```
public DateTime(long timeMillis)
```
    给定日期毫秒数的构造
    
    Parameters:
    
    timeMillis - 日期毫秒数
    
    Since:
    
    4.1.2
  - DateTime
```
public DateTime(long timeMillis,
                TimeZone timeZone)
```
    给定日期毫秒数的构造
    
    Parameters:
    
    timeMillis - 日期毫秒数
    
    timeZone - 时区
    
    Since:
    
    4.1.2
  - DateTime
```
public DateTime(String dateStr,
                String format)
```
    构造
    
    Parameters:
    
    dateStr - Date字符串
    
    format - 格式
    
    See Also:
    
    Fields
  - DateTime
```
public DateTime(String dateStr,
                DateFormat dateFormat)
```
    构造
    
    Parameters:
    
    dateStr - Date字符串
    
    dateFormat - 格式化器 SimpleDateFormat
    
    See Also:
    
    Fields
  - DateTime
```
public DateTime(String dateStr,
                DateParser dateParser)
```
    构造
    
    Parameters:
    
    dateStr - Date字符串
    
    dateParser - 格式化器 DateParser，可以使用 FastDateFormat
    
    See Also:
    
    Fields
- Method Detail
  - of
```
public static DateTime of(Date date)
```
    转换JDK date为 DateTime
    
    Parameters:
    
    date - JDK Date
    
    Returns:
    
    DateTime
  - of
```
public static DateTime of(Calendar calendar)
```
    转换 Calendar 为 DateTime
    
    Parameters:
    
    calendar - Calendar
    
    Returns:
    
    DateTime
  - of
```
public static DateTime of(String dateStr,
                          String format)
```
    构造
    
    Parameters:
    
    dateStr - Date字符串
    
    format - 格式
    
    Returns:
    
    DateTime
    
    See Also:
    
    Fields
  - now
```
public static DateTime now()
```
    现在的时间
    
    Returns:
    
    现在的时间
  - getField
```
public int getField(Fields.DateField field)
```
    获得日期的某个部分
    例如获得年的部分，则使用 getField(DatePart.YEAR)
    
    Parameters:
    
    field - 表示日期的哪个部分的枚举 Fields.DateField
    
    Returns:
    
    某个部分的值
  - getField
```
public int getField(int field)
```
    获得日期的某个部分
    例如获得年的部分，则使用 getField(Calendar.YEAR)
    
    Parameters:
    
    field - 表示日期的哪个部分的int值 Calendar
    
    Returns:
    
    某个部分的值
  - setTime
```
public void setTime(long time)
```
    Overrides:
    
    setTime in class Date
  - year
```
public int year()
```
    获得年的部分
    
    Returns:
    
    年的部分
  - quarter
```
public int quarter()
```
    获得当前日期所属季度，从1开始计数
    
    Returns:
    
    第几个季度 Fields.Quarter
  - quarterEnum
```
public Fields.Quarter quarterEnum()
```
    获得当前日期所属季度
    
    Returns:
    
    第几个季度 Fields.Quarter
  - month
```
public int month()
```
    获得月份，从0开始计数
    
    Returns:
    
    月份
  - monthStartFromOne
```
public int monthStartFromOne()
```
    获得月份，从1开始计数
    由于Calendar 中的月份按照0开始计数，导致某些需求容易误解，因此如果想用1表示一月，2表示二月则调用此方法
    
    Returns:
    
    月份
  - monthEnum
```
public Fields.Month monthEnum()
```
    获得月份
    
    Returns:
    
    Fields.Month
  - weekOfYear
```
public int weekOfYear()
```
    获得指定日期是所在年份的第几周
    此方法返回值与一周的第一天有关，比如：
    2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）
    如果一周的第一天为周一，那这天是第一周（返回1）
    
    Returns:
    
    周
    
    See Also:
    
    setFirstDayOfWeek(Fields.Week)
  - weekOfMonth
```
public int weekOfMonth()
```
    获得指定日期是所在月份的第几周
    此方法返回值与一周的第一天有关，比如：
    2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）
    如果一周的第一天为周一，那这天是第一周（返回1）
    
    Returns:
    
    周
    
    See Also:
    
    setFirstDayOfWeek(Fields.Week)
  - dayOfMonth
```
public int dayOfMonth()
```
    获得指定日期是这个日期所在月份的第几天
    
    Returns:
    
    天
  - dayOfWeek
```
public int dayOfWeek()
```
    获得指定日期是星期几，1表示周日，2表示周一
    
    Returns:
    
    星期几
  - dayOfWeekInMonth
```
public int dayOfWeekInMonth()
```
    获得天所在的周是这个月的第几周
    
    Returns:
    
    天
  - dayOfWeekEnum
```
public Fields.Week dayOfWeekEnum()
```
    获得指定日期是星期几
    
    Returns:
    
    Fields.Week
  - hour
```
public int hour(boolean is24HourClock)
```
    获得指定日期的小时数部分
    
    Parameters:
    
    is24HourClock - 是否24小时制
    
    Returns:
    
    小时数
  - minute
```
public int minute()
```
    获得指定日期的分钟数部分
    例如：10:04:15.250 =》 4
    
    Returns:
    
    分钟数
  - second
```
public int second()
```
    获得指定日期的秒数部分
    
    Returns:
    
    秒数
  - millsecond
```
public int millsecond()
```
    获得指定日期的毫秒数部分
    
    Returns:
    
    毫秒数
  - isAM
```
public boolean isAM()
```
    是否为上午
    
    Returns:
    
    是否为上午
  - isPM
```
public boolean isPM()
```
    是否为下午
    
    Returns:
    
    是否为下午
  - isLeapYear
```
public boolean isLeapYear()
```
    是否闰年
    
    Returns:
    
    是否闰年
    
    See Also:
    
    DateUtils.isLeapYear(int)
  - toCalendar
```
public Calendar toCalendar()
```
    转换为Calendar, 默认 Locale
    
    Returns:
    
    Calendar
  - toCalendar
```
public Calendar toCalendar(Locale locale)
```
    转换为Calendar
    
    Parameters:
    
    locale - 地域 Locale
    
    Returns:
    
    Calendar
  - toCalendar
```
public Calendar toCalendar(TimeZone zone)
```
    转换为Calendar
    
    Parameters:
    
    zone - 时区 TimeZone
    
    Returns:
    
    Calendar
  - toCalendar
```
public Calendar toCalendar(TimeZone zone,
                           Locale locale)
```
    转换为Calendar
    
    Parameters:
    
    zone - 时区 TimeZone
    
    locale - 地域 Locale
    
    Returns:
    
    Calendar
  - toJdkDate
```
public Date toJdkDate()
```
    转换为 Date
    考虑到很多框架（例如Hibernate）的兼容性，提供此方法返回JDK原生的Date对象
    
    Returns:
    
    Date
    
    Since:
    
    3.2.2
  - toTimestamp
```
public Timestamp toTimestamp()
```
    转为Timestamp
    
    Returns:
    
    Timestamp
  - toSqlDate
```
public Date toSqlDate()
```
    转为 Date
    
    Returns:
    
    Date
  - between
```
public Between between(Date date)
```
    计算相差时长
    
    Parameters:
    
    date - 对比的日期
    
    Returns:
    
    Between
  - between
```
public long between(Date date,
                    Fields.Unit unit)
```
    计算相差时长
    
    Parameters:
    
    date - 对比的日期
    
    unit - 单位 Fields.Unit
    
    Returns:
    
    相差时长
  - between
```
public String between(Date date,
                      Fields.Unit unit,
                      BetweenFormat.Level formatLevel)
```
    计算相差时长
    
    Parameters:
    
    date - 对比的日期
    
    unit - 单位 Fields.Unit
    
    formatLevel - 格式化级别
    
    Returns:
    
    相差时长
  - isIn
```
public boolean isIn(Date beginDate,
                    Date endDate)
```
    当前日期是否在日期指定范围内
    起始日期和结束日期可以互换
    
    Parameters:
    
    beginDate - 起始日期
    
    endDate - 结束日期
    
    Returns:
    
    是否在范围内
    
    Since:
    
    3.0.8
  - isBefore
```
public boolean isBefore(Date date)
```
    是否在给定日期之前
    
    Parameters:
    
    date - 日期
    
    Returns:
    
    是否在给定日期之前或与给定日期相等
    
    Since:
    
    4.1.3
  - isBeforeOrEquals
```
public boolean isBeforeOrEquals(Date date)
```
    是否在给定日期之前或与给定日期相等
    
    Parameters:
    
    date - 日期
    
    Returns:
    
    是否在给定日期之前或与给定日期相等
    
    Since:
    
    3.0.9
  - isAfter
```
public boolean isAfter(Date date)
```
    是否在给定日期之后或与给定日期相等
    
    Parameters:
    
    date - 日期
    
    Returns:
    
    是否在给定日期之后或与给定日期相等
    
    Since:
    
    4.1.3
  - isAfterOrEquals
```
public boolean isAfterOrEquals(Date date)
```
    是否在给定日期之后或与给定日期相等
    
    Parameters:
    
    date - 日期
    
    Returns:
    
    是否在给定日期之后或与给定日期相等
    
    Since:
    
    3.0.9
  - isMutable
```
public boolean isMutable()
```
    对象是否可变
    如果为不可变对象，以下方法将返回新方法：如果为不可变对象，setTime(long)将抛出异常
    
    Returns:
    
    对象是否可变
  - setMutable
```
public DateTime setMutable(boolean mutable)
```
    设置对象是否可变如果为不可变对象，以下方法将返回新方法：如果为不可变对象，setTime(long)将抛出异常
    
    Parameters:
    
    mutable - 是否可变
    
    Returns:
    
    this
  - getFirstDayOfWeek
```
public Fields.Week getFirstDayOfWeek()
```
    获得一周的第一天，默认为周一
    
    Returns:
    
    一周的第一天
  - setFirstDayOfWeek
```
public DateTime setFirstDayOfWeek(Fields.Week firstDayOfWeek)
```
    设置一周的第一天
    JDK的Calendar中默认一周的第一天是周日，将此默认值设置为周一
    设置一周的第一天主要影响weekOfMonth()和weekOfYear() 两个方法
    
    Parameters:
    
    firstDayOfWeek - 一周的第一天
    
    Returns:
    
    this
    
    See Also:
    
    weekOfMonth(), weekOfYear()
  - setTimeZone
```
public DateTime setTimeZone(TimeZone timeZone)
```
    设置时区
    
    Parameters:
    
    timeZone - 时区
    
    Returns:
    
    this
    
    Since:
    
    4.1.2
  - toString
```
public String toString()
```
    转为"yyyy-MM-dd yyyy-MM-dd HH:mm:ss " 格式字符串
    
    Overrides:
    
    toString in class Date
    
    Returns:
    
    "yyyy-MM-dd yyyy-MM-dd HH:mm:ss " 格式字符串
  - toDateStr
```
public String toDateStr()
```
    转为"yyyy-MM-dd " 格式字符串
    
    Returns:
    
    "yyyy-MM-dd " 格式字符串
    
    Since:
    
    4.0.0
  - toTimeStr
```
public String toTimeStr()
```
    转为"HH:mm:ss" 格式字符串
    
    Returns:
    
    "HH:mm:ss" 格式字符串
    
    Since:
    
    4.1.4
  - toString
```
public String toString(String format)
```
    转为字符串
    
    Parameters:
    
    format - 日期格式，常用格式见： Fields
    
    Returns:
    
    String
  - toString
```
public String toString(DatePrinter format)
```
    转为字符串
    
    Parameters:
    
    format - DatePrinter 或 FastDateFormat
    
    Returns:
    
    String
  - toString
```
public String toString(DateFormat format)
```
    转为字符串
    
    Parameters:
    
    format - SimpleDateFormat
    
    Returns:
    
    String
  - toMsStr
```
public String toMsStr()
```
    Returns:
    
    输出精确到毫秒的标准日期形式

Class DateTime

Constructor Summary

Method Summary

Methods inherited from class java.util.Date

Methods inherited from class java.lang.Object

Constructor Detail

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

Method Detail

of

of

of

now

getField

getField

setTime

year

quarter

quarterEnum

month

monthStartFromOne

monthEnum

weekOfYear

weekOfMonth

dayOfMonth

dayOfWeek

dayOfWeekInMonth

dayOfWeekEnum

hour

minute

second

millsecond

isAM

isPM

isLeapYear

toCalendar

toCalendar

toCalendar

toCalendar

toJdkDate

toTimestamp

toSqlDate

between

between

between

isIn

isBefore

isBeforeOrEquals

isAfter

isAfterOrEquals

isMutable

setMutable

getFirstDayOfWeek

setFirstDayOfWeek

setTimeZone

toString

toDateStr

toTimeStr

toString

toString

toString

toMsStr