Module org.microbean.lang

Package org.microbean.lang.visitor

Class AsSuperVisitor

java.lang.Object

javax.lang.model.util.AbstractTypeVisitor6<TypeMirror,Element>

javax.lang.model.util.SimpleTypeVisitor6<TypeMirror,Element>

javax.lang.model.util.SimpleTypeVisitor7<TypeMirror,Element>

javax.lang.model.util.SimpleTypeVisitor8<TypeMirror,Element>

javax.lang.model.util.SimpleTypeVisitor9<TypeMirror,Element>

javax.lang.model.util.SimpleTypeVisitor14<TypeMirror,Element>

org.microbean.lang.visitor.AsSuperVisitor

All Implemented Interfaces:

TypeVisitor<TypeMirror,Element>

public final class AsSuperVisitor
extends SimpleTypeVisitor14<TypeMirror,Element>

A SimpleTypeVisitor14 that, given a TypeMirror and an Element, attempts to find a supertype of that TypeMirror whose defining element is equal to (normally is identical to) the supplied Element.

For example, given a type denoted by List<String>, and a TypeElement denoted by Collection, the result of visitation will be the type denoted by Collection<String>.

So "as super" is probably derived from the fact that after this visitor runs you get a view, of sorts, of your parameterized type "as" a parameterized "super" type of a particular kind.

javac does odd things with this and arrays and it is not clear that its documentation matches its code. Consequently I don't have a lot of faith in the visitArray(ArrayType, Element) method as of this writing.

The compiler's asSuper method documentation says, in part:

Return the (most specific) base type of t that starts with the given symbol. If none exists, return null.

Field Summary

Fields inherited from class javax.lang.model.util.SimpleTypeVisitor6

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor	Description
AsSuperVisitor(TypeAndElementSource tes, Equality equality, Types types, SupertypeVisitor supertypeVisitor)

Method Summary

Modifier and Type	Method	Description
final TypeMirror	visitArray(ArrayType t, Element element)
final TypeMirror	visitDeclared(DeclaredType t, Element element)
final TypeMirror	visitError(ErrorType t, Element element)
final TypeMirror	visitIntersection(IntersectionType t, Element element)
final TypeMirror	visitTypeVariable(TypeVariable t, Element element)
final AsSuperVisitor	withSubtypeVisitor(SubtypeVisitor subtypeVisitor)
final AsSuperVisitor	withSupertypeVisitor(SupertypeVisitor supertypeVisitor)

Methods inherited from class javax.lang.model.util.SimpleTypeVisitor7

visitUnion

Methods inherited from class javax.lang.model.util.SimpleTypeVisitor6

defaultAction, visitExecutable, visitNoType, visitNull, visitPrimitive, visitWildcard

Methods inherited from class javax.lang.model.util.AbstractTypeVisitor6

visit, visit, visitUnknown

Methods inherited from class java.lang.Object

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

Constructor Details

AsSuperVisitor

public AsSuperVisitor(TypeAndElementSource tes,
 Equality equality,
 Types types,
 SupertypeVisitor supertypeVisitor)

Method Details

withSupertypeVisitor

public final AsSuperVisitor withSupertypeVisitor(SupertypeVisitor supertypeVisitor)

withSubtypeVisitor

public final AsSuperVisitor withSubtypeVisitor(SubtypeVisitor subtypeVisitor)

visitArray

public final TypeMirror visitArray(ArrayType t,
 Element element)

Specified by:

visitArray in interface TypeVisitor<TypeMirror,Element>

Overrides:

visitArray in class SimpleTypeVisitor6<TypeMirror,Element>

visitDeclared

public final TypeMirror visitDeclared(DeclaredType t,
 Element element)

Specified by:

visitDeclared in interface TypeVisitor<TypeMirror,Element>

Overrides:

visitDeclared in class SimpleTypeVisitor6<TypeMirror,Element>

visitError

public final TypeMirror visitError(ErrorType t,
 Element element)

Specified by:

visitError in interface TypeVisitor<TypeMirror,Element>

Overrides:

visitError in class SimpleTypeVisitor6<TypeMirror,Element>

visitIntersection

public final TypeMirror visitIntersection(IntersectionType t,
 Element element)

Specified by:

visitIntersection in interface TypeVisitor<TypeMirror,Element>

Overrides:

visitIntersection in class SimpleTypeVisitor8<TypeMirror,Element>

visitTypeVariable

public final TypeMirror visitTypeVariable(TypeVariable t,
 Element element)

Specified by:

visitTypeVariable in interface TypeVisitor<TypeMirror,Element>

Overrides:

visitTypeVariable in class SimpleTypeVisitor6<TypeMirror,Element>