CalendarUtil (hutool-core 5.8.9 API)

java.lang.Object
- cn.hutool.core.date.CalendarUtil

直接已知子类:

DateUtil
```
public class CalendarUtil
extends Object
```
针对Calendar 对象封装工具类

从以下版本开始:

5.3.0

作者:

looly

构造器概要

构造器
构造器和说明

CalendarUtil()

构造器
构造器和说明
`CalendarUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`age(Calendar birthday, Calendar dateToCompare)` 计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄
`protected static int`	`age(long birthday, long dateToCompare)` 计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄
`static Calendar`	`beginOfDay(Calendar calendar)` 修改某天的开始时间
`static Calendar`	`beginOfHour(Calendar calendar)` 修改某小时的开始时间
`static Calendar`	`beginOfMinute(Calendar calendar)` 修改某分钟的开始时间
`static Calendar`	`beginOfMonth(Calendar calendar)` 修改某月的开始时间
`static Calendar`	`beginOfQuarter(Calendar calendar)` 修改某季度的开始时间
`static Calendar`	`beginOfSecond(Calendar calendar)` 修改秒级别的开始时间，即忽略毫秒部分
`static Calendar`	`beginOfWeek(Calendar calendar)` 修改给定日期当前周的开始时间，周一定为一周的开始时间
`static Calendar`	`beginOfWeek(Calendar calendar, boolean isMondayAsFirstDay)` 修改给定日期当前周的开始时间
`static Calendar`	`beginOfYear(Calendar calendar)` 修改某年的开始时间
`static Calendar`	`calendar()` 创建Calendar对象，时间为默认时区的当前时间
`static Calendar`	`calendar(Date date)` 转换为Calendar对象
`static Calendar`	`calendar(long millis)` 转换为Calendar对象，使用当前默认时区
`static Calendar`	`calendar(long millis, TimeZone timeZone)` 转换为Calendar对象
`static Calendar`	`ceiling(Calendar calendar, DateField dateField)` 修改日期为某个时间字段结束时间
`static Calendar`	`ceiling(Calendar calendar, DateField dateField, boolean truncateMillisecond)` 修改日期为某个时间字段结束时间可选是否归零毫秒。
`static int`	`compare(Calendar calendar1, Calendar calendar2)` `null`安全的`Calendar`比较，`null`小于任何日期
`static Calendar`	`endOfDay(Calendar calendar)` 修改某天的结束时间
`static Calendar`	`endOfHour(Calendar calendar)` 修改某小时的结束时间
`static Calendar`	`endOfMinute(Calendar calendar)` 修改某分钟的结束时间
`static Calendar`	`endOfMonth(Calendar calendar)` 修改某月的结束时间
`static Calendar`	`endOfQuarter(Calendar calendar)` 获取某季度的结束时间
`static Calendar`	`endOfSecond(Calendar calendar)` 修改秒级别的结束时间，即毫秒设置为999
`static Calendar`	`endOfWeek(Calendar calendar)` 修改某周的结束时间，周日定为一周的结束
`static Calendar`	`endOfWeek(Calendar calendar, boolean isSundayAsLastDay)` 修改某周的结束时间
`static Calendar`	`endOfYear(Calendar calendar)` 修改某年的结束时间
`static String`	`formatChineseDate(Calendar calendar, boolean withTime)` 将指定Calendar时间格式化为纯中文形式，比如： 2018-02-24 12:13:14 转换为二〇一八年二月二十四日（withTime为false） 2018-02-24 12:13:14 转换为二〇一八年二月二十四日十二时十三分十四秒（withTime为true）
`static int`	`getBeginValue(Calendar calendar, DateField dateField)` 获取指定日期字段的最小值，例如分钟的最小值是0
`static int`	`getBeginValue(Calendar calendar, int dateField)` 获取指定日期字段的最小值，例如分钟的最小值是0
`static int`	`getEndValue(Calendar calendar, DateField dateField)` 获取指定日期字段的最大值，例如分钟的最大值是59
`static int`	`getEndValue(Calendar calendar, int dateField)` 获取指定日期字段的最大值，例如分钟的最大值是59
`static boolean`	`isAM(Calendar calendar)` 是否为上午
`static boolean`	`isPM(Calendar calendar)` 是否为下午
`static boolean`	`isSameDay(Calendar cal1, Calendar cal2)` 比较两个日期是否为同一天
`static boolean`	`isSameInstant(Calendar date1, Calendar date2)` 检查两个Calendar时间戳是否相同。
`static boolean`	`isSameMonth(Calendar cal1, Calendar cal2)` 比较两个日期是否为同一月
`static boolean`	`isSameWeek(Calendar cal1, Calendar cal2, boolean isMon)` 比较两个日期是否为同一周
`static Calendar`	`parse(CharSequence str, boolean lenient, DateParser parser)` 使用指定`DateParser`解析字符串为`Calendar`
`static Calendar`	`parseByPatterns(String str, Locale locale, boolean lenient, String... parsePatterns)` 通过给定的日期格式解析日期时间字符串。
`static Calendar`	`parseByPatterns(String str, Locale locale, String... parsePatterns)` 通过给定的日期格式解析日期时间字符串。
`static Calendar`	`parseByPatterns(String str, String... parsePatterns)` 通过给定的日期格式解析日期时间字符串。
`static Calendar`	`round(Calendar calendar, DateField dateField)` 修改日期为某个时间字段四舍五入时间
`static Instant`	`toInstant(Calendar calendar)` Calendar`Instant`对象
`static LocalDateTime`	`toLocalDateTime(Calendar calendar)` `Calendar` 转换为 `LocalDateTime`，使用系统默认时区
`static Calendar`	`truncate(Calendar calendar, DateField dateField)` 修改日期为某个时间字段起始时间
`static String`	`yearAndQuarter(Calendar cal)` 获得指定日期年份和季度格式：[20131]表示2013年第一季度
`static LinkedHashSet<String>`	`yearAndQuarter(long startDate, long endDate)` 获得指定日期区间内的年份和季度

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CalendarUtil
```
public CalendarUtil()
```
- 方法详细资料
  - calendar
```
public static Calendar calendar()
```
    创建Calendar对象，时间为默认时区的当前时间
    
    返回:
    
    Calendar对象
    
    从以下版本开始:
    
    4.6.6
  - calendar
```
public static Calendar calendar(Date date)
```
    转换为Calendar对象
    
    参数:
    
    date - 日期对象
    
    返回:
    
    Calendar对象
  - calendar
```
public static Calendar calendar(long millis)
```
    转换为Calendar对象，使用当前默认时区
    
    参数:
    
    millis - 时间戳
    
    返回:
    
    Calendar对象
  - calendar
```
public static Calendar calendar(long millis,
                                TimeZone timeZone)
