TimeDuration (Apache Ratis Common 2.5.0 API)

java.lang.Object
- org.apache.ratis.util.TimeDuration

所有已实现的接口:

Comparable<TimeDuration>
```
public final class TimeDuration
extends Object
implements Comparable<TimeDuration>
```
Time duration is represented by a long together with a TimeUnit.
This is a value-based class.

嵌套类概要

嵌套类
限定符和类型类和说明

static class TimeDuration.Abbreviation
Abbreviations of TimeUnit.

嵌套类
限定符和类型	类和说明
`static class`	`TimeDuration.Abbreviation` Abbreviations of `TimeUnit`.

字段概要

字段
限定符和类型	字段和说明
`static TimeDuration`	`ONE_DAY`
`static TimeDuration`	`ONE_MILLISECOND`
`static TimeDuration`	`ONE_MINUTE`
`static TimeDuration`	`ONE_SECOND`
`static TimeDuration`	`ZERO`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`TimeDuration`	`add(long thatDuration, TimeUnit thatUnit)`
`TimeDuration`	`add(TimeDuration that)`
`<OUTPUT,THROWABLE extends Throwable> OUTPUT`	`apply(CheckedBiFunction<Long,TimeUnit,OUTPUT,THROWABLE> function)` Apply the given function to the (duration, unit) of this object.
`TimeDuration`	`apply(LongUnaryOperator operator)` Apply the given operator to the duration value of this object.
`int`	`compareTo(TimeDuration that)`
`boolean`	`equals(Object obj)`
`long`	`getDuration()`
`TimeUnit`	`getUnit()`
`int`	`hashCode()`
`static TimeUnit`	`higherUnit(TimeUnit unit)`
`boolean`	`isNegative()`
`boolean`	`isNonPositive()`
`static TimeUnit`	`lowerUnit(TimeUnit unit)`
`TimeDuration`	`multiply(double multiplier)`
`TimeDuration`	`negate()`
`static long`	`parse(String timeString, TimeUnit targetUnit)` The same as valueOf(timeString, targetUnit).toLong(targetUnit).
`long`	`roundUpNanos(long nanos)` Round up to the given nanos to nearest multiple (in nanoseconds) of this `TimeDuration`.
`TimeDuration`	`sleep()` The same as sleep(null).
`TimeDuration`	`sleep(Consumer<Object> log)` Performs a `TimeUnit.sleep(long)` using this `TimeDuration`.
`TimeDuration`	`subtract(TimeDuration that)`
`TimeDuration`	`to(TimeUnit targetUnit)`
`int`	`toIntExact(TimeUnit targetUnit)` The same as Math.toIntExact(toLong(targetUnit)); Similar to `toLong(TimeUnit)`, the returned value may be truncated.
`long`	`toLong(TimeUnit targetUnit)` Convert this `TimeDuration` to a long in the target unit.
`String`	`toString()`
`String`	`toString(TimeUnit targetUnit, int decimalPlaces)`
`static TimeDuration`	`valueOf(long duration, TimeUnit unit)`
`static TimeDuration`	`valueOf(String timeString, TimeUnit defaultUnit)` Parse the given time duration string.

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

- 字段详细资料
  - ZERO
```
public static final TimeDuration ZERO
```
  - ONE_MILLISECOND
```
public static final TimeDuration ONE_MILLISECOND
```
  - ONE_SECOND
```
public static final TimeDuration ONE_SECOND
```
  - ONE_MINUTE
```
public static final TimeDuration ONE_MINUTE
```
  - ONE_DAY
```
public static final TimeDuration ONE_DAY
```
- 方法详细资料
  - lowerUnit
```
public static TimeUnit lowerUnit(TimeUnit unit)
```
    返回:
    
    the next lower TimeUnit. If the unit is already the lowest, return it.
  - higherUnit
```
public static TimeUnit higherUnit(TimeUnit unit)
```
    返回:
    
    the next higher TimeUnit. If the unit is already the highest, return it.
  - parse
```
public static long parse(String timeString,
                         TimeUnit targetUnit)
```
    The same as valueOf(timeString, targetUnit).toLong(targetUnit).
  - valueOf
```
public static TimeDuration valueOf(String timeString,
                                   TimeUnit defaultUnit)
```
    Parse the given time duration string. If no unit is specified, use the default unit. This method support underscores in Numeric Literals as in Java 8.
    
    返回:
    
    a TimeDuration in the target unit.
  - valueOf
