Package dagger.producers

Enum Class CancellationPolicy.Propagation

java.lang.Object

java.lang.Enum<CancellationPolicy.Propagation>

dagger.producers.CancellationPolicy.Propagation

All Implemented Interfaces:

Serializable, Comparable<CancellationPolicy.Propagation>, Constable

Enclosing class:

CancellationPolicy

public static enum CancellationPolicy.Propagation
extends Enum<CancellationPolicy.Propagation>

Enumeration of the options for what happens to a parent component when one of its child components is cancelled.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE	Do not cancel the annotated component when a child component is cancelled.
PROPAGATE	Cancel the annotated component when a child component is cancelled.

Method Summary

Modifier and Type	Method	Description
static CancellationPolicy.Propagation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CancellationPolicy.Propagation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROPAGATE

public static final CancellationPolicy.Propagation PROPAGATE

Cancel the annotated component when a child component is cancelled.

IGNORE

public static final CancellationPolicy.Propagation IGNORE

Do not cancel the annotated component when a child component is cancelled.

Method Details

values

public static CancellationPolicy.Propagation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CancellationPolicy.Propagation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null