ParallelMergeCombiningSequence.CancellationFuture (druid-processing 32.0.0 API)

java.lang.Object
- com.google.common.util.concurrent.internal.InternalFutureFailureAccess
- - com.google.common.util.concurrent.AbstractFuture<Boolean>
  - - org.apache.druid.java.util.common.guava.ParallelMergeCombiningSequence.CancellationFuture

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<Boolean>, Future<Boolean>

Enclosing class:

ParallelMergeCombiningSequence<T>
```
public static class ParallelMergeCombiningSequence.CancellationFuture
extends com.google.common.util.concurrent.AbstractFuture<Boolean>
```
ListenableFuture that allows ParallelMergeCombiningSequence to be registered with QueryWatcher.registerQueryFuture(org.apache.druid.query.Query<?>, com.google.common.util.concurrent.ListenableFuture<?>) to participate in query cancellation or anything else that has a need to watch the activity on the merge pool. Wraps a ParallelMergeCombiningSequence.CancellationGizmo to allow for external threads to signal cancellation of parallel processing on the pool by triggering ParallelMergeCombiningSequence.CancellationGizmo.cancel(Throwable) whenever cancel(boolean) is called. This is not used internally by workers on the pool in favor of using the much simpler ParallelMergeCombiningSequence.CancellationGizmo directly instead.

Constructor Summary

Constructors
Constructor Description

CancellationFuture(ParallelMergeCombiningSequence.CancellationGizmo cancellationGizmo)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`cancel(boolean mayInterruptIfRunning)`
`ParallelMergeCombiningSequence.CancellationGizmo`	`getCancellationGizmo()`
`boolean`	`set(Boolean value)`
`boolean`	`setException(Throwable throwable)`

Methods inherited from class com.google.common.util.concurrent.AbstractFuture
addListener, afterDone, get, get, interruptTask, isCancelled, isDone, pendingToString, setFuture, toString, tryInternalFastPathGetFailure, wasInterrupted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CancellationFuture
```
public CancellationFuture(ParallelMergeCombiningSequence.CancellationGizmo cancellationGizmo)
```
- Method Detail
  - getCancellationGizmo
```
public ParallelMergeCombiningSequence.CancellationGizmo getCancellationGizmo()
```
  - set
```
public boolean set(Boolean value)
```
    Overrides:
    
    set in class com.google.common.util.concurrent.AbstractFuture<Boolean>
  - setException
```
public boolean setException(Throwable throwable)
```
    Overrides:
    
    setException in class com.google.common.util.concurrent.AbstractFuture<Boolean>
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    Specified by:
    
    cancel in interface Future<Boolean>
    
    Overrides:
    
    cancel in class com.google.common.util.concurrent.AbstractFuture<Boolean>