```
public static TimeDuration valueOf(long duration,
                                   TimeUnit unit)
```
    返回:
    
    a TimeDuration representing the given duration and unit.
  - getDuration
```
public long getDuration()
```
    返回:
    
    the duration value.
  - getUnit
```
public TimeUnit getUnit()
```
    返回:
    
    the TimeUnit.
  - toLong
```
public long toLong(TimeUnit targetUnit)
```
    Convert this TimeDuration to a long in the target unit. Note that the returned value may be truncated or saturated; see TimeUnit.convert(long, TimeUnit).*
    
    返回:
    
    the value in the target unit.
  - toIntExact
```
public int toIntExact(TimeUnit targetUnit)
```
    The same as Math.toIntExact(toLong(targetUnit)); Similar to toLong(TimeUnit), the returned value may be truncated. However, the returned value is never saturated. The method throws ArithmeticException if it overflows.
    
    返回:
    
    the value in the target unit.
    
    抛出:
    
    ArithmeticException - if it overflows.
  - to
```
public TimeDuration to(TimeUnit targetUnit)
```
    返回:
    
    the TimeDuration in the target unit.
  - add
```
public TimeDuration add(TimeDuration that)
```
    返回:
    
    (this + that) in the minimum unit among them.
  - add
```
public TimeDuration add(long thatDuration,
                        TimeUnit thatUnit)
```
    返回:
    
    (this + (thatDuration, thatUnit)) in the minimum unit among them.
  - subtract
```
public TimeDuration subtract(TimeDuration that)
```
    返回:
    
    (this - that) in the minimum unit among them.
  - multiply
```
public TimeDuration multiply(double multiplier)
```
    返回:
    
    this * multiplier; the result unit may be changed in order to reduce rounding/overflow error.
  - negate
```
public TimeDuration negate()
```
    返回:
    
    -this.
  - roundUpNanos
```
public long roundUpNanos(long nanos)
```
    Round up to the given nanos to nearest multiple (in nanoseconds) of this TimeDuration.
  - apply
```
public TimeDuration apply(LongUnaryOperator operator)
```
    Apply the given operator to the duration value of this object.
    
    返回:
    
    a new object with the new duration value and the same unit of this object.
  - apply
```
public <OUTPUT,THROWABLE extends Throwable> OUTPUT apply(CheckedBiFunction<Long,TimeUnit,OUTPUT,THROWABLE> function)
                                                  throws THROWABLE extends Throwable
```
    Apply the given function to the (duration, unit) of this object.
    
    抛出:
    
    THROWABLE extends Throwable
  - isNegative
```
public boolean isNegative()
```
    返回:
    
    Is this TimeDuration negative?
  - isNonPositive
```
public boolean isNonPositive()
```
    返回:
    
    Is this TimeDuration less than or equal to zero?
  - sleep
```
public TimeDuration sleep()
                   throws InterruptedException
```
    The same as sleep(null).
    
    抛出:
    
    InterruptedException
  - sleep
```
public TimeDuration sleep(Consumer<Object> log)
                   throws InterruptedException
```
    Performs a TimeUnit.sleep(long) using this TimeDuration.
    
    参数:
    
    log - If not null, use it to print log messages.
    
    返回:
    
    the difference of the actual sleep time duration and this TimeDuration.
    
    抛出:
    
    InterruptedException
  - compareTo
```
public int compareTo(TimeDuration that)
```
    指定者:
    
    compareTo 在接口中 Comparable<TimeDuration>
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - toString
```
public String toString(TimeUnit targetUnit,
                       int decimalPlaces)
```
    返回:
    
    a representation of this object in the given target unit and decimal places.

类 TimeDuration

嵌套类概要

字段概要

方法概要

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

字段详细资料

ZERO

ONE_MILLISECOND

ONE_SECOND

ONE_MINUTE

ONE_DAY

方法详细资料

lowerUnit

higherUnit

parse

valueOf

valueOf

getDuration

getUnit

toLong

toIntExact

to

add

add

subtract

multiply

negate

roundUpNanos

apply

apply

isNegative

isNonPositive

sleep

sleep

compareTo

equals

hashCode

toString

toString