Time (autest - Gitee.com))

java.lang.Object
- com.auxiliary.tool.date.Time

All Implemented Interfaces:

Cloneable, Comparable<Time>
```
public class Time
extends Object
implements Comparable<Time>, Cloneable
```
文件名：Time.java

用途：提供对时间进行转换相关的工具

编码时间：2019年12月2日下午5:15:55

修改时间：2023年5月6日上午11:15:40

Since:

JDK 1.8, autest 2.0.0

Version:

Ver1.1

Author:

彭宇琦

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_FORMAT_PATTERN
默认格式化日期的规则

static ZoneId defaultZoneId
定义默认时区

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_FORMAT_PATTERN` 默认格式化日期的规则
`static ZoneId`	`defaultZoneId` 定义默认时区

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Time`	`addTime(double num, TimeUnit timeUnit)` 用于根据条件计算日期/时间，方法允许传入小数与负数进行计算
`Time`	`addTime(String calculateTimeText)` 用于根据传入的增减时间的规则对时间进行增减。
`Time`	`clone()`
`int`	`compareTo(Time compateTime)`
`boolean`	`equals(Object obj)`
`boolean`	`equalsForUnit(Time compareTime, TimeUnit timeUnit)` 用于根据最小比较单位，对时间进行比较
`Date`	`getDate()` 用于返回Date类对象
`String`	`getFormatTime()` 用于以指定的格式返回格式化后的时间
`String`	`getFormatTime(String pattern)` 该方法用于以临时指定的格式输出当前设置的日期时间，通过该方法设置的格式化时间不会影响通过`setTimeFormat(String)`方法设置的时间格式，具体的设置方法可参考`setTimeFormat(String)`
`LocalDateTime`	`getLocalDateTime()` 用于以`LocalDateTime`类对象的形式，返回计算后的日期/时间
`long`	`getMilliSecond()` 用于返回设置的时间的时间戳
`int`	`hashCode()`
`static Time`	`parse()` 用于将时间初始化为当前时间
`static Time`	`parse(Date date)` 用于根据`Date`类对象初始化时间
`static Time`	`parse(LocalDateTime dateTime)` 用于根据`LocalDateTime`对象初始化日期/时间，若未传入时间或时间写入有误，则初始化为当前时间
`static Time`	`parse(long ms)` 用于根据毫秒数初始化时间
`static Time`	`parse(String formatTime)` 用于根据已格式化的时间初始化时间
`static Time`	`parse(String formatTime, String formatText)` 用于根据格式化的日期/时间，及相应的时间格式，初始化日期/时间
`Time`	`setTime(int timeNum, TimeUnit timeUnit)` 用于对日期/时间中的指定单位进行赋值
`Time`	`setTimeFormat(String pattern)` 设置返回时间的格式，该方法可传入时间格式，亦可向该方法中传入时间格式的模板，通过识别模板得到日期的格式，但作为模板的日期也必须满足时间格式。例如：
`String`	`toString()`

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

- Field Detail
  - defaultZoneId
```
public static ZoneId defaultZoneId
```
    定义默认时区
  - DEFAULT_FORMAT_PATTERN
```
public static final String DEFAULT_FORMAT_PATTERN
```
    默认格式化日期的规则
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parse
```
public static Time parse(Date date)
```
    用于根据Date类对象初始化时间
    
    Parameters:
    
    date - Date类对象
    
    Returns:
    
    初始化后的类对象
    
    Since:
    
    autest 2.0.0
  - parse
```
public static Time parse(long ms)
```
    用于根据毫秒数初始化时间
    
    Parameters:
    
    ms - 时间戳（毫秒值）
    
    Returns:
    
    初始化后的类对象
    
    Since:
    
    autest 2.0.0
  - parse
```
public static Time parse(String formatTime)
```
    用于根据已格式化的时间初始化时间
    
    Parameters:
    
    formatTime - 已格式化的时间
    
    Returns:
    
    初始化后的类对象
    
    Throws:
    
    IncorrectConditionException - 时间转换错误时抛出的异常
    
    Since:
    
    autest 2.0.0
  - parse
```
public static Time parse(String formatTime,
                         String formatText)
```
    用于根据格式化的日期/时间，及相应的时间格式，初始化日期/时间
    该方法允许只传入格式化的日期或者时间，如：
```
 Time time1 = Time.parse("2020-12-12", "yyyy-MM-dd");//初始化为2020年12月12日的0点
 Time time2 = Time.parse("15:15:15", "HH:mm:ss");//初始化为当天的15时15分15秒
 
```
    Parameters:
    
    formatTime - 格式化的日期/时间
    
    formatText - 时间格式
    
    Returns:
    
    初始化后的类对象
    
    Throws:
    
    DateTimeParseException - 日期/时间无法转换时抛出的异常
    
    Since:
    
    autest 2.0.0
  - parse
```
public static Time parse(LocalDateTime dateTime)
```
    用于根据LocalDateTime对象初始化日期/时间，若未传入时间或时间写入有误，则初始化为当前时间
    
    Parameters:
    
    dateTime - 指定的LocalDateTime对象
    
    Returns:
    
    初始化后的类对象
    
    Since:
    
    autest 2.0.0
  - parse
```
public static Time parse()
```
    用于将时间初始化为当前时间
    
    Returns:
    
    初始化后的类对象
    
    Since:
    
    autest 2.0.0
  - setTime
```
public Time setTime(int timeNum,
                    TimeUnit timeUnit)
```
    用于对日期/时间中的指定单位进行赋值
    
    Parameters:
    
    timeNum - 指定的数值
    
    timeUnit - 时间单位枚举TimeUnit
    
    Returns:
    
    类本身
    
    Throws:
    
    IncorrectConditionException - 数值无法被赋入相应的单位下时抛出的异常
    
    Since:
    
    autest 2.0.0
  - setTimeFormat