```
    转换为Calendar对象
    
    参数:
    
    millis - 时间戳
    
    timeZone - 时区
    
    返回:
    
    Calendar对象
    
    从以下版本开始:
    
    5.7.22
  - isAM
```
public static boolean isAM(Calendar calendar)
```
    是否为上午
    
    参数:
    
    calendar - Calendar
    
    返回:
    
    是否为上午
  - isPM
```
public static boolean isPM(Calendar calendar)
```
    是否为下午
    
    参数:
    
    calendar - Calendar
    
    返回:
    
    是否为下午
  - truncate
```
public static Calendar truncate(Calendar calendar,
                                DateField dateField)
```
    修改日期为某个时间字段起始时间
    
    参数:
    
    calendar - Calendar
    
    dateField - 保留到的时间字段，如定义为 DateField.SECOND，表示这个字段不变，这个字段以下字段全部归0
    
    返回:
    
    原Calendar
  - round
```
public static Calendar round(Calendar calendar,
                             DateField dateField)
```
    修改日期为某个时间字段四舍五入时间
    
    参数:
    
    calendar - Calendar
    
    dateField - 时间字段
    
    返回:
    
    原Calendar
  - ceiling
```
public static Calendar ceiling(Calendar calendar,
                               DateField dateField)
```
    修改日期为某个时间字段结束时间
    
    参数:
    
    calendar - Calendar
    
    dateField - 保留到的时间字段，如定义为 DateField.SECOND，表示这个字段不变，这个字段以下字段全部取最大值
    
    返回:
    
    原Calendar
  - ceiling
```
public static Calendar ceiling(Calendar calendar,
                               DateField dateField,
                               boolean truncateMillisecond)
