org.aspectj.org.eclipse.jdt.internal.compiler.lookup
Class TypeVariableBinding

java.lang.Object
  extended by org.aspectj.org.eclipse.jdt.internal.compiler.lookup.Binding
      extended by org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding
          extended by org.aspectj.org.eclipse.jdt.internal.compiler.lookup.ReferenceBinding
              extended by org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeVariableBinding
Direct Known Subclasses:
CaptureBinding, InferenceVariable

public class TypeVariableBinding
extends ReferenceBinding

Binding for a type parameter, held by source/binary type or method.


Field Summary
 Binding declaringElement
           
 TypeBinding firstBound
          Denote the first explicit (binding) bound amongst the supertypes (from declaration in source) If no superclass was specified, then it denotes the first superinterface, or null if none was specified.
 char[] genericTypeSignature
           
 int rank
           
 ReferenceBinding superclass
           
 ReferenceBinding[] superInterfaces
           
 
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.ReferenceBinding
compoundName, fPackage, LUB_GENERIC, modifiers, samProblemBinding, singleAbstractMethod, sourceName
 
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding
BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, id, INT, LONG, NULL, SHORT, tagBits, TYPE_USE_BINDING, typeAnnotations, VOID
 
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.Binding
ANY_EXCEPTION, ARRAY_TYPE, BASE_TYPE, DefaultLocationArrayContents, DefaultLocationField, DefaultLocationParameter, DefaultLocationReturnType, DefaultLocationTypeArgument, DefaultLocationTypeBound, DefaultLocationTypeParameter, FIELD, GENERIC_TYPE, IMPORT, INTERSECTION_CAST_TYPE, INTERSECTION_TYPE, LOCAL, METHOD, NO_ANNOTATIONS, NO_ELEMENT_VALUE_PAIRS, NO_EXCEPTIONS, NO_FIELDS, NO_MEMBER_TYPES, NO_METHODS, NO_NULL_DEFAULT, NO_PARAMETER_NAMES, NO_PARAMETERS, NO_REFERENCE_TYPES, NO_SUPERINTERFACES, NO_TYPE_VARIABLES, NO_TYPES, NONNULL_BY_DEFAULT, NULL_UNSPECIFIED_BY_DEFAULT, NullnessDefaultMASK, PACKAGE, PARAMETERIZED_TYPE, POLY_TYPE, RAW_TYPE, TYPE, TYPE_PARAMETER, TYPE_USE, UNINITIALIZED_FIELDS, UNINITIALIZED_METHODS, UNINITIALIZED_REFERENCE_TYPES, VARIABLE, WILDCARD_TYPE
 
Constructor Summary
TypeVariableBinding(char[] sourceName, Binding declaringElement, int rank, LookupEnvironment environment)
           