```
public Time setTimeFormat(String pattern)
```
    设置返回时间的格式，该方法可传入时间格式，亦可向该方法中传入时间格式的模板，通过识别模板得到日期的格式，但作为模板的日期也必须满足时间格式。例如：
```
 
 Time time = new Time(1575387800000L);

 time.setTimeFormat("yyyy年MM月dd日 HH:mm:ss");
 getFormatTime();//输出：2019年12月03日 23:43:20

 time.setTimeFormat("2019/12/04 03:03:20");
 getFormatTime();//输出：2019/12/03 23:43:20
 
 
```
    注意
    1. 传入已格式化的时间时，其不会改变当前存储的时间
    2. 已格式化的时间中，其分隔符不能包含字母，否则转译将出错（在格式化时间的方法中也不允许存在字母）
    Parameters:
    
    pattern - 指定的格式或已格式化的时间
    
    Returns:
    
    类本身
    
    Since:
    
    autest 2.0.0
  - getDate
```
public Date getDate()
```
    用于返回Date类对象
    
    Returns:
    
    Date类对象
    
    Since:
    
    autest 2.0.0
  - getMilliSecond
```
public long getMilliSecond()
```
    用于返回设置的时间的时间戳
    
    Returns:
    
    时间戳
    
    Since:
    
    autest 2.0.0
  - getFormatTime
```
public String getFormatTime()
```
    用于以指定的格式返回格式化后的时间
    若未设置时间格式，则默认按照“yyyy-MM-dd HH:mm:ss”的格式进行返回
    
    Returns:
    
    格式化后的时间
    
    Since:
    
    autest 2.0.0
  - getFormatTime
```
public String getFormatTime(String pattern)
```
    该方法用于以临时指定的格式输出当前设置的日期时间，通过该方法设置的格式化时间不会影响通过setTimeFormat(String)方法设置的时间格式，具体的设置方法可参考setTimeFormat(String)
    
    Parameters:
    
    pattern - 格式化规则
    
    Returns:
    
    格式化后的日期时间
    
    Since:
    
    autest 4.2.0
  - getLocalDateTime
```
public LocalDateTime getLocalDateTime()
```
    用于以LocalDateTime类对象的形式，返回计算后的日期/时间
    
    Returns:
    
    LocalDateTime类对象
    
    Since:
    
    autest 2.0.0
  - addTime
```
public Time addTime(double num,
                    TimeUnit timeUnit)
```
    用于根据条件计算日期/时间，方法允许传入小数与负数进行计算
    注意：在计算年、月时，若传入的数值是小数，在转换毫秒值时，其会按照
    - 1年 = 365天
    - 1月 = 30天
    进行计算，在跨度大的计算中，其会存在精度的丢失
    Parameters:
    
    num - 日期/时间增减的数量
    
    timeUnit - 日期计算的单位
    
    Since:
    
    autest 2.0.0
  - addTime
```
public Time addTime(String calculateTimeText)
```
    用于根据传入的增减时间的规则对时间进行增减。
    根据单位前的数值对指定的单位进行增减。例如：需要对当前设置的时间增加1年3个月又5天并较少2小时30分钟45秒，此时可以传入“1年3月5日-2时-30分-45秒”，亦可以传入“1y3m5d-2h-30min-45s”。
    - 年单位：年、y、Y
    - 月单位：月、m、M
    - 周单位：周、w、W
    - 日单位：日、d、D
    - 小时单位：时、h、H
    - 分钟单位：分、min、MIN
    - 秒单位：秒、s、S
    具体的计算规则与addTime(double, TimeUnit)方法一致
    
    注意：数字前不写运算符，则默认为增加时间，例如“-1d2s”意义为减少一天并增加两秒
    Parameters:
    
    calculateTimeText - 增减时间的规则
    
    Returns:
    
    返回修改后的时间戳
    
    Since:
    
    autest 2.0.0
  - compareTo
```
public int compareTo(Time compateTime)
```
    Specified by:
    
    compareTo in interface Comparable<Time>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsForUnit
```
public boolean equalsForUnit(Time compareTime,
                             TimeUnit timeUnit)
```
    用于根据最小比较单位，对时间进行比较
    通过指定最小比较单位，从而返回该单位及以上单位的对比结果，例如：
    - 当调用t1.equalsForUnit(t2, TimeUnit.SECOND)时，则返回结果为false
    - 当调用t1.equalsForUnit(t2, TimeUnit.DAY)时，则返回结果为true
    注意：除TimeUnit.YEAR、TimeUnit.MONTH、TimeUnit.DAY、 TimeUnit.HOUR、TimeUnit.MINUTE、TimeUnit.SECOND单位外，其他的单位传入进行判断时，会抛出异常
    Parameters:
    
    compareTime - 需要比对的时间
    
    timeUnit - 最小判断单位
    
    Returns:
    
    对比结果
    
    Throws:
    
    IncorrectConditionException - 单位传入有误时抛出的异常
    
    Since:
    
    autest 2.0.0
  - clone
```
public Time clone()
```
    Overrides:
    
    clone in class Object

Class Time

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultZoneId

DEFAULT_FORMAT_PATTERN

Method Detail

parse

parse

parse

parse

parse

parse

setTime

setTimeFormat

getDate

getMilliSecond

getFormatTime

getFormatTime

getLocalDateTime

addTime

addTime

compareTo

toString

hashCode

equals

equalsForUnit

clone