Package org.checkerframework.framework.type.visitor

Class SimpleAnnotatedTypeVisitor<R,P>

java.lang.Object

org.checkerframework.framework.type.visitor.SimpleAnnotatedTypeVisitor<R,P>

Type Parameters:

R - the return type of this visitor's methods. Use Void for visitors that do not need to return results.

P - the type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.

All Implemented Interfaces:

AnnotatedTypeVisitor<R,P>

public abstract class SimpleAnnotatedTypeVisitor<R,P>
extends Object
implements AnnotatedTypeVisitor<R,P>

A simple visitor for AnnotatedTypeMirrors.

Field Summary

Fields

Modifier and Type	Field	Description
protected final R	DEFAULT_VALUE	The default value to return as a default action.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleAnnotatedTypeVisitor()	Creates an instance of SimpleAnnotatedTypeVisitor with default value being null.
protected	SimpleAnnotatedTypeVisitor(R defaultValue)	Creates an instance of SimpleAnnotatedTypeVisitor with the default value being the passed defaultValue.

Method Summary

Modifier and Type	Method	Description
protected R	defaultAction(AnnotatedTypeMirror type, P p)	Performs the default action for visiting trees, if subclasses do not override the visitFOO node.
R	visit(AnnotatedTypeMirror type)	A convenience method equivalent to v.visit(t, null).
R	visit(AnnotatedTypeMirror type, P p)	Visits a type.
R	visitArray(AnnotatedTypeMirror.AnnotatedArrayType type, P p)	Visits an array type.
R	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type, P p)	Visits a declared type.
R	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type, P p)	Visits an executable type.
R	visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType type, P p)	Visits an intersection type.
R	visitNoType(AnnotatedTypeMirror.AnnotatedNoType type, P p)	Visits NoType type.
R	visitNull(AnnotatedTypeMirror.AnnotatedNullType type, P p)	Visits a null type.
R	visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type, P p)	Visits a primitive type.
R	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type, P p)	Visits a type variable.
R	visitUnion(AnnotatedTypeMirror.AnnotatedUnionType type, P p)	Visits an union type.
R	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type, P p)	Visits a wildcard type.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_VALUE

protected final R DEFAULT_VALUE

The default value to return as a default action.

Constructor Details

SimpleAnnotatedTypeVisitor

protected SimpleAnnotatedTypeVisitor()

Creates an instance of SimpleAnnotatedTypeVisitor with default value being null.

SimpleAnnotatedTypeVisitor

protected SimpleAnnotatedTypeVisitor(R defaultValue)

Creates an instance of SimpleAnnotatedTypeVisitor with the default value being the passed defaultValue.

Parameters:

defaultValue - the default value this class should return

Method Details

defaultAction

protected R defaultAction(AnnotatedTypeMirror type,
 P p)

Performs the default action for visiting trees, if subclasses do not override the visitFOO node.

This implementation merely returns the default value (as specified by the protected field DEFAULT_VALUE).

visit

public R visit(AnnotatedTypeMirror type)

Description copied from interface: AnnotatedTypeVisitor

A convenience method equivalent to v.visit(t, null).

Specified by:

visit in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

Returns:

a visitor-specified result

visit

public R visit(AnnotatedTypeMirror type,
 P p)

Description copied from interface: AnnotatedTypeVisitor

Visits a type.

Specified by:

visit in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitDeclared

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

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitIntersection

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

Description copied from interface: AnnotatedTypeVisitor

Visits an intersection type.

Specified by:

visitIntersection in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitUnion

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

Description copied from interface: AnnotatedTypeVisitor

Visits an union type.

Specified by:

visitUnion in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitArray

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

Description copied from interface: AnnotatedTypeVisitor

Visits an array type.

Specified by:

visitArray in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitExecutable

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

Description copied from interface: AnnotatedTypeVisitor

Visits an executable type.

Specified by:

visitExecutable in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitTypeVariable

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

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

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

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitPrimitive

public R visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type,
 P p)

Description copied from interface: AnnotatedTypeVisitor

Visits a primitive type.

Specified by:

visitPrimitive in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitNull

public R visitNull(AnnotatedTypeMirror.AnnotatedNullType type,
 P p)

Description copied from interface: AnnotatedTypeVisitor

Visits a null type.

Specified by:

visitNull in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

visitNoType

public R visitNoType(AnnotatedTypeMirror.AnnotatedNoType type,
 P p)

Description copied from interface: AnnotatedTypeVisitor

Visits NoType type.

Specified by:

visitNoType in interface AnnotatedTypeVisitor<R,P>

Parameters:

type - the type to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result