dagger.producers

Enum CancellationPolicy.Propagation

java.lang.Object

java.lang.Enum<CancellationPolicy.Propagation>

dagger.producers.CancellationPolicy.Propagation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CancellationPolicy.Propagation>

Enclosing class:

CancellationPolicy

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

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static CancellationPolicy.Propagation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CancellationPolicy.Propagation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static CancellationPolicy.Propagation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CancellationPolicy.Propagation c : CancellationPolicy.Propagation.values())
    System.out.println(c);

Returns:

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

valueOf

public static CancellationPolicy.Propagation valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null