org.checkerframework.framework.type

Class TypeVariableSubstitutor

java.lang.Object

org.checkerframework.framework.type.TypeVariableSubstitutor

public class TypeVariableSubstitutor
extends Object

TypeVariableSusbtitutor replaces type variables from a declaration with arguments to its use.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TypeVariableSubstitutor.Visitor

Constructor Summary

Constructors

Constructor and Description
TypeVariableSubstitutor()

Method Summary

Modifier and Type	Method and Description
AnnotatedTypeMirror	substitute(Map<TypeVariable,AnnotatedTypeMirror> typeParamToArg, AnnotatedTypeMirror typeMirror) Given a mapping between type variable's to typeArgument, replace each instance of type variable with a copy of type argument.
protected AnnotatedTypeMirror	substituteTypeVariable(AnnotatedTypeMirror argument, AnnotatedTypeMirror.AnnotatedTypeVariable use) Given the types of a type parameter declaration, the argument to that type parameter declaration, and a given use of that declaration, return a substitute for the use with the correct annotations.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeVariableSubstitutor

public TypeVariableSubstitutor()

Method Detail

substitute

public AnnotatedTypeMirror substitute(Map<TypeVariable,AnnotatedTypeMirror> typeParamToArg,
                                      AnnotatedTypeMirror typeMirror)

Given a mapping between type variable's to typeArgument, replace each instance of type variable with a copy of type argument.

Returns:

a copy of typeMirror with its type variables substituted

See Also:

substituteTypeVariable(AnnotatedTypeMirror, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedTypeVariable)

substituteTypeVariable

protected AnnotatedTypeMirror substituteTypeVariable(AnnotatedTypeMirror argument,
                                                     AnnotatedTypeMirror.AnnotatedTypeVariable use)

Given the types of a type parameter declaration, the argument to that type parameter declaration, and a given use of that declaration, return a substitute for the use with the correct annotations.

To determine what primary annotations are correct for the substitute the following rules are used: If the type variable use has a primary annotation then apply that primary annotation to the substitute. Otherwise, use the annotations of the argument.

Parameters:

argument - the argument to declaration (this will be a value in typeParamToArg)

use - the use that is being replaced

Returns:

a deep copy of argument with the appropriate annotations applied