Class ASTClassType
- java.lang.Object
-
- net.sourceforge.pmd.lang.ast.impl.AbstractNode<B,N>
-
- net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
- net.sourceforge.pmd.lang.java.ast.ASTClassType
-
- All Implemented Interfaces:
GenericNode<JavaNode>,JjtreeNode<JavaNode>,Node,TextAvailableNode,Annotatable,ASTReferenceType,ASTType,JavaNode,TypeNode,Reportable
public final class ASTClassType extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode> implements ASTReferenceType
Represents a class or interface type, possibly parameterised with type arguments.This node corresponds to the JLS' ClassOrInterfaceType, and also to the related productions TypeIdentifier and TypeName. Merging those allow to treat them uniformly.
ClassType ::=
Annotation* <IDENTIFIER>TypeArguments? | ClassType "."Annotation* <IDENTIFIER>TypeArguments?Note: This node was called ASTClassOrInterfaceType in PMD 6.
- Implementation Note:
- The parser may produce an AmbiguousName for the qualifier. This is systematically removed by the disambiguation phase.
-
-
Field Summary
Fields Modifier and Type Field Description protected JSymbolTablesymbolTable-
Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
id
-
Fields inherited from interface net.sourceforge.pmd.lang.ast.Node
COORDS_COMPARATOR
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <P,R>
RacceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)protected <P,R>
RacceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)protected voidaddChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)@Nullable StringgetPackageQualifier()Return the package qualifier, if this is a fully qualified name.@Nullable ASTClassTypegetQualifier()Gets the owner type of this type if it's not ambiguous.@NonNull ASTCompilationUnitgetRoot()StringgetSimpleName()Returns the simple name of this type.@NonNull JSymbolTablegetSymbolTable()Returns the symbol table for the program point represented by this node.@Nullable ASTTypeArgumentsgetTypeArguments()Returns the type arguments of this segment if some are specified.@NonNull JTypeMirrorgetTypeMirror()Returns the compile-time type of this node.@NonNull JTypeMirrorgetTypeMirror(TypingContext context)TypeSystemgetTypeSystem()Returns the type system with which this node was created.StringgetXPathNodeName()protected voidinsertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)booleanisFullyQualified()Returns true if the type was written with a full package qualification.voidjjtClose()protected voidremoveChildAtIndex(int childIndex)protected voidsetChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)protected voidsetFirstToken(JavaccToken token)protected voidsetImage(String image)protected voidsetLastToken(JavaccToken token)-
Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
compareLocation, fitTokensToChildren, getFirstToken, getImage, getLastToken, getTextRegion, jjtOpen, toString
-
Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode
children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sourceforge.pmd.lang.java.ast.Annotatable
getAnnotation, getDeclaredAnnotations, isAnnotationPresent, isAnnotationPresent, isAnyAnnotationPresent
-
Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode
ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling
-
Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode
getEnclosingType, getRoot, getSymbolTable, getTypeSystem
-
Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
getFirstToken, getLastToken, tokens
-
Methods inherited from interface net.sourceforge.pmd.lang.ast.Node
acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary
-
Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode
getOriginalText, getText, getTextRegion
-
Methods inherited from interface net.sourceforge.pmd.lang.java.ast.TypeNode
getTypeMirror, getTypeMirror
-
-
-
-
Field Detail
-
symbolTable
protected JSymbolTable symbolTable
-
-
Method Detail
-
isFullyQualified
public boolean isFullyQualified()
Returns true if the type was written with a full package qualification. For example,java.lang.Override. For nested types, only the leftmost type is considered fully qualified. Eg inp.Outer.Inner, this method will return true for the type corresponding top.Outer, but false for the enclosingp.Outer.Inner.
-
getQualifier
public @Nullable ASTClassType getQualifier()
Gets the owner type of this type if it's not ambiguous. This is a type we know for sure that this type is a member of.- Returns:
- A type, or null if this is a base type
-
getTypeArguments
public @Nullable ASTTypeArguments getTypeArguments()
Returns the type arguments of this segment if some are specified.
-
getPackageQualifier
public @Nullable String getPackageQualifier()
Return the package qualifier, if this is a fully qualified name. Note that this will only be the case if we could resolve the qualifier to a package name during disambiguation. In other words, if the auxclasspath is not complete, and the qualifier could not be disambiguated, this method will return null (and an AmbiguousName will stay in the tree).If a nested type is package-qualified, this method will only return a non-null result for the leftmost (=innermost) ASTClassType node. For instance in
java.util.Map.Entry, the nodejava.util.Maphas package qualifier"java.util", while the node forEntryhas package qualifiernull. Note that the package name of the symbol and type mirror will reflect that package name anyway, on both nodes.
-
acceptVisitor
protected <P,R> R acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)
-
getSimpleName
public String getSimpleName()
Returns the simple name of this type. Use the symbol to get more information.
-
getTypeMirror
public @NonNull JTypeMirror getTypeMirror()
Description copied from interface:TypeNodeReturns the compile-time type of this node. For example, for a string literal, returns the type mirror forString, for a method call, returns the return type of the call, etc.This method ignores conversions applied to the value of the node because of its context. For example, in
1 + "", the numeric literal will have typeint, but it is converted toStringby the surrounding concatenation expression. Similarly, inCollections.singletonList(1), theASTNumericLiteralnode has typeint, but the type of the method formal isInteger, and boxing is applied at runtime. Possibly, an API will be added to expose this information.- Specified by:
getTypeMirrorin interfaceTypeNode- Returns:
- The type mirror. Never returns null; if the type is unresolved, returns
TypeSystem.UNKNOWN.
-
getTypeMirror
public @NonNull JTypeMirror getTypeMirror(TypingContext context)
- Specified by:
getTypeMirrorin interfaceTypeNode
-
jjtClose
public void jjtClose()
- Overrides:
jjtClosein classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
acceptVisitor
public final <P,R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
- Specified by:
acceptVisitorin interfaceNode
-
addChild
protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)- Overrides:
addChildin classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
insertChild
protected void insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)- Overrides:
insertChildin classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
removeChildAtIndex
protected void removeChildAtIndex(int childIndex)
- Overrides:
removeChildAtIndexin classAbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
setImage
protected void setImage(String image)
- Overrides:
setImagein classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
setFirstToken
protected void setFirstToken(JavaccToken token)
- Overrides:
setFirstTokenin classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
setLastToken
protected void setLastToken(JavaccToken token)
- Overrides:
setLastTokenin classAbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
setChild
protected void setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)- Overrides:
setChildin classAbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
-
getSymbolTable
public @NonNull JSymbolTable getSymbolTable()
Description copied from interface:JavaNodeReturns the symbol table for the program point represented by this node.- Specified by:
getSymbolTablein interfaceJavaNode
-
getTypeSystem
public TypeSystem getTypeSystem()
Description copied from interface:JavaNodeReturns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.- Specified by:
getTypeSystemin interfaceJavaNode
-
getRoot
public final @NonNull ASTCompilationUnit getRoot()
-
getXPathNodeName
public final String getXPathNodeName()
- Specified by:
getXPathNodeNamein interfaceNode
-
-