TimeValue

java.lang.Object
- org.apache.hc.core5.util.TimeValue

All Implemented Interfaces:

Comparable<TimeValue>

Direct Known Subclasses:

Timeout
```
@Contract(threading=IMMUTABLE)
public class TimeValue
extends Object
implements Comparable<TimeValue>
```
Represents a time value as a long time and a TimeUnit.

Since:

5.0

Field Summary

Fields
Modifier and Type	Field and Description
`static TimeValue`	`MAX_VALUE` A constant holding the maximum value a `TimeValue` can have: `Long.MAX_VALUE` days.
`static TimeValue`	`NEG_ONE_MILLISECOND` A negative one millisecond `TimeValue`.
`static TimeValue`	`NEG_ONE_SECOND` A negative one second `TimeValue`.
`static TimeValue`	`ZERO_MILLISECONDS` A zero milliseconds `TimeValue`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`asBoundInt(long value)` Returns the given `long` value as an `int` where long values out of int range are returned as `Integer.MIN_VALUE` and `Integer.MAX_VALUE`.
`int`	`compareTo(TimeValue other)` Compares this object with the specified object for order.
`long`	`convert(TimeUnit targetTimeUnit)`
`static <T extends TimeValue> T`	`defaultsTo(T timeValue, T defaultValue)` Returns the given `timeValue` if it is not `null`, if `null` then returns the given `defaultValue`.
`static TimeValue`	`defaultsToNegativeOneMillisecond(TimeValue timeValue)` Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`.
`static TimeValue`	`defaultsToNegativeOneSecond(TimeValue timeValue)` Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`.
`static TimeValue`	`defaultsToZeroMilliseconds(TimeValue timeValue)` Returns the given `timeValue` if it is not `null`, if `null` then returns `ZERO_MILLISECONDS`.
`TimeValue`	`divide(long divisor)` Returns a TimeValue whose value is `(this / divisor)`.
`TimeValue`	`divide(long divisor, TimeUnit targetTimeUnit)` Returns a TimeValue whose value is `(this / divisor)`.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`long`	`getDuration()`
`TimeUnit`	`getTimeUnit()`
`int`	`hashCode()` Returns a hash code value for the object.
`static boolean`	`isNonNegative(TimeValue timeValue)`
`static boolean`	`isPositive(TimeValue timeValue)`
`TimeValue`	`min(TimeValue other)`
`static TimeValue`	`of(long duration, TimeUnit timeUnit)` Creates a TimeValue.
`static TimeValue`	`ofDays(long days)`
`static TimeValue`	`ofHours(long hours)`
`static TimeValue`	`ofMicroseconds(long microseconds)`
`static TimeValue`	`ofMilliseconds(long millis)`
`static TimeValue`	`ofMinutes(long minutes)`
`static TimeValue`	`ofNanoseconds(long nanoseconds)`
`static TimeValue`	`ofSeconds(long seconds)`
`static TimeValue`	`parse(String value)` Parses a TimeValue in the format `<Long><SPACE><TimeUnit>`, for example `"1200 MILLISECONDS"`.
`void`	`sleep()`
`void`	`timedJoin(Thread thread)`
`void`	`timedWait(Object obj)`
`long`	`toDays()`
`long`	`toHours()`
`long`	`toMicroseconds()`
`long`	`toMilliseconds()`
`int`	`toMillisecondsIntBound()`
`long`	`toMinutes()`
`long`	`toNanoseconds()`
`long`	`toSeconds()`
`int`	`toSecondsIntBound()`
`String`	`toString()` Returns a string representation of the object.
`Timeout`	`toTimeout()`

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

- Field Detail
  - MAX_VALUE
```
public static final TimeValue MAX_VALUE
```
    A constant holding the maximum value a TimeValue can have: Long.MAX_VALUE days.
  - NEG_ONE_MILLISECOND
```
public static final TimeValue NEG_ONE_MILLISECOND
```
    A negative one millisecond TimeValue.
  - NEG_ONE_SECOND
```
public static final TimeValue NEG_ONE_SECOND
```
    A negative one second TimeValue.
  - ZERO_MILLISECONDS
```
public static final TimeValue ZERO_MILLISECONDS
```
    A zero milliseconds TimeValue.
- Method Detail
  - asBoundInt
```
public static int asBoundInt(long value)
```
    Returns the given long value as an int where long values out of int range are returned as Integer.MIN_VALUE and Integer.MAX_VALUE.
    For example: TimeValue.asBoundInt(Long.MAX_VALUE) returns Integer.MAX_VALUE.
    
    Parameters:
    
    value - a long value to convert
    
    Returns:
    
    an int value bound within Integer.MIN_VALUE and Integer.MAX_VALUE.
  - compareTo
```
public int compareTo(TimeValue other)
```
    Description copied from interface: Comparable
    
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)
    The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
    Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
    It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."
    In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
    
    Specified by:
    
    compareTo in interface Comparable<TimeValue>
    
    Parameters:
    
    other - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - convert
```
public long convert(TimeUnit targetTimeUnit)
```
  - defaultsTo
```
public static <T extends TimeValue> T defaultsTo(T timeValue,
                                                 T defaultValue)
```
    Returns the given timeValue if it is not null, if null then returns the given defaultValue.
    
    Parameters:
    
    timeValue - may be null
    
    defaultValue - may be null
    
    Returns:
    
    timeValue or defaultValue
  - defaultsToNegativeOneMillisecond
