Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.util.TimeValue

Modifier and Type	Field and Description
private final long	duration
pack-priv static final int	INT_UNDEFINED
public static final TimeValue	MAX_VALUE A constant holding the maximum value a `TimeValue` can have: `Long.MAX_VALUE` days.
public static final TimeValue	NEG_ONE_MILLISECOND A negative one millisecond `TimeValue`.
public static final TimeValue	NEG_ONE_SECOND A negative one second `TimeValue`.
private final TimeUnit	timeUnit
public static final TimeValue	ZERO_MILLISECONDS A zero milliseconds `TimeValue`.

Access	Constructor and Description
pack-priv	TimeValue(final long duration, final TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
public static int	Returns: an int value bound within `Integer#MIN_VALUE` and `Integer#MAX_VALUE`. asBoundInt(final long a long value to convert 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`.
public int	compareTo(final TimeValue the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public long	convert(final TimeUnit targetTimeUnit)
public static <T extends TimeValue> T	Returns: `timeValue` or `defaultValue` defaultsTo(final T may be `null` timeValue, final T may be `null` defaultValue) Returns the given `timeValue` if it is not `null`, if `null` then returns the given `defaultValue`.
public static TimeValue	Returns: `timeValue` or `NEG_ONE_SECOND` defaultsToNegativeOneMillisecond(final TimeValue may be `null` timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`.
public static TimeValue	Returns: `timeValue` or `NEG_ONE_SECOND` defaultsToNegativeOneSecond(final TimeValue may be `null` timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`.
public static TimeValue	Returns: `timeValue` or `ZERO_MILLISECONDS` defaultsToZeroMilliseconds(final TimeValue may be `null` timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `ZERO_MILLISECONDS`.
public TimeValue	Returns: `this / divisor` divide(final long value by which this TimeValue is to be divided. divisor) Returns a TimeValue whose value is `(this / divisor)`.
public TimeValue	Returns: `this / divisor` divide(final long value by which this TimeValue is to be divided. divisor, final TimeUnit the target TimeUnit targetTimeUnit) Returns a TimeValue whose value is `(this / divisor)`.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public long	getDuration()
public TimeUnit	getTimeUnit()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static boolean	isNonNegative(final TimeValue timeValue)
public static boolean	isPositive(final TimeValue timeValue)
public TimeValue	min(final TimeValue other)
private TimeUnit	min(final TimeUnit other)
public static TimeValue	Returns: a Timeout. of(final long the time duration in the given `timeUnit`. duration, final TimeUnit the time unit for the given duration. timeUnit) Creates a TimeValue.
public static TimeValue	Returns: a Timeout of(final Duration the time duration. duration) Creates a TimeValue from a Duration.
public static TimeValue	ofDays(final long days)
public static TimeValue	ofHours(final long hours)
public static TimeValue	ofMicroseconds(final long microseconds)
public static TimeValue	ofMilliseconds(final long millis)
public static TimeValue	ofMinutes(final long minutes)
public static TimeValue	ofNanoseconds(final long nanoseconds)
public static TimeValue	ofSeconds(final long seconds)
public static TimeValue	Returns: a new TimeValue parse(final String the TimeValue to parse value) Parses a TimeValue in the format `<Long><SPACE><TimeUnit>`, for example `"1200 MILLISECONDS"`.
private int	scale()
private int	Returns: a number from 1 to 7, where 1 is NANOSECONDS and 7 DAYS. scale(final TimeUnit a TimeUnit tUnit) Returns a made up scale for TimeUnits.
public void	sleep()
public void	timedJoin(final Thread thread)
public void	timedWait(final Object obj)
pack-priv static ChronoUnit	Returns: the converted equivalent ChronoUnit toChronoUnit(final TimeUnit timeUnit) Converts a `TimeUnit` to the equivalent `ChronoUnit`.
public long	toDays()
public Duration	Returns: a Duration. toDuration() Converts this instance of to a Duration.
public long	toHours()
public long	toMicroseconds()
public long	toMilliseconds()
public int	toMillisecondsIntBound()
public long	toMinutes()
public long	toNanoseconds()
public long	toSeconds()
public int	toSecondsIntBound()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Timeout	toTimeout()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

duration	back to summary
private final long duration

INT_UNDEFINED	back to summary
pack-priv static final int INT_UNDEFINED

MAX_VALUE	back to summary
public static final TimeValue MAX_VALUE A constant holding the maximum value a `TimeValue` can have: `Long.MAX_VALUE` days.

NEG_ONE_MILLISECOND	back to summary
public static final TimeValue NEG_ONE_MILLISECOND A negative one millisecond `TimeValue`.

NEG_ONE_SECOND	back to summary
public static final TimeValue NEG_ONE_SECOND A negative one second `TimeValue`.

timeUnit	back to summary
private final TimeUnit timeUnit

ZERO_MILLISECONDS	back to summary
public static final TimeValue ZERO_MILLISECONDS A zero milliseconds `TimeValue`.

TimeValue	back to summary
pack-priv TimeValue(final long duration, final TimeUnit timeUnit)

Method Detail

asBoundInt back to summary

asBoundInt	back to summary
public static int asBoundInt(final 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:long a long value to convert Returns:int an int value bound within `Integer#MIN_VALUE` and `Integer#MAX_VALUE`.

public static int asBoundInt(final 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:long: a long value to convert

Returns:int

an int value bound within Integer#MIN_VALUE and Integer#MAX_VALUE.

compareTo back to summary

compareTo	back to summary
public int compareTo(final TimeValue other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. 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 `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `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 `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:TimeValue the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(final TimeValue other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

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 signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if 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 signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:TimeValue: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

convert	back to summary
public long convert(final TimeUnit targetTimeUnit)

defaultsTo back to summary

defaultsTo	back to summary
public static <T extends TimeValue> T defaultsTo(final T timeValue, final T defaultValue) Returns the given `timeValue` if it is not `null`, if `null` then returns the given `defaultValue`. Parameters timeValue:T may be `null` defaultValue:T may be `null` Returns:T `timeValue` or `defaultValue`

public static <T extends TimeValue> T defaultsTo(final T timeValue, final T defaultValue)

Returns the given timeValue if it is not null, if null then returns the given defaultValue.

Parameters

timeValue:T: may be null
defaultValue:T: may be null

Returns:T

timeValue or defaultValue

defaultsToNegativeOneMillisecond back to summary

defaultsToNegativeOneMillisecond	back to summary
public static TimeValue defaultsToNegativeOneMillisecond(final TimeValue timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`. Parameters timeValue:TimeValue may be `null` Returns:TimeValue `timeValue` or `NEG_ONE_SECOND`

public static TimeValue defaultsToNegativeOneMillisecond(final TimeValue timeValue)

Returns the given timeValue if it is not null, if null then returns NEG_ONE_SECOND.

Parameters

timeValue:TimeValue: may be null

Returns:TimeValue

timeValue or NEG_ONE_SECOND

defaultsToNegativeOneSecond back to summary

defaultsToNegativeOneSecond	back to summary
public static TimeValue defaultsToNegativeOneSecond(final TimeValue timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `NEG_ONE_SECOND`. Parameters timeValue:TimeValue may be `null` Returns:TimeValue `timeValue` or `NEG_ONE_SECOND`

public static TimeValue defaultsToNegativeOneSecond(final TimeValue timeValue)

Returns the given timeValue if it is not null, if null then returns NEG_ONE_SECOND.

Parameters

timeValue:TimeValue: may be null

Returns:TimeValue

timeValue or NEG_ONE_SECOND

defaultsToZeroMilliseconds back to summary

defaultsToZeroMilliseconds	back to summary
public static TimeValue defaultsToZeroMilliseconds(final TimeValue timeValue) Returns the given `timeValue` if it is not `null`, if `null` then returns `ZERO_MILLISECONDS`. Parameters timeValue:TimeValue may be `null` Returns:TimeValue `timeValue` or `ZERO_MILLISECONDS`

public static TimeValue defaultsToZeroMilliseconds(final TimeValue timeValue)

Returns the given timeValue if it is not null, if null then returns ZERO_MILLISECONDS.

Parameters

timeValue:TimeValue: may be null

Returns:TimeValue

timeValue or ZERO_MILLISECONDS

divide back to summary

divide	back to summary
public TimeValue divide(final long divisor) Returns a TimeValue whose value is `(this / divisor)`. Parameters divisor:long value by which this TimeValue is to be divided. Returns:TimeValue `this / divisor` Exceptions ArithmeticException: if `divisor` is zero.

public TimeValue divide(final long divisor)

Returns a TimeValue whose value is (this / divisor).

Parameters

divisor:long: value by which this TimeValue is to be divided.

Returns:TimeValue

this / divisor

Exceptions

ArithmeticException:: if divisor is zero.

divide back to summary

divide	back to summary
public TimeValue divide(final long divisor, final TimeUnit targetTimeUnit) Returns a TimeValue whose value is `(this / divisor)`. Parameters divisor:long value by which this TimeValue is to be divided. targetTimeUnit:TimeUnit the target TimeUnit Returns:TimeValue `this / divisor` Exceptions ArithmeticException: if `divisor` is zero.

public TimeValue divide(final long divisor, final TimeUnit targetTimeUnit)

Returns a TimeValue whose value is (this / divisor).

Parameters

divisor:long: value by which this TimeValue is to be divided.
targetTimeUnit:TimeUnit: the target TimeUnit

Returns:TimeValue

this / divisor

Exceptions

ArithmeticException:: if divisor is zero.

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. 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`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getDuration	back to summary
public long getDuration()

getTimeUnit	back to summary
public TimeUnit getTimeUnit()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.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` 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 `equals` 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. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 equals 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.

Returns:int

a hash code value for this object.

Annotations

@Override

isNonNegative	back to summary
public static boolean isNonNegative(final TimeValue timeValue)

isPositive	back to summary
public static boolean isPositive(final TimeValue timeValue)

min	back to summary
public TimeValue min(final TimeValue other)

min	back to summary
private TimeUnit min(final TimeUnit other)

of back to summary

of	back to summary
public static TimeValue of(final long duration, final TimeUnit timeUnit) Creates a TimeValue. Parameters duration:long the time duration in the given `timeUnit`. timeUnit:TimeUnit the time unit for the given duration. Returns:TimeValue a Timeout.

public static TimeValue of(final long duration, final TimeUnit timeUnit)

Creates a TimeValue.

Parameters

duration:long: the time duration in the given timeUnit.
timeUnit:TimeUnit: the time unit for the given duration.

Returns:TimeValue

a Timeout.

of	back to summary
public static TimeValue of(final Duration duration) Creates a TimeValue from a Duration. Parameters duration:Duration the time duration. Returns:TimeValue a Timeout Since 5.2

back to summary

public static TimeValue of(final Duration duration)

Creates a TimeValue from a Duration.

Parameters

duration:Duration: the time duration.

Returns:TimeValue

a Timeout

Since

5.2

ofDays	back to summary
public static TimeValue ofDays(final long days)

ofHours	back to summary
public static TimeValue ofHours(final long hours)

ofMicroseconds	back to summary
public static TimeValue ofMicroseconds(final long microseconds)

ofMilliseconds	back to summary
public static TimeValue ofMilliseconds(final long millis)

ofMinutes	back to summary
public static TimeValue ofMinutes(final long minutes)

ofNanoseconds	back to summary
public static TimeValue ofNanoseconds(final long nanoseconds)

ofSeconds	back to summary
public static TimeValue ofSeconds(final long seconds)

parse back to summary

parse	back to summary
public static TimeValue parse(final String value) throws 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:String the TimeValue to parse Returns:TimeValue a new TimeValue Exceptions ParseException: if the number cannot be parsed

public static TimeValue parse(final String value) throws 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:String: the TimeValue to parse

Returns:TimeValue

a new TimeValue

Exceptions

ParseException:: if the number cannot be parsed

scale	back to summary
private int scale()

scale	back to summary
private int scale(final TimeUnit tUnit) Returns a made up scale for TimeUnits. Parameters tUnit:TimeUnit a TimeUnit Returns:int a number from 1 to 7, where 1 is NANOSECONDS and 7 DAYS.

scale

back to summary

private int scale(final TimeUnit tUnit)

Returns a made up scale for TimeUnits.

Parameters

tUnit:TimeUnit: a TimeUnit

Returns:int

a number from 1 to 7, where 1 is NANOSECONDS and 7 DAYS.

sleep	back to summary
public void sleep() throws InterruptedException

timedJoin	back to summary
public void timedJoin(final Thread thread) throws InterruptedException

timedWait	back to summary
public void timedWait(final Object obj) throws InterruptedException

toChronoUnit back to summary

toChronoUnit	back to summary
pack-priv static ChronoUnit toChronoUnit(final TimeUnit timeUnit) Converts a `TimeUnit` to the equivalent `ChronoUnit`. Returns:ChronoUnit the converted equivalent ChronoUnit

pack-priv static ChronoUnit toChronoUnit(final TimeUnit timeUnit)

Converts a TimeUnit to the equivalent ChronoUnit.

Returns:ChronoUnit: the converted equivalent ChronoUnit

toDays	back to summary
public long toDays()

toDuration	back to summary
public Duration toDuration() Converts this instance of to a Duration. Returns:Duration a Duration. Since 5.2

toDuration

back to summary

public Duration toDuration()

Converts this instance of to a Duration.

Returns:Duration: a Duration.
Since: 5.2

toHours	back to summary
public long toHours()

toMicroseconds	back to summary
public long toMicroseconds()

toMilliseconds	back to summary
public long toMilliseconds()

toMillisecondsIntBound	back to summary
public int toMillisecondsIntBound()

toMinutes	back to summary
public long toMinutes()

toNanoseconds	back to summary
public long toNanoseconds()

toSeconds	back to summary
public long toSeconds()

toSecondsIntBound	back to summary
public int toSecondsIntBound()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

toTimeout	back to summary
public Timeout toTimeout()

public Class TimeValue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail