Package org.apache.hc.core5.util

Class Timeout

java.lang.Object
org.apache.hc.core5.util.TimeValue
org.apache.hc.core5.util.Timeout
All Implemented Interfaces:
Comparable<TimeValue>
@Contract(threading=IMMUTABLE) public class Timeout extends TimeValue
Represents a timeout value as a non-negative long time and TimeUnit.
Since:
5.0

  • Field Details

    • ZERO_MILLISECONDS

      public static final Timeout ZERO_MILLISECONDS
      A zero milliseconds Timeout.

    • ONE_MILLISECOND

      public static final Timeout ONE_MILLISECOND
      A one milliseconds Timeout.

    • DISABLED

      public static final Timeout DISABLED
      A disabled timeout represented as 0 MILLISECONDS.

  • Constructor Details

    • Timeout

      Timeout(long duration, TimeUnit timeUnit)

  • Method Details

    • defaultsToDisabled

      public static Timeout defaultsToDisabled(Timeout timeout)
      Returns the given timeout if it is not null, if null then returns DISABLED.
      Parameters:
      timeout - may be null
      Returns:
      timeValue or DISABLED

    • of

      public static Timeout of(Duration duration)
      Creates a Timeout from a Duration.
      Parameters:
      duration - the time duration.
      Returns:
      a Timeout.
      Since:
      5.2

    • of

      public static Timeout of(long duration, TimeUnit timeUnit)
      Creates a Timeout.
      Parameters:
      duration - the time duration.
      timeUnit - the time unit for the given duration.
      Returns:
      a Timeout

    • ofDays

      public static Timeout ofDays(long days)
      Creates a Timeout.
      Parameters:
      days - the duration in days and the given timeUnit.
      Returns:
      a Timeout

    • ofHours

      public static Timeout ofHours(long hours)
      Creates a Timeout.
      Parameters:
      hours - the duration in hours and the given timeUnit.
      Returns:
      a Timeout

    • ofMicroseconds

      public static Timeout ofMicroseconds(long microseconds)
      Creates a Timeout.
      Parameters:
      microseconds - the duration in seconds and the given timeUnit.
      Returns:
      a Timeout

    • ofMilliseconds

      public static Timeout ofMilliseconds(long milliseconds)
      Creates a Timeout.
      Parameters:
      milliseconds - the duration in milliseconds and the given timeUnit.
      Returns:
      a Timeout

    • ofMinutes

      public static Timeout ofMinutes(long minutes)
      Creates a Timeout.
      Parameters:
      minutes - the duration in minutes and the given timeUnit.
      Returns:
      a Timeout

    • ofNanoseconds

      public static Timeout ofNanoseconds(long nanoseconds)
      Creates a Timeout.
      Parameters:
      nanoseconds - the duration in seconds and the given timeUnit.
      Returns:
      a Timeout

    • ofSeconds

      public static Timeout ofSeconds(long seconds)
      Creates a Timeout.
      Parameters:
      seconds - the duration in seconds and the given timeUnit.
      Returns:
      a Timeout

    • parse

      public static Timeout parse(String value) throws ParseException
      Parses a Timeout in the format <Integer><SPACE><TimeUnit>, for example "1,200 MILLISECONDS"
      Parameters:
      value - the TimeValue to parse
      Returns:
      a new TimeValue
      Throws:
      ParseException - if the number cannot be parsed

    • isDisabled

      public boolean isDisabled()
      Whether this timeout is disabled.
      Returns:
      Whether this timeout is disabled.

    • isEnabled

      public boolean isEnabled()
      Whether this timeout is enabled.
      Returns:
      Whether this timeout is disabled.