```
public static TimeValue defaultsToNegativeOneMillisecond(TimeValue timeValue)
```
    Returns the given timeValue if it is not null, if null then returns NEG_ONE_SECOND.
    
    Parameters:
    
    timeValue - may be null
    
    Returns:
    
    timeValue or NEG_ONE_SECOND
  - defaultsToNegativeOneSecond
```
public static TimeValue defaultsToNegativeOneSecond(TimeValue timeValue)
```
    Returns the given timeValue if it is not null, if null then returns NEG_ONE_SECOND.
    
    Parameters:
    
    timeValue - may be null
    
    Returns:
    
    timeValue or NEG_ONE_SECOND
  - defaultsToZeroMilliseconds
```
public static TimeValue defaultsToZeroMilliseconds(TimeValue timeValue)
```
    Returns the given timeValue if it is not null, if null then returns ZERO_MILLISECONDS.
    
    Parameters:
    
    timeValue - may be null
    
    Returns:
    
    timeValue or ZERO_MILLISECONDS
  - divide
```
public TimeValue divide(long divisor)
```
    Returns a TimeValue whose value is (this / divisor).
    
    Parameters:
    
    divisor - value by which this TimeValue is to be divided.
    
    Returns:
    
    this / divisor
    
    Throws:
    
    ArithmeticException - if divisor is zero.
  - divide
```
public TimeValue divide(long divisor,
                        TimeUnit targetTimeUnit)
```
    Returns a TimeValue whose value is (this / divisor).
    
    Parameters:
    
    divisor - value by which this TimeValue is to be divided.
    
    targetTimeUnit - the target TimeUnit
    
    Returns:
    
    this / divisor
    
    Throws:
    
    ArithmeticException - if divisor is zero.
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap
  - getDuration
```
public long getDuration()
```
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - isNonNegative
```
public static boolean isNonNegative(TimeValue timeValue)
```
  - isPositive
```
public static boolean isPositive(TimeValue timeValue)
```
  - min
```
public TimeValue min(TimeValue other)
```
  - of
```
public static TimeValue of(long duration,
                           TimeUnit timeUnit)
```
    Creates a TimeValue.
    
    Parameters:
    
    duration - the time duration in the given timeUnit.
    
    timeUnit - the time unit for the given durarion.
    
    Returns:
    
    a Timeout
  - ofDays
```
public static TimeValue ofDays(long days)
```
  - ofHours
```
public static TimeValue ofHours(long hours)
```
  - ofMicroseconds
```
public static TimeValue ofMicroseconds(long microseconds)
```
  - ofMilliseconds
```
public static TimeValue ofMilliseconds(long millis)
```
  - ofMinutes
```
public static TimeValue ofMinutes(long minutes)
```
  - ofNanoseconds
```
public static TimeValue ofNanoseconds(long nanoseconds)
```
  - ofSeconds
```
public static TimeValue ofSeconds(long seconds)
```
  - parse
```
public static TimeValue parse(String value)
                       throws java.text.ParseException
```
    Parses a TimeValue in the format <Long><SPACE><TimeUnit>, for example "1200 MILLISECONDS".
    Parses:
    - "1200 MILLISECONDS".
    - " 1200 MILLISECONDS ", spaces are ignored.
    - "1 MINUTE", singular units.
    Parameters:
    
    value - the TimeValue to parse
    
    Returns:
    
    a new TimeValue
    
    Throws:
    
    java.text.ParseException - if the number cannot be parsed
  - sleep
```
public void sleep()
           throws InterruptedException
```
    Throws:
    
    InterruptedException
  - timedJoin
```
public void timedJoin(Thread thread)
               throws InterruptedException
```
    Throws:
    
    InterruptedException
  - timedWait
```
public void timedWait(Object obj)
               throws InterruptedException
```
    Throws:
    
    InterruptedException
  - toDays
```
public long toDays()
```
  - toHours
```
public long toHours()
```
  - toMicroseconds
```
public long toMicroseconds()
```
  - toMilliseconds
```
public long toMilliseconds()
```
  - toMillisecondsIntBound
```
public int toMillisecondsIntBound()
```
  - toMinutes
```
public long toMinutes()
```
  - toNanoseconds
```
public long toNanoseconds()
```
  - toSeconds
```
public long toSeconds()
```
  - toSecondsIntBound
```
public int toSecondsIntBound()
```
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - toTimeout
```
public Timeout toTimeout()
```

Class TimeValue

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_VALUE

NEG_ONE_MILLISECOND

NEG_ONE_SECOND

ZERO_MILLISECONDS

Method Detail

asBoundInt

compareTo

convert

defaultsTo

defaultsToNegativeOneMillisecond

defaultsToNegativeOneSecond

defaultsToZeroMilliseconds

divide

divide

equals

getDuration

getTimeUnit

hashCode

isNonNegative

isPositive

min

of

ofDays

ofHours

ofMicroseconds

ofMilliseconds

ofMinutes

ofNanoseconds

ofSeconds

parse

sleep

timedJoin

timedWait

toDays

toHours

toMicroseconds

toMilliseconds

toMillisecondsIntBound

toMinutes

toNanoseconds

toSeconds

toSecondsIntBound

toString

toTimeout