TypeVariableBinding(TypeVariableBinding prototype)
           
 
Method Summary
 boolean acceptsNonNullDefault()
          Used to implement this sentence from o.e.j.annotation.DefaultLocation: "Wildcards and the use of type variables are always excluded from NonNullByDefault."
 java.lang.String annotatedDebugName()
           
 int boundCheck(Substitution substitution, TypeBinding argumentType, Scope scope)
          Returns true if the argument type satisfies all bounds of the type parameter
 int boundsCount()
           
 boolean canBeInstantiated()
          Answer true if the receiver can be instantiated
 TypeBinding clone(TypeBinding enclosingType)
          Virtual copy constructor: a copy is made of the receiver's entire instance state and then suitably parameterized by the arguments to the clone operation as seen fit by each type.
 void collectSubstitutes(Scope scope, TypeBinding actualType, InferenceContext inferenceContext, int constraint)
          Collect the substitutes into a map for certain type variables inside the receiver type e.g.
 TypeBinding combineTypeAnnotations(TypeBinding substitute)
           
 char[] computeUniqueKey(boolean isLeaf)
          p.X {} -> Lp/X;
 char[] constantPoolName()
          Answer the receiver's constant pool name.
 java.lang.String debugName()
           
 boolean enterRecursiveFunction()
          Call this before descending into type details to prevent infinite recursion.
 TypeBinding erasure()
           
 void evaluateNullAnnotations(Scope scope, TypeParameter parameter)
           
 void exitRecursiveFunction()
          Exit the context of a potentially recursive function.
 char[] genericSignature()
          T::Ljava/util/Map;:Ljava/io/Serializable; T:LY
 char[] genericTypeSignature()
          T::Ljava/util/Map;:Ljava/io/Serializable; T:LY
 boolean hasTypeBit(int bit)
          Answer an additional bit characterizing this type, like TypeIds.BitAutoCloseable.
 boolean isErasureBoundTo(TypeBinding type)
          Returns true if the type variable is directly bound to a given type
 boolean isHierarchyConnected()
          Returns true if the type hierarchy is connected
 boolean isInterchangeableWith(TypeVariableBinding otherVariable, Substitution substitute)
          Returns true if the 2 variables are playing exact same role: they have the same bounds, providing one is substituted with the other: > is interchangeable with >.
 boolean isProperType(boolean admitCapture18)
          JLS8 Sect 18.1.1
 boolean isSubtypeOf(TypeBinding other)
           
 boolean isTypeVariable()
          Returns true if the type was declared as a type variable
 int kind()
           
 boolean mentionsAny(TypeBinding[] parameters, int idx)
          Does this type mention any of the given type parameters, except the one at position 'idx'?
 char[] nullAnnotatedReadableName(CompilerOptions options, boolean shortNames)
          Answer a readable name (for error reporting) that includes nullness type annotations.
 TypeBinding[] otherUpperBounds()
           
 char[] readableName()
          Answer the receiver's signature.
 TypeBinding setFirstBound(TypeBinding firstBound)
           
 ReferenceBinding setSuperClass(ReferenceBinding superclass)
           
 ReferenceBinding[] setSuperInterfaces(ReferenceBinding[] superInterfaces)
           
 void setTypeAnnotations(AnnotationBinding[] annotations, boolean evalNullAnnotations)
           
 char[] shortReadableName()
           
 ReferenceBinding superclass()
           
 ReferenceBinding[] superInterfaces()
           
 java.lang.String toString()
           
 TypeBinding unannotated(boolean removeOnlyNullAnnotations)
          Return this type minus its type annotations
 TypeBinding upperBound()
          Upper bound doesn't perform erasure
 
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.ReferenceBinding
appendNullAnnotation, applyCloseableClassWhitelists, applyCloseableInterfaceWhitelists, availableFields, availableMethods, binarySearch, binarySearch, canBeSeenBy, canBeSeenBy, canBeSeenBy, computeGenericTypeSignature, computeId, depth, detectAnnotationCycle, enclosingTypeAt, enumConstantCount, fieldCount, fields, getAccessFlags, getAnnotations, getAnnotationTagBits, getEnclosingInstancesSlotSize, getExactConstructor, getExactMethod, getField, getField, getFileName, getMemberType, getMethods, getMethods, getOuterLocalVariablesSlotSize, getPackage, getSingleAbstractMethod, getTypeVariable, hashCode, hasIncompatibleSuperType, hasMemberTypes, hasRestrictedAccess, implementsInterface, innerCanBeSeenBy, innerCanBeSeenBy, isAbstract, isAnnotationType, isBinaryBinding, isClass, isCompatibleWith, isConsistentIntersection, isDefault, isDeprecated, isEnum, isFinal, isFunctionalInterface, isHierarchyBeingActivelyConnected, isHierarchyBeingConnected, isInterface, isOrEnclosedByPrivateType, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSubTypeOfRTL, isSuperclassOf, isThrowable, isUncheckedException, isUsed, isViewedAsDeprecated, memberTypes, methods, outermostEnclosingType, qualifiedSourceName, retrieveAnnotationHolder, setAnnotations, setContainerAnnotationType, signature, sortFields, sortMethods, sourceName, syntheticEnclosingInstanceTypes, tagAsHavingDefectiveContainerType, unResolvedFields
 
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding
actualType, capture, closestMatch, collectMissingTypes, containerAnnotationType, dimensions, enclosingType, equalsEquals, findSuperTypeOriginatingFrom, findSuperTypeOriginatingFrom, genericCast, getErasureCompatibleType, getIntersectingTypes, getTypeAnnotations, hasNullTypeAnnotations, hasTypeAnnotations, isAnonymousType, isArrayType, isBaseType, isBoundParameterizedType, isBoxedPrimitiveType, isCapture, isCompatibleWith, isEquivalentTo, isGenericType, isHierarchyInconsistent, isIntersectionCastType, isIntersectionType, isLocalType, isMemberType, isNestedType, isNumericType, isParameterizedType, isParameterizedTypeWithActualArguments, isParameterizedWithOwnVariables, isPrimitiveOrBoxedPrimitiveType, isPrimitiveType, isProvablyDistinct, isRawType, isReifiable, isRepeatableAnnotationType, isTypeArgumentContainedBy, isUnboundWildcard, isUnresolvedType, isWildcard, leafComponentType, needsUncheckedConversion, notEquals, original, prototype, qualifiedPackageName, sIsMoreSpecific, swapUnresolved, syntheticOuterLocalVariables, typeVariables, uncapture, wellKnownType
 
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.lookup.Binding
computeUniqueKey, initializeDeprecatedAnnotationTagBits, isParameter, isTaggedRepeatable, isValidBinding, isVolatile, problemId, setAnnotations
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

declaringElement

public Binding declaringElement

rank

public int rank

firstBound

public TypeBinding firstBound
Denote the first explicit (binding) bound amongst the supertypes (from declaration in source) If no superclass was specified, then it denotes the first superinterface, or null if none was specified.


superclass

public ReferenceBinding superclass

superInterfaces

public ReferenceBinding[] superInterfaces

genericTypeSignature

public char[] genericTypeSignature
Constructor Detail

TypeVariableBinding

public TypeVariableBinding(char[] sourceName,
                           Binding declaringElement,
                           int rank,
                           LookupEnvironment environment)

TypeVariableBinding

public TypeVariableBinding(TypeVariableBinding prototype)
Method Detail

boundCheck

public int boundCheck(Substitution substitution,
                      TypeBinding argumentType,
                      Scope scope)
Returns true if the argument type satisfies all bounds of the type parameter


boundsCount

public int boundsCount()

canBeInstantiated

public boolean canBeInstantiated()
Description copied from class: ReferenceBinding
Answer true if the receiver can be instantiated

Overrides:
canBeInstantiated in class ReferenceBinding
See Also:
ReferenceBinding.canBeInstantiated()

collectSubstitutes

public void collectSubstitutes(Scope scope,
                               TypeBinding actualType,
                               InferenceContext inferenceContext,
                               int constraint)
Collect the substitutes into a map for certain type variables inside the receiver type e.g. Collection.collectSubstitutes(Collection>, Map), will populate Map with: T --> List Constraints: A << F corresponds to: F.collectSubstitutes(..., A, ..., CONSTRAINT_EXTENDS (1)) A = F corresponds to: F.collectSubstitutes(..., A, ..., CONSTRAINT_EQUAL (0)) A >> F corresponds to: F.collectSubstitutes(..., A, ..., CONSTRAINT_SUPER (2))

Overrides:
collectSubstitutes in class TypeBinding

computeUniqueKey

public char[] computeUniqueKey(boolean isLeaf)
Description copied from class: ReferenceBinding
p.X {} -> Lp/X;

Overrides:
computeUniqueKey in class ReferenceBinding

constantPoolName

public char[] constantPoolName()
Description copied from class: ReferenceBinding
Answer the receiver's constant pool name. NOTE: This method should only be used during/after code gen.

Overrides:
constantPoolName in class ReferenceBinding

clone

public TypeBinding clone(TypeBinding enclosingType)
Description copied from class: TypeBinding
Virtual copy constructor: a copy is made of the receiver's entire instance state and then suitably parameterized by the arguments to the clone operation as seen fit by each type. Parameters may not make sense for every type in the hierarchy, in which case they are silently ignored. A type may choose to retain a copy of the prototype for reference.

Overrides:
clone in class TypeBinding

annotatedDebugName

public java.lang.String annotatedDebugName()
Overrides:
annotatedDebugName in class TypeBinding

debugName

public java.lang.String debugName()
Overrides:
debugName in class ReferenceBinding
See Also:
TypeBinding.debugName()

erasure

public TypeBinding erasure()
Overrides:
erasure in class TypeBinding

genericSignature

public char[] genericSignature()
T::Ljava/util/Map;:Ljava/io/Serializable; T:LY


genericTypeSignature

public char[] genericTypeSignature()
T::Ljava/util/Map;:Ljava/io/Serializable; T:LY

Overrides:
genericTypeSignature in class TypeBinding

hasTypeBit

public boolean hasTypeBit(int bit)
Description copied from class: TypeBinding
Answer an additional bit characterizing this type, like TypeIds.BitAutoCloseable.

Overrides:
hasTypeBit in class TypeBinding

isErasureBoundTo

public boolean isErasureBoundTo(TypeBinding type)
Returns true if the type variable is directly bound to a given type


isHierarchyConnected

public boolean isHierarchyConnected()
Description copied from class: ReferenceBinding
Returns true if the type hierarchy is connected

Overrides:
isHierarchyConnected in class ReferenceBinding

isInterchangeableWith

public boolean isInterchangeableWith(TypeVariableBinding otherVariable,
                                     Substitution substitute)
Returns true if the 2 variables are playing exact same role: they have the same bounds, providing one is substituted with the other: > is interchangeable with >.


isSubtypeOf

public boolean isSubtypeOf(TypeBinding other)
Overrides:
isSubtypeOf in class ReferenceBinding

enterRecursiveFunction

public boolean enterRecursiveFunction()
Description copied from class: TypeBinding
Call this before descending into type details to prevent infinite recursion.

Overrides:
enterRecursiveFunction in class TypeBinding
Returns:
true if a recursion has already been started.

exitRecursiveFunction

public void exitRecursiveFunction()
Description copied from class: TypeBinding
Exit the context of a potentially recursive function.

Overrides:
exitRecursiveFunction in class TypeBinding

isProperType

public boolean isProperType(boolean admitCapture18)
Description copied from class: TypeBinding
JLS8 Sect 18.1.1

Overrides:
isProperType in class ReferenceBinding
Parameters:
admitCapture18 - request if CaptureBinding18 shuld be considered as a proper type. If unsure say 'true', only in Scope.greaterLowerBound(TypeBinding[], Scope, LookupEnvironment) CaptureBinding18 has to be excluded to prevent an NPE on a branch that heuristically tries to avoid inconsistent intersections.

isTypeVariable

public boolean isTypeVariable()
Returns true if the type was declared as a type variable

Overrides:
isTypeVariable in class TypeBinding

kind

public int kind()
Overrides:
kind in class TypeBinding

mentionsAny

public boolean mentionsAny(TypeBinding[] parameters,
                           int idx)
Description copied from class: TypeBinding
Does this type mention any of the given type parameters, except the one at position 'idx'?

Overrides:
mentionsAny in class TypeBinding

otherUpperBounds

public TypeBinding[] otherUpperBounds()

readableName

public char[] readableName()
Description copied from class: ReferenceBinding
Answer the receiver's signature. NOTE: This method should only be used during/after code gen.

Overrides:
readableName in class ReferenceBinding
See Also:
ReferenceBinding.readableName()

setTypeAnnotations

public void setTypeAnnotations(AnnotationBinding[] annotations,
                               boolean evalNullAnnotations)
Overrides:
setTypeAnnotations in class TypeBinding

shortReadableName

public char[] shortReadableName()
Overrides:
shortReadableName in class ReferenceBinding
See Also:
ReferenceBinding.shortReadableName()

superclass

public ReferenceBinding superclass()
Overrides:
superclass in class ReferenceBinding

superInterfaces

public ReferenceBinding[] superInterfaces()
Overrides:
superInterfaces in class ReferenceBinding

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

nullAnnotatedReadableName

public char[] nullAnnotatedReadableName(CompilerOptions options,
                                        boolean shortNames)
Description copied from class: TypeBinding
Answer a readable name (for error reporting) that includes nullness type annotations.

Overrides:
nullAnnotatedReadableName in class ReferenceBinding
See Also:
TypeBinding.nullAnnotatedReadableName(CompilerOptions,boolean)

unannotated

public TypeBinding unannotated(boolean removeOnlyNullAnnotations)
Description copied from class: TypeBinding
Return this type minus its type annotations

Overrides:
unannotated in class TypeBinding
Parameters:
removeOnlyNullAnnotations - if true only null type annotations are removed, otherwise all type annotations.

upperBound

public TypeBinding upperBound()
Upper bound doesn't perform erasure


evaluateNullAnnotations

public void evaluateNullAnnotations(Scope scope,
                                    TypeParameter parameter)

setFirstBound

public TypeBinding setFirstBound(TypeBinding firstBound)

setSuperClass

public ReferenceBinding setSuperClass(ReferenceBinding superclass)

setSuperInterfaces

public ReferenceBinding[] setSuperInterfaces(ReferenceBinding[] superInterfaces)

combineTypeAnnotations

public TypeBinding combineTypeAnnotations(TypeBinding substitute)

acceptsNonNullDefault

public boolean acceptsNonNullDefault()
Description copied from class: TypeBinding
Used to implement this sentence from o.e.j.annotation.DefaultLocation: "Wildcards and the use of type variables are always excluded from NonNullByDefault."

Overrides:
acceptsNonNullDefault in class ReferenceBinding