```
    修改日期为某个时间字段结束时间
    可选是否归零毫秒。
    有时候由于毫秒部分必须为0（如MySQL数据库中），因此在此加上选项。
    
    参数:
    
    calendar - Calendar
    
    dateField - 时间字段
    
    truncateMillisecond - 是否毫秒归零
    
    返回:
    
    原Calendar
  - beginOfSecond
```
public static Calendar beginOfSecond(Calendar calendar)
```
    修改秒级别的开始时间，即忽略毫秒部分
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
    
    从以下版本开始:
    
    4.6.2
  - endOfSecond
```
public static Calendar endOfSecond(Calendar calendar)
```
    修改秒级别的结束时间，即毫秒设置为999
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
    
    从以下版本开始:
    
    4.6.2
  - beginOfHour
```
public static Calendar beginOfHour(Calendar calendar)
```
    修改某小时的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfHour
```
public static Calendar endOfHour(Calendar calendar)
```
    修改某小时的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - beginOfMinute
```
public static Calendar beginOfMinute(Calendar calendar)
```
    修改某分钟的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfMinute
```
public static Calendar endOfMinute(Calendar calendar)
```
    修改某分钟的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - beginOfDay
```
public static Calendar beginOfDay(Calendar calendar)
```
    修改某天的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfDay
```
public static Calendar endOfDay(Calendar calendar)
```
    修改某天的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - beginOfWeek
```
public static Calendar beginOfWeek(Calendar calendar)
```
    修改给定日期当前周的开始时间，周一定为一周的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - beginOfWeek
```
public static Calendar beginOfWeek(Calendar calendar,
                                   boolean isMondayAsFirstDay)
```
    修改给定日期当前周的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    isMondayAsFirstDay - 是否周一做为一周的第一天（false表示周日做为第一天）
    
    返回:
    
    Calendar
    
    从以下版本开始:
    
    3.1.2
  - endOfWeek
```
public static Calendar endOfWeek(Calendar calendar)
```
    修改某周的结束时间，周日定为一周的结束
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfWeek
```
public static Calendar endOfWeek(Calendar calendar,
                                 boolean isSundayAsLastDay)
```
    修改某周的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    isSundayAsLastDay - 是否周日做为一周的最后一天（false表示周六做为最后一天）
    
    返回:
    
    Calendar
  - beginOfMonth
```
public static Calendar beginOfMonth(Calendar calendar)
```
    修改某月的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfMonth
```
public static Calendar endOfMonth(Calendar calendar)
```
    修改某月的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - beginOfQuarter
```
public static Calendar beginOfQuarter(Calendar calendar)
```
    修改某季度的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
    
    从以下版本开始:
    
    4.1.0
  - endOfQuarter
```
public static Calendar endOfQuarter(Calendar calendar)
```
    获取某季度的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
    
    从以下版本开始:
    
    4.1.0
  - beginOfYear
```
public static Calendar beginOfYear(Calendar calendar)
```
    修改某年的开始时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - endOfYear
```
public static Calendar endOfYear(Calendar calendar)
```
    修改某年的结束时间
    
    参数:
    
    calendar - 日期 Calendar
    
    返回:
    
    Calendar
  - isSameDay
```
public static boolean isSameDay(Calendar cal1,
                                Calendar cal2)
```
    比较两个日期是否为同一天
    
    参数:
    
    cal1 - 日期1
    
    cal2 - 日期2
    
    返回:
    
    是否为同一天
  - isSameWeek
```
public static boolean isSameWeek(Calendar cal1,
                                 Calendar cal2,
                                 boolean isMon)
```
    比较两个日期是否为同一周
    
    参数:
    
    cal1 - 日期1
    
    cal2 - 日期2
    
    isMon - 是否为周一。国内第一天为星期一，国外第一天为星期日
    
    返回:
    
    是否为同一周
    
    从以下版本开始:
    
    5.7.21
  - isSameMonth
```
public static boolean isSameMonth(Calendar cal1,
                                  Calendar cal2)
