Modifier and Type	Class and Description
public static class	Operations.CompletedFuture< operation result representation. T> This class represents a `Future` in the completed state with a fixed result.

Modifier and Type	Field and Description
private static final Cancellable	NOOP_CANCELLABLE

Access	Constructor and Description
public	Operations()

Modifier and Type	Method and Description
public static Cancellable	Returns: the cancellable operation handle. cancellable(final Future<?> the result future future) Creates a `Cancellable` operation handle for an ongoing process or operation represented by a `Future`.
public static Cancellable	Returns: the no-op cancellable operation handle. nonCancellable() Creates a `Cancellable` operation handle for an ongoing process or operation that cannot be cancelled.

NOOP_CANCELLABLE	back to summary
private static final Cancellable NOOP_CANCELLABLE

Operations	back to summary
public Operations()

cancellable	back to summary
public static Cancellable cancellable(final Future<?> future) Creates a `Cancellable` operation handle for an ongoing process or operation represented by a `Future`. Parameters future:Future<?> the result future Returns:Cancellable the cancellable operation handle.

nonCancellable	back to summary
public static Cancellable nonCancellable() Creates a `Cancellable` operation handle for an ongoing process or operation that cannot be cancelled. Attempts to cancel the operation with this handle will have no effect. Returns:Cancellable the no-op cancellable operation handle.

org.apache.hc.client5.http.impl back to summary

public Class Operations.CompletedFuture<T>

Class Inheritance

extends Object
implements Future<T>

java.lang.Object
org.apache.hc.client5.http.impl.Operations.CompletedFuture

All Implemented Interfaces

java.util.concurrent.Future

Type Parameters

<T>: operation result representation.

This class represents a Future in the completed state with a fixed result. The outcome of the future cannot be altered and it cannot be cancelled.

Field Summary

Modifier and Type	Field and Description
private final T	result

Constructor Summary

Access	Constructor and Description
public	CompletedFuture(final T result)

Method Summary

Modifier and Type	Method and Description
public boolean	cancel(final boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public T	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public T	get(final long the maximum time to wait timeout, final TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.

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

Field Detail

result	back to summary
private final T result

Constructor Detail

CompletedFuture	back to summary
public CompletedFuture(final T result)

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel(final boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Parameters mayInterruptIfRunning:boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete Returns:boolean `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override

public boolean cancel(final boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters

mayInterruptIfRunning:boolean: true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override

get	back to summary
public T get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:T the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public T get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:T

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception

get	back to summary
public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:T the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out

get

back to summary

public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:T

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

public final Class Operations

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Operations.CompletedFuture<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail