org.checkerframework.framework.type.visitor

Class AnnotatedTypeCombiner

java.lang.Object

org.checkerframework.framework.type.visitor.AnnotatedTypeScanner<R,AnnotatedTypeMirror>

org.checkerframework.framework.type.visitor.AnnotatedTypeComparer<Void>

org.checkerframework.framework.type.visitor.AnnotatedTypeCombiner

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

public class AnnotatedTypeCombiner
extends AnnotatedTypeComparer<Void>

Combines all the annotations in the parameter with the annotations from the visited type, taking the greatest lower bound at each point.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

AnnotatedTypeScanner.Reduce<R>

Field Summary

Fields inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

defaultResult, reduceFunction, visitedNodes

Method Summary

Modifier and Type	Method and Description
static void	combine(AnnotatedTypeMirror from, AnnotatedTypeMirror to, QualifierHierarchy hierarchy) Combines all annotations from from and to into to using the GLB.
protected void	combineAnnotations(AnnotatedTypeMirror from, AnnotatedTypeMirror to) Computes the greatest lower bound of each set of annotations shared by from and to, and replaces the annotations in to with the result.
protected Void	combineRs(Void r1, Void r2) Supplies the logic to reduce on how to combine two R objects.
protected Void	compare(AnnotatedTypeMirror one, AnnotatedTypeMirror two) Compares two annotated type mirrors.

Methods inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeComparer

reduce, scan, scan, scanAndReduce, scanAndReduce, visitArray, visitDeclared, visitExecutable, visitIntersection, visitTypeVariable, visitUnion, visitWildcard

Methods inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

reset, scan, scanAndReduce, visit, visit, visitNoType, visitNull, visitPrimitive

Methods inherited from class java.lang.Object

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

Method Detail

combine

public static void combine(AnnotatedTypeMirror from,
                           AnnotatedTypeMirror to,
                           QualifierHierarchy hierarchy)

Combines all annotations from from and to into to using the GLB.

Parameters:

from - the annotated type mirror from which to take annotations

to - the annotated type mirror into which annotations should be combined

hierarchy - the top type of the hierarchy whose annotations should be combined

compare

protected Void compare(AnnotatedTypeMirror one,
                       AnnotatedTypeMirror two)

Description copied from class: AnnotatedTypeComparer

Compares two annotated type mirrors.

Specified by:

compare in class AnnotatedTypeComparer<Void>

combineRs

protected Void combineRs(Void r1,
                         Void r2)

Description copied from class: AnnotatedTypeComparer

Supplies the logic to reduce on how to combine two R objects.

Specified by:

combineRs in class AnnotatedTypeComparer<Void>

combineAnnotations

protected void combineAnnotations(AnnotatedTypeMirror from,
                                  AnnotatedTypeMirror to)

Computes the greatest lower bound of each set of annotations shared by from and to, and replaces the annotations in to with the result.

Parameters:

from - the first set of annotations

to - the second set of annotations. This is modified by side-effect to hold the result.