```
    比较两个日期是否为同一月
    
    参数:
    
    cal1 - 日期1
    
    cal2 - 日期2
    
    返回:
    
    是否为同一月
    
    从以下版本开始:
    
    5.4.1
  - isSameInstant
```
public static boolean isSameInstant(Calendar date1,
                                    Calendar date2)
```
    检查两个Calendar时间戳是否相同。
    
    此方法检查两个Calendar的毫秒数时间戳是否相同。
    
    参数:
    
    date1 - 时间1
    
    date2 - 时间2
    
    返回:
    
    两个Calendar时间戳是否相同。如果两个时间都为null返回true，否则有null返回false
    
    从以下版本开始:
    
    5.3.11
  - yearAndQuarter
```
public static LinkedHashSet<String> yearAndQuarter(long startDate,
                                                   long endDate)
```
    获得指定日期区间内的年份和季度
    
    参数:
    
    startDate - 起始日期（包含）
    
    endDate - 结束日期（包含）
    
    返回:
    
    季度列表，元素类似于 20132
    
    从以下版本开始:
    
    4.1.15
  - yearAndQuarter
```
public static String yearAndQuarter(Calendar cal)
```
    获得指定日期年份和季度
    格式：[20131]表示2013年第一季度
    
    参数:
    
    cal - 日期
    
    返回:
    
    年和季度，格式类似于20131
  - getBeginValue
```
public static int getBeginValue(Calendar calendar,
                                DateField dateField)
```
    获取指定日期字段的最小值，例如分钟的最小值是0
    
    参数:
    
    calendar - Calendar
    
    dateField - DateField
    
    返回:
    
    字段最小值
    
    从以下版本开始:
    
    5.4.2
    
    另请参阅:
    
    Calendar.getActualMinimum(int)
  - getBeginValue
```
public static int getBeginValue(Calendar calendar,
                                int dateField)
```
    获取指定日期字段的最小值，例如分钟的最小值是0
    
    参数:
    
    calendar - Calendar
    
    dateField - DateField
    
    返回:
    
    字段最小值
    
    从以下版本开始:
    
    4.5.7
    
    另请参阅:
    
    Calendar.getActualMinimum(int)
  - getEndValue
```
public static int getEndValue(Calendar calendar,
                              DateField dateField)
```
    获取指定日期字段的最大值，例如分钟的最大值是59
    
    参数:
    
    calendar - Calendar
    
    dateField - DateField
    
    返回:
    
    字段最大值
    
    从以下版本开始:
    
    5.4.2
    
    另请参阅:
    
    Calendar.getActualMaximum(int)
  - getEndValue
```
public static int getEndValue(Calendar calendar,
                              int dateField)
```
    获取指定日期字段的最大值，例如分钟的最大值是59
    
    参数:
    
    calendar - Calendar
    
    dateField - DateField
    
    返回:
    
    字段最大值
    
    从以下版本开始:
    
    4.5.7
    
    另请参阅:
    
    Calendar.getActualMaximum(int)
  - toInstant
```
public static Instant toInstant(Calendar calendar)
```
    CalendarInstant对象
    
    参数:
    
    calendar - Date对象
    
    返回:
    
    Instant对象
    
    从以下版本开始:
    
    5.0.5
  - toLocalDateTime
```
public static LocalDateTime toLocalDateTime(Calendar calendar)
```
    Calendar 转换为 LocalDateTime，使用系统默认时区
    
    参数:
    
    calendar - Calendar
    
    返回:
    
    LocalDateTime
    
    从以下版本开始:
    
    5.0.5
  - compare
```
public static int compare(Calendar calendar1,
                          Calendar calendar2)
```
    null安全的Calendar比较，null小于任何日期
    
    参数:
    
    calendar1 - 日期1
    
    calendar2 - 日期2
    
    返回:
    
    比较结果，如果calendar1 < calendar2，返回数小于0，calendar1==calendar2返回0，calendar1 > calendar2 大于0
    
    从以下版本开始:
    
    4.6.2
  - age
```
public static int age(Calendar birthday,
                      Calendar dateToCompare)
```
    计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄
    
    参数:
    
    birthday - 生日
    
    dateToCompare - 需要对比的日期
    
    返回:
    
    年龄
  - formatChineseDate
```
public static String formatChineseDate(Calendar calendar,
                                       boolean withTime)
