@Documented
@Target(value=TYPE)
@Retention(value=CLASS)
@Beta
public @interface CancellationPolicy
When a future returned from an entry point on a production component is cancelled, the component is cancelled: all producers in the component (including those for other entry points) are cancelled.
When a child component is cancelled, its parent component is not cancelled unless the
parent component is annotated with @CancellationPolicy(fromSubcomponents = PROPAGATE)
. If
that parent component has a parent (the grandparent of the cancelled child component), it will
not be cancelled unless it also has a @CancellationPolicy
annotation allowing
cancellation to propagate to it from subcomponents.
Modifier and Type | Required Element and Description |
---|---|
CancellationPolicy.Propagation |
fromSubcomponents
Defines whether the annotated production component is cancelled when a child component is
cancelled.
|
public abstract CancellationPolicy.Propagation fromSubcomponents
The default, if no cancellation policy annotation is provided, is CancellationPolicy.Propagation.IGNORE
.