Deadline

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

```
public class Deadline
extends Object
```
A deadline based on a UNIX time, the elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

Since:

5.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATE_FORMAT` The format used for parsing and formatting dates.
`static Deadline`	`MAX_VALUE` The maximum (longest-lived) deadline.
`static Deadline`	`MIN_VALUE` The minimum (shortest-lived) deadline.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Deadline`	`calculate(long timeMillis, TimeValue timeValue)` Calculates a deadline with a given time in milliseconds plus a given time value.
`static Deadline`	`calculate(TimeValue timeValue)` Calculates a deadline from now plus a given time value.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`String`	`format(TimeUnit overdueTimeUnit)` Formats this deadline.
`String`	`formatTarget()` Formats the deadline value as a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
`Deadline`	`freeze()`
`static Deadline`	`fromUnixMilliseconds(long value)` Creates a deadline from a UNIX time in milliseconds.
`long`	`getValue()` Gets the UNIX time deadline value.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isBefore(long millis)` Returns whether this deadline occurs before the given time in milliseconds.
`boolean`	`isExpired()` Returns whether the deadline has expired.
`boolean`	`isMax()` Returns whether this deadline is the maximum deadline.
`boolean`	`isMin()` Returns whether this deadline is the minimum deadline.
`boolean`	`isNotExpired()` Returns whether this deadline has not expired.
`Deadline`	`min(Deadline other)` Returns the smaller of this and another `Deadline`.
`static Deadline`	`parse(String source)` Creates a deadline from a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
`long`	`remaining()` Returns the difference in milliseconds between the deadline and now.
`TimeValue`	`remainingTimeValue()` Returns the difference as a TimeValue between the deadline and now.
`String`	`toString()` Returns a string representation of the object.

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

- Field Detail
  - DATE_FORMAT
```
public static final String DATE_FORMAT
```
    The format used for parsing and formatting dates.
    
    See Also:
    
    Constant Field Values
  - MAX_VALUE
```
public static Deadline MAX_VALUE
```
    The maximum (longest-lived) deadline.
  - MIN_VALUE
```
public static Deadline MIN_VALUE
```
    The minimum (shortest-lived) deadline.
- Method Detail
  - calculate
```
public static Deadline calculate(long timeMillis,
                                 TimeValue timeValue)
```
    Calculates a deadline with a given time in milliseconds plus a given time value. Non-positive time values represent an indefinite timeout without a deadline.
    
    Parameters:
    
    timeMillis - A time in UNIX milliseconds, usually the current time.
    
    timeValue - time value to add to timeMillis.
    
    Returns:
    
    a deadline representing the current time plus the given time value.
  - calculate
```
public static Deadline calculate(TimeValue timeValue)
```
    Calculates a deadline from now plus a given time value. Non-positive time values represent an indefinite timeout without a deadline.
    
    Parameters:
    
    timeValue - time value to add to timeMillis.
    
    Returns:
    
    a deadline representing the current time plus the given time value.
  - 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
  - format
```
public String format(TimeUnit overdueTimeUnit)
```
    Formats this deadline.
    
    Parameters:
    
    overdueTimeUnit - the time unit to show how much over the deadline we are.
    
    Returns:
    
    a formatted string.
  - formatTarget
```
public String formatTarget()
```
    Formats the deadline value as a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
    
    Returns:
    
    a formatted string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
  - freeze
```
public Deadline freeze()
```
  - fromUnixMilliseconds
```
public static Deadline fromUnixMilliseconds(long value)
```
    Creates a deadline from a UNIX time in milliseconds.
    
    Parameters:
    
    value - a UNIX time in milliseconds.
    
    Returns:
    
    a new deadline.
  - getValue
```
public long getValue()
```
    Gets the UNIX time deadline value.
    
    Returns:
    
    the UNIX time deadline value.
  - 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)
  - isBefore
```
public boolean isBefore(long millis)
```
    Returns whether this deadline occurs before the given time in milliseconds.
    
    Parameters:
    
    millis - the time to compare.
    
    Returns:
    
    whether this deadline occurs before the given time in milliseconds.
  - isExpired
```
public boolean isExpired()
```
    Returns whether the deadline has expired.
    
    Returns:
    
    whether the deadline has expired.
  - isMax
```
public boolean isMax()
```
    Returns whether this deadline is the maximum deadline.
    
    Returns:
    
    whether this deadline is the maximum deadline.
  - isMin
```
public boolean isMin()
```
    Returns whether this deadline is the minimum deadline.
    
    Returns:
    
    whether this deadline is the minimum deadline.
  - isNotExpired
```
public boolean isNotExpired()
```
    Returns whether this deadline has not expired.
    
    Returns:
    
    whether this deadline has not expired.
  - min
```
public Deadline min(Deadline other)
```
    Returns the smaller of this and another Deadline.
    
    Parameters:
    
    other - another deadline.
    
    Returns:
    
    the smaller of this and other.
  - parse
```
public static Deadline parse(String source)
                      throws java.text.ParseException
```
    Creates a deadline from a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
    
    Parameters:
    
    source - a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
    
    Returns:
    
    a deadline from a string in the format "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ".
    
    Throws:
    
    java.text.ParseException - if the specified source string cannot be parsed.
  - remaining
```
public long remaining()
```
    Returns the difference in milliseconds between the deadline and now.
    
    Returns:
    
    the different in milliseconds between the deadline and now.
  - remainingTimeValue
```
public TimeValue remainingTimeValue()
```
    Returns the difference as a TimeValue between the deadline and now.
    
    Returns:
    
    Returns the different as a TimeValue between the deadline and now.
  - 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.

Class Deadline

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATE_FORMAT

MAX_VALUE

MIN_VALUE

Method Detail

calculate

calculate

equals

format

formatTarget

freeze

fromUnixMilliseconds

getValue

hashCode

isBefore

isExpired

isMax

isMin

isNotExpired

min

parse

remaining

remainingTimeValue

toString