```
    将指定Calendar时间格式化为纯中文形式，比如：
```
     2018-02-24 12:13:14 转换为 二〇一八年二月二十四日（withTime为false）
     2018-02-24 12:13:14 转换为 二〇一八年二月二十四日十二时十三分十四秒（withTime为true）
 
```
    参数:
    
    calendar - Calendar
    
    withTime - 是否包含时间部分
    
    返回:
    
    格式化后的字符串
    
    从以下版本开始:
    
    5.3.9
  - age
```
protected static int age(long birthday,
                         long dateToCompare)
```
    计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄
    
    参数:
    
    birthday - 生日
    
    dateToCompare - 需要对比的日期
    
    返回:
    
    年龄
  - parseByPatterns
```
public static Calendar parseByPatterns(String str,
                                       String... parsePatterns)
                                throws DateException
```
    通过给定的日期格式解析日期时间字符串。
    传入的日期格式会逐个尝试，直到解析成功，返回Calendar对象，否则抛出DateException异常。方法来自：Apache Commons-Lang3
    
    参数:
    
    str - 日期时间字符串，非空
    
    parsePatterns - 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat
    
    返回:
    
    解析后的Calendar
    
    抛出:
    
    IllegalArgumentException - if the date string or pattern array is null
    
    DateException - if none of the date patterns were suitable
    
    从以下版本开始:
    
    5.3.11
  - parseByPatterns
```
public static Calendar parseByPatterns(String str,
                                       Locale locale,
                                       String... parsePatterns)
                                throws DateException
```
    通过给定的日期格式解析日期时间字符串。
    传入的日期格式会逐个尝试，直到解析成功，返回Calendar对象，否则抛出DateException异常。方法来自：Apache Commons-Lang3
    
    参数:
    
    str - 日期时间字符串，非空
    
    locale - 地区，当为null时使用Locale.getDefault()
    
    parsePatterns - 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat
    
    返回:
    
    解析后的Calendar
    
    抛出:
    
    IllegalArgumentException - if the date string or pattern array is null
    
    DateException - if none of the date patterns were suitable
    
    从以下版本开始:
    
    5.3.11
  - parseByPatterns
```
public static Calendar parseByPatterns(String str,
                                       Locale locale,
                                       boolean lenient,
                                       String... parsePatterns)
                                throws DateException
```
    通过给定的日期格式解析日期时间字符串。
    传入的日期格式会逐个尝试，直到解析成功，返回Calendar对象，否则抛出DateException异常。方法来自：Apache Commons-Lang3
    
    参数:
    
    str - 日期时间字符串，非空
    
    locale - 地区，当为null时使用Locale.getDefault()
    
    lenient - 日期时间解析是否使用严格模式
    
    parsePatterns - 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat
    
    返回:
    
    解析后的Calendar
    
    抛出:
    
    IllegalArgumentException - if the date string or pattern array is null
    
    DateException - if none of the date patterns were suitable
    
    从以下版本开始:
    
    5.3.11
    
    另请参阅:
    
    Calendar.isLenient()
  - parse
```
public static Calendar parse(CharSequence str,
                             boolean lenient,
                             DateParser parser)
```
    使用指定DateParser解析字符串为Calendar
    
    参数:
    
    str - 日期字符串
    
    lenient - 是否宽容模式
    
    parser - DateParser
    
    返回:
    
    解析后的 Calendar，解析失败返回null
    
    从以下版本开始:
    
    5.7.14

类 CalendarUtil

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CalendarUtil

方法详细资料

calendar

calendar

calendar

calendar

isAM

isPM

truncate

round

ceiling

ceiling

beginOfSecond

endOfSecond

beginOfHour

endOfHour

beginOfMinute

endOfMinute

beginOfDay

endOfDay

beginOfWeek

beginOfWeek

endOfWeek

endOfWeek

beginOfMonth

endOfMonth

beginOfQuarter

endOfQuarter

beginOfYear

endOfYear

isSameDay

isSameWeek

isSameMonth

isSameInstant

yearAndQuarter

yearAndQuarter

getBeginValue

getBeginValue

getEndValue

getEndValue

toInstant

toLocalDateTime

compare

age

formatChineseDate

age

parseByPatterns

parseByPatterns

parseByPatterns

parse