Grizzly NIO 5.0.2 · org.glassfish.grizzly.impl.ReadyFutureImpl

Modifier and Type	Field and Description
private static final ThreadCache.CachedTypeIndex<ReadyFutureImpl<R>>	CACHE_IDX
private Throwable	failure
private boolean	isCancelled
protected R	result

Access	Constructor and Description
private	ReadyFutureImpl() Construct cancelled `Future`.
private	ReadyFutureImpl(R result) Construct `Future` with the result.
private	ReadyFutureImpl(Throwable failure) Construct failed `Future`.
private	ReadyFutureImpl(R result, Throwable failure, boolean isCancelled)

Method Summary

Modifier and Type	Method and Description
public void	addCompletionHandler(final CompletionHandler<R> completionHandler) Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Adds a `CompletionHandler`, which will be notified once the asynchronous computation, represented by this `Future`, is complete.
public boolean	Returns: cancel state, which was set during construction. cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Do nothing.
public static <R> ReadyFutureImpl<R>	create() Construct cancelled `Future`.
public static <R> ReadyFutureImpl<R>	create(R result) Construct `Future` with the result.
public static <R> ReadyFutureImpl<R>	create(Throwable failure) Construct failed `Future`.
public void	failure(Throwable failure) Implements org.glassfish.grizzly.impl.FutureImpl.failure. Should not be called for `ReadyFutureImpl`
public R	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public R	get(long timeout, TimeUnit 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 R	Returns: current result value without any blocking. getResult() Implements org.glassfish.grizzly.impl.FutureImpl.getResult. Get current result value without any blocking.
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.
public void	markForRecycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Mark `GrizzlyFuture` as recyclable, so once result will come - `GrizzlyFuture` object will be recycled and returned to a thread local object pool.
public void	recycle() Implements org.glassfish.grizzly.Cacheable.recycle.
public void	recycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.recycle. Recycle `GrizzlyFuture` now.
private void	reset()
public void	result(R result) Implements org.glassfish.grizzly.impl.FutureImpl.result. Set the result value and notify about operation completion.
public void	setResult(R result) Should not be called for `ReadyFutureImpl`
private static <R> ReadyFutureImpl<R>	takeFromCache()

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

CACHE_IDX	back to summary
private static final ThreadCache.CachedTypeIndex<ReadyFutureImpl<R>> CACHE_IDX

failure	back to summary
private Throwable failure

isCancelled	back to summary
private boolean isCancelled

result	back to summary
protected R result

ReadyFutureImpl	back to summary
private ReadyFutureImpl() Construct cancelled `Future`.

ReadyFutureImpl	back to summary
private ReadyFutureImpl(R result) Construct `Future` with the result.

ReadyFutureImpl	back to summary
private ReadyFutureImpl(Throwable failure) Construct failed `Future`.

ReadyFutureImpl	back to summary
private ReadyFutureImpl(R result, Throwable failure, boolean isCancelled)

Method Detail

addCompletionHandler back to summary

addCompletionHandler	back to summary
public void addCompletionHandler(final CompletionHandler<R> completionHandler) Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Doc from org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Adds a `CompletionHandler`, which will be notified once the asynchronous computation, represented by this `Future`, is complete. Annotations @Override

public void addCompletionHandler(final CompletionHandler<R> completionHandler)

Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler.

Doc from org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler.

Adds a CompletionHandler, which will be notified once the asynchronous computation, represented by this Future, is complete.

Annotations

@Override

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Do nothing. Returns:boolean cancel state, which was set during construction. Annotations @Override

cancel

back to summary

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Do nothing.

Returns:boolean

cancel state, which was set during construction.

Annotations

@Override

create	back to summary
public static <R> ReadyFutureImpl<R> create() Construct cancelled `Future`.

create	back to summary
public static <R> ReadyFutureImpl<R> create(R result) Construct `Future` with the result.

create	back to summary
public static <R> ReadyFutureImpl<R> create(Throwable failure) Construct failed `Future`.

failure back to summary

failure	back to summary
public void failure(Throwable failure) Implements org.glassfish.grizzly.impl.FutureImpl.failure. Should not be called for `ReadyFutureImpl` Annotations @Override

public void failure(Throwable failure)

Implements org.glassfish.grizzly.impl.FutureImpl.failure.

Should not be called for ReadyFutureImpl

Annotations

@Override

get	back to summary
public R 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. Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public R 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.

Annotations

@Override

Exceptions

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

get	back to summary
public R get(long timeout, 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. 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 R get(long timeout, 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.

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

getResult	back to summary
public R getResult() Implements org.glassfish.grizzly.impl.FutureImpl.getResult. Get current result value without any blocking. Returns:R current result value without any blocking. Annotations @Override

getResult

back to summary

public R getResult()

Implements org.glassfish.grizzly.impl.FutureImpl.getResult.

Get current result value without any blocking.

Returns:R

current result value without any blocking.

Annotations

@Override

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. 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.

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`. 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.

Annotations

@Override

markForRecycle back to summary

markForRecycle	back to summary
public void markForRecycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Doc from org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Mark `GrizzlyFuture` as recyclable, so once result will come - `GrizzlyFuture` object will be recycled and returned to a thread local object pool. You can consider to use this method, if you're not interested in using this `GrizzlyFuture` object. Annotations @Override

public void markForRecycle(boolean recycleResult)

Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle.

Doc from org.glassfish.grizzly.GrizzlyFuture.markForRecycle.

Mark GrizzlyFuture as recyclable, so once result will come - GrizzlyFuture object will be recycled and returned to a thread local object pool. You can consider to use this method, if you're not interested in using this GrizzlyFuture object.

Annotations

@Override

recycle	back to summary
public void recycle() Implements org.glassfish.grizzly.Cacheable.recycle. Annotations @Override

recycle

back to summary

public void recycle()

Implements org.glassfish.grizzly.Cacheable.recycle.

Annotations

@Override

recycle back to summary

recycle	back to summary
public void recycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.recycle. Doc from org.glassfish.grizzly.GrizzlyFuture.recycle. Recycle `GrizzlyFuture` now. This method could be used, if you're not interested in using this `GrizzlyFuture` object, and you're sure this object is not used by any other application part. Annotations @Override

public void recycle(boolean recycleResult)

Implements org.glassfish.grizzly.GrizzlyFuture.recycle.

Doc from org.glassfish.grizzly.GrizzlyFuture.recycle.

Recycle GrizzlyFuture now. This method could be used, if you're not interested in using this GrizzlyFuture object, and you're sure this object is not used by any other application part.

Annotations

@Override

reset	back to summary
private void reset()

result	back to summary
public void result(R result) Implements org.glassfish.grizzly.impl.FutureImpl.result. Doc from org.glassfish.grizzly.impl.FutureImpl.result. Set the result value and notify about operation completion. Annotations @Override

result

back to summary

public void result(R result)

Implements org.glassfish.grizzly.impl.FutureImpl.result.

Doc from org.glassfish.grizzly.impl.FutureImpl.result.

Set the result value and notify about operation completion.

Annotations

@Override

setResult	back to summary
public void setResult(R result) Should not be called for `ReadyFutureImpl`

takeFromCache	back to summary
private static <R> ReadyFutureImpl<R> takeFromCache() Annotations @SuppressWarnings:unchecked

public final Class ReadyFutureImpl<R>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail