org.checkerframework.framework.type.visitor

Class DoubleAnnotatedTypeScanner<R>

java.lang.Object

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

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

Type Parameters:

R - the result of scanning the two AnnotatedTypeMirrors

All Implemented Interfaces:

AnnotatedTypeVisitor<R,AnnotatedTypeMirror>

Direct Known Subclasses:

AnnotatedTypeCombiner, AnnotatedTypeReplacer

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

An AnnotatedTypeScanner that scans two AnnotatedTypeMirrors simultaneously and performs defaultAction(AnnotatedTypeMirror, AnnotatedTypeMirror) on the pair. Both AnnotatedTypeMirrors must have the same structure, or a subclass must arrange not to continue recursing past the point at which their structure diverges.

If the default action does not return a result, then R should be Void and DoubleAnnotatedTypeScanner() should be used to construct the scanner. If the default action returns a result, then specify a AnnotatedTypeScanner.reduce(R, R) function and use DoubleAnnotatedTypeScanner(Reduce, Object).

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

Modifier	Constructor and Description
protected	DoubleAnnotatedTypeScanner() Constructs an AnnotatedTypeScanner where the reduce function returns the first result if it is nonnull; otherwise the second result is returned.
protected	DoubleAnnotatedTypeScanner(AnnotatedTypeScanner.Reduce<R> reduce, R defaultResult) Creates a scanner with the given reduce function and defaultResult.

Method Summary

Modifier and Type	Method and Description
protected abstract R	defaultAction(AnnotatedTypeMirror type, AnnotatedTypeMirror p) Called by default for any visit method that is not overridden.
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> types1, Iterable<? extends AnnotatedTypeMirror> types2) Scans types1 and types2.
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 AnnotatedTypeScanner.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

reduce, 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

DoubleAnnotatedTypeScanner

protected DoubleAnnotatedTypeScanner()

Constructs an AnnotatedTypeScanner where the reduce function returns the first result if it is nonnull; otherwise the second result is returned. The default result is null.

DoubleAnnotatedTypeScanner

protected DoubleAnnotatedTypeScanner(AnnotatedTypeScanner.Reduce<R> reduce,
                                     R defaultResult)

Creates a scanner with the given reduce function and defaultResult.

Parameters:

reduce - function used to combine the results of scan

defaultResult - result to use by default

Method Detail

defaultAction

protected abstract R defaultAction(AnnotatedTypeMirror type,
                                   AnnotatedTypeMirror p)

Called by default for any visit method that is not overridden.

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

scan

protected R scan(Iterable<? extends AnnotatedTypeMirror> types1,
                 Iterable<? extends AnnotatedTypeMirror> types2)

Scans types1 and types2. If they are empty, then AnnotatedTypeScanner.defaultResult is returned.

Parameters:

types1 - types

types2 - types

Returns:

the result of scanning and reducing all the types in types1 and types2 or AnnotatedTypeScanner.defaultResult if they are empty

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 AnnotatedTypeScanner.reduce(R, R) on the result (plus r) to return a single element.

scanAndReduce

protected final 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