Package org.apache.hc.core5.util
Class Timeout
- java.lang.Object
-
- org.apache.hc.core5.util.TimeValue
-
- org.apache.hc.core5.util.Timeout
-
-
Field Summary
Fields Modifier and Type Field Description static Timeout
DISABLED
A disabled timeout represented as 0MILLISECONDS
.static Timeout
ONE_MILLISECOND
A one millisecondsTimeout
.static Timeout
ZERO_MILLISECONDS
A zero millisecondsTimeout
.-
Fields inherited from class org.apache.hc.core5.util.TimeValue
INT_UNDEFINED, MAX_VALUE, NEG_ONE_MILLISECOND, NEG_ONE_SECOND
-
-
Constructor Summary
Constructors Constructor Description Timeout(long duration, java.util.concurrent.TimeUnit timeUnit)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Timeout
defaultsToDisabled(Timeout timeout)
boolean
isDisabled()
Whether this timeout is disabled.boolean
isEnabled()
Whether this timeout is enabled.static Timeout
of(long duration, java.util.concurrent.TimeUnit timeUnit)
Creates a Timeout.static Timeout
of(java.time.Duration duration)
Creates a Timeout from a Duration.static Timeout
ofDays(long days)
Creates a Timeout.static Timeout
ofHours(long hours)
Creates a Timeout.static Timeout
ofMicroseconds(long microseconds)
Creates a Timeout.static Timeout
ofMilliseconds(long milliseconds)
Creates a Timeout.static Timeout
ofMinutes(long minutes)
Creates a Timeout.static Timeout
ofNanoseconds(long nanoseconds)
Creates a Timeout.static Timeout
ofSeconds(long seconds)
Creates a Timeout.static Timeout
parse(java.lang.String value)
Parses a Timeout in the format<Integer><SPACE><TimeUnit>
, for example"1,200 MILLISECONDS"
-
Methods inherited from class org.apache.hc.core5.util.TimeValue
asBoundInt, compareTo, convert, defaultsTo, defaultsToNegativeOneMillisecond, defaultsToNegativeOneSecond, defaultsToZeroMilliseconds, divide, divide, equals, getDuration, getTimeUnit, hashCode, isNonNegative, isPositive, min, sleep, timedJoin, timedWait, toChronoUnit, toDays, toDuration, toHours, toMicroseconds, toMilliseconds, toMillisecondsIntBound, toMinutes, toNanoseconds, toSeconds, toSecondsIntBound, toString, toTimeout
-
-
-
-
Method Detail
-
defaultsToDisabled
public static Timeout defaultsToDisabled(Timeout timeout)
- Parameters:
timeout
- may benull
- Returns:
timeValue
orDISABLED
-
of
public static Timeout of(java.time.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, java.util.concurrent.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 giventimeUnit
.- Returns:
- a Timeout
-
ofHours
public static Timeout ofHours(long hours)
Creates a Timeout.- Parameters:
hours
- the duration in hours and the giventimeUnit
.- Returns:
- a Timeout
-
ofMicroseconds
public static Timeout ofMicroseconds(long microseconds)
Creates a Timeout.- Parameters:
microseconds
- the duration in seconds and the giventimeUnit
.- Returns:
- a Timeout
-
ofMilliseconds
public static Timeout ofMilliseconds(long milliseconds)
Creates a Timeout.- Parameters:
milliseconds
- the duration in milliseconds and the giventimeUnit
.- Returns:
- a Timeout
-
ofMinutes
public static Timeout ofMinutes(long minutes)
Creates a Timeout.- Parameters:
minutes
- the duration in minutes and the giventimeUnit
.- Returns:
- a Timeout
-
ofNanoseconds
public static Timeout ofNanoseconds(long nanoseconds)
Creates a Timeout.- Parameters:
nanoseconds
- the duration in seconds and the giventimeUnit
.- Returns:
- a Timeout
-
ofSeconds
public static Timeout ofSeconds(long seconds)
Creates a Timeout.- Parameters:
seconds
- the duration in seconds and the giventimeUnit
.- Returns:
- a Timeout
-
parse
public static Timeout parse(java.lang.String value) throws java.text.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:
java.text.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.
-
-