org.checkerframework.checker.nullness

Class KeyForPropagator

java.lang.Object

org.checkerframework.checker.nullness.KeyForPropagator

public class KeyForPropagator
extends Object

KeyForPropagator is used to move nested KeyFor annotations from one side of a pseudo-assignment to the other. The KeyForPropagationTreeAnnotator details the locations in which this occurs.

See Also:

KeyForPropagationTreeAnnotator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyForPropagator.PropagationDirection

Constructor Summary

Constructors

Constructor and Description
KeyForPropagator(AnnotationMirror unknownKeyfor)

Method Summary

Modifier and Type	Method and Description
void	propagate(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, KeyForPropagator.PropagationDirection direction, AnnotatedTypeFactory typeFactory) Propagate annotations from the type arguments of one type to another.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyForPropagator

public KeyForPropagator(AnnotationMirror unknownKeyfor)

Method Detail

propagate

public void propagate(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
                      AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
                      KeyForPropagator.PropagationDirection direction,
                      AnnotatedTypeFactory typeFactory)

Propagate annotations from the type arguments of one type to another. Which type is the source and destination of the annotations depends on the direction parameter. Only @KeyFor annotations are propagated and only if the type to which it would be propagated contains an @UnknownKeyFor or contains no key for annotations of any kind. If any of the type arguments are wildcards than they are ignored.

Note the primary annotations of subtype/supertype are not used.

Simple Example:

 typeOf(subtype) = ArrayList<@KeyFor("a") String>
 typeOf(supertype) = List<@UnknownKeyFor String>
 direction = TO_SUPERTYPE
 

The type of supertype after propagate would be: List<@KeyFor("a") String>

A more complex example would be:

 typeOf(subtype) = HashMap<@UnknownKeyFor String, @KeyFor("b") List<@KeyFor("c") String>>
 typeOf(supertype) = Map<@KeyFor("a") String, @KeyFor("b") List<@KeyFor("c") String>>
 direction = TO_SUBTYPE
 

The type of subtype after propagate would be: HashMap<@KeyFor("a") String, @KeyFor("b") List<@KeyFor("c") String>>