Package org.checkerframework.checker.nullness

Enum Class KeyForPropagator.PropagationDirection

java.lang.Object

java.lang.Enum<KeyForPropagator.PropagationDirection>

org.checkerframework.checker.nullness.KeyForPropagator.PropagationDirection

All Implemented Interfaces:

Serializable, Comparable<KeyForPropagator.PropagationDirection>, Constable

Enclosing class:

KeyForPropagator

public static enum KeyForPropagator.PropagationDirection
extends Enum<KeyForPropagator.PropagationDirection>

The direction of propagation.

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
BOTH	first execute TO_SUBTYPE then TO_SUPERTYPE.
TO_SUBTYPE	Transfer FROM the supertype to the subtype.
TO_SUPERTYPE	Transfer FROM the subtype to the supertype.

Method Summary

Modifier and Type	Method	Description
static KeyForPropagator.PropagationDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyForPropagator.PropagationDirection[]	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

TO_SUBTYPE

public static final KeyForPropagator.PropagationDirection TO_SUBTYPE

Transfer FROM the supertype to the subtype.

TO_SUPERTYPE

public static final KeyForPropagator.PropagationDirection TO_SUPERTYPE

Transfer FROM the subtype to the supertype.

BOTH

public static final KeyForPropagator.PropagationDirection BOTH

first execute TO_SUBTYPE then TO_SUPERTYPE. If TO_SUBTYPE actually transfers an annotation for a particular type T then T will not be affected by the TO_SUPERTYPE transfer because it will already have a KeyFor annotation.

Method Details

values

public static KeyForPropagator.PropagationDirection[] 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 KeyForPropagator.PropagationDirection 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