org.checkerframework.framework.type.visitor

Class AnnotatedTypeComparer<R>

java.lang.Object

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

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

All Implemented Interfaces:

AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Direct Known Subclasses:

AnnotatedTypeCombiner, AnnotatedTypeReplacer

public abstract class AnnotatedTypeComparer<R>
extends AnnotatedTypeScanner<R,AnnotatedTypeMirror>

A TypeVisitor that takes two AnnotatedTypeMirrors as parameters, and visits them simultaneously. Both AnnotatedTypeMirrors must have the same structure, or a subclass must arrange not to continue recursing past the point at which their structure diverges.

See Also:

AnnotatedTypeScanner

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

Constructor Summary

Constructors

Constructor and Description
AnnotatedTypeComparer()

Method Summary

Modifier and Type	Method and Description
protected abstract R	combineRs(R r1, R r2) Supplies the logic to reduce on how to combine two R objects.
protected abstract R	compare(AnnotatedTypeMirror type, AnnotatedTypeMirror p) Compares two annotated type mirrors.
protected R	reduce(R r1, R r2) Combines r1 and r2 and returns the result.
protected R	scan(AnnotatedTypeMirror type, AnnotatedTypeMirror p) Scan type by calling type.accept(this, p); this method may be overridden by subclasses.
protected R	scan(Iterable<? extends AnnotatedTypeMirror> types, Iterable<? extends AnnotatedTypeMirror> p)
protected R	scanAndReduce(Iterable<? extends AnnotatedTypeMirror> types, AnnotatedTypeMirror p, R r)
protected R	scanAndReduce(Iterable<? extends AnnotatedTypeMirror> types, Iterable<? extends AnnotatedTypeMirror> p, R r) Run scan(java.lang.Iterable<? extends org.checkerframework.framework.type.AnnotatedTypeMirror>, java.lang.Iterable<? extends org.checkerframework.framework.type.AnnotatedTypeMirror>) on types and p, then run reduce(R, R) on the result (plus r) to return a single element.
R	visitArray(AnnotatedTypeMirror.AnnotatedArrayType type, AnnotatedTypeMirror p) Visits an array type.
R	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type, AnnotatedTypeMirror p) Visits a declared type.
R	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type, AnnotatedTypeMirror p) Visits an executable type.
R	visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType type, AnnotatedTypeMirror p) Visits an intersection type.
R	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type, AnnotatedTypeMirror p) Visits a type variable.
R	visitUnion(AnnotatedTypeMirror.AnnotatedUnionType type, AnnotatedTypeMirror p) Visits an union type.
R	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type, AnnotatedTypeMirror p) Visits a wildcard type.

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

Constructor Detail

AnnotatedTypeComparer

public AnnotatedTypeComparer()

Method Detail

compare

protected abstract R compare(AnnotatedTypeMirror type,
                             AnnotatedTypeMirror p)

Compares two annotated type mirrors.

combineRs

protected abstract R combineRs(R r1,
                               R r2)

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

scan

protected R scan(Iterable<? extends AnnotatedTypeMirror> types,
                 Iterable<? extends AnnotatedTypeMirror> p)

reduce

protected R reduce(R r1,
                   R r2)

Description copied from class: AnnotatedTypeScanner

Combines r1 and r2 and returns the result. The default implementation returns r1 if it is not null; otherwise, it returns r2.

Overrides:

reduce in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

r1 - a result of scan, nonnull if AnnotatedTypeScanner.defaultResult is nonnull and this method never returns null

r2 - a result of scan, nonnull if AnnotatedTypeScanner.defaultResult is nonnull and this method never returns null

Returns:

the combination of r1 and r2

scanAndReduce

protected R scanAndReduce(Iterable<? extends AnnotatedTypeMirror> types,
                          Iterable<? extends AnnotatedTypeMirror> p,
                          R r)

Run scan(java.lang.Iterable<? extends org.checkerframework.framework.type.AnnotatedTypeMirror>, java.lang.Iterable<? extends org.checkerframework.framework.type.AnnotatedTypeMirror>) on types and p, then run reduce(R, R) on the result (plus r) to return a single element.

scanAndReduce

protected R scanAndReduce(Iterable<? extends AnnotatedTypeMirror> types,
                          AnnotatedTypeMirror p,
                          R r)

Overrides:

scanAndReduce in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

scan

protected R scan(AnnotatedTypeMirror type,
                 AnnotatedTypeMirror p)

Description copied from class: AnnotatedTypeScanner

Scan type by calling type.accept(this, p); this method may be overridden by subclasses.

Overrides:

scan in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - type to scan

p - the parameter to use

Returns:

the result of visiting type

visitDeclared

public final R visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type,
                             AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitDeclared in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitArray

public final R visitArray(AnnotatedTypeMirror.AnnotatedArrayType type,
                          AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits an array type.

Specified by:

visitArray in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitArray in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitExecutable

public final R visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type,
                               AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits an executable type.

Specified by:

visitExecutable in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitExecutable in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitTypeVariable

public R visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type,
                           AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitTypeVariable in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public R visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type,
                       AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitWildcard in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitIntersection

public R visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType type,
                           AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits an intersection type.

Specified by:

visitIntersection in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitIntersection in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitUnion

public R visitUnion(AnnotatedTypeMirror.AnnotatedUnionType type,
                    AnnotatedTypeMirror p)

Description copied from interface: AnnotatedTypeVisitor

Visits an union type.

Specified by:

visitUnion in interface AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Overrides:

visitUnion in class AnnotatedTypeScanner<R,AnnotatedTypeMirror>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result