com.github.javaparser.ast.type

Class ClassOrInterfaceType

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.type.Type

com.github.javaparser.ast.type.ReferenceType

com.github.javaparser.ast.type.ClassOrInterfaceType

All Implemented Interfaces:

NodeWithAnnotations<ClassOrInterfaceType>, NodeWithRange<Node>, NodeWithSimpleName<ClassOrInterfaceType>, NodeWithTokenRange<Node>, NodeWithTypeArguments<ClassOrInterfaceType>, Observable, ConvertibleToUsage, Visitable, HasParentNode<Node>, Resolvable<ResolvedType>, Cloneable

public class ClassOrInterfaceType
extends ReferenceType
implements NodeWithSimpleName<ClassOrInterfaceType>, NodeWithAnnotations<ClassOrInterfaceType>, NodeWithTypeArguments<ClassOrInterfaceType>

A class or an interface type.
Object
HashMap<String, String>
java.util.Punchcard

Note that the syntax is ambiguous here, and JavaParser does not know what is to the left of the class. It assumes cases like Map.Entry where Map is the scope of Entry. In java.util.Punchcard, it will not recognize that java and util are parts of the package name. Instead, it will set util as the scope of Punchcard, as a ClassOrInterfaceType (which it is not). In turn, util will have java as its scope, also as a ClassOrInterfaceType

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor and Description
ClassOrInterfaceType()
ClassOrInterfaceType(ClassOrInterfaceType scope, SimpleName name, NodeList<Type> typeArguments)
ClassOrInterfaceType(ClassOrInterfaceType scope, SimpleName name, NodeList<Type> typeArguments, NodeList<AnnotationExpr> annotations)
ClassOrInterfaceType(ClassOrInterfaceType scope, String name)
ClassOrInterfaceType(String name) Deprecated. use JavaParser.parseClassOrInterfaceType instead. This constructor does not understand generics.
ClassOrInterfaceType(TokenRange tokenRange, ClassOrInterfaceType scope, SimpleName name, NodeList<Type> typeArguments, NodeList<AnnotationExpr> annotations) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
ClassOrInterfaceType	asClassOrInterfaceType()
String	asString()
ClassOrInterfaceType	clone()
ResolvedType	convertToUsage(Context context) Convert a ClassOrInterfaceType into a ResolvedType.
ClassOrInterfaceTypeMetaModel	getMetaModel()
SimpleName	getName()
String	getNameWithScope()
Optional<ClassOrInterfaceType>	getScope()
Optional<NodeList<Type>>	getTypeArguments()
void	ifClassOrInterfaceType(Consumer<ClassOrInterfaceType> action)
boolean	isBoxedType()
boolean	isClassOrInterfaceType()
boolean	remove(Node node)
ClassOrInterfaceType	removeScope()
boolean	replace(Node node, Node replacementNode)
ResolvedType	resolve()
ClassOrInterfaceType	setAnnotations(NodeList<AnnotationExpr> annotations)
ClassOrInterfaceType	setName(SimpleName name)
ClassOrInterfaceType	setScope(ClassOrInterfaceType scope) Sets the scope
ClassOrInterfaceType	setTypeArguments(NodeList<Type> typeArguments) Sets the typeArguments
Optional<ClassOrInterfaceType>	toClassOrInterfaceType()
String	toDescriptor()
PrimitiveType	toUnboxedType()

Methods inherited from class com.github.javaparser.ast.type.ReferenceType

asReferenceType, ifReferenceType, isReferenceType, toReferenceType

Methods inherited from class com.github.javaparser.ast.type.Type

asArrayType, asIntersectionType, asPrimitiveType, asTypeParameter, asUnionType, asUnknownType, asVarType, asVoidType, asWildcardType, getAnnotation, getAnnotations, getArrayLevel, getElementType, ifArrayType, ifIntersectionType, ifPrimitiveType, ifTypeParameter, ifUnionType, ifUnknownType, ifVarType, ifVoidType, ifWildcardType, isArrayType, isIntersectionType, isPrimitiveType, isTypeParameter, isUnionType, isUnknownType, isVarType, isVoidType, isWildcardType, toArrayType, toIntersectionType, toPrimitiveType, toTypeParameter, toUnionType, toUnknownType, toVarType, toVoidType, toWildcardType

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations

addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, getAnnotations, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments

isUsingDiamondOperator, removeTypeArguments, setDiamondOperator, setTypeArguments

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

ClassOrInterfaceType

public ClassOrInterfaceType()

ClassOrInterfaceType

public ClassOrInterfaceType(String name)

Deprecated. use JavaParser.parseClassOrInterfaceType instead. This constructor does not understand generics.

ClassOrInterfaceType

public ClassOrInterfaceType(ClassOrInterfaceType scope,
                            String name)

ClassOrInterfaceType

public ClassOrInterfaceType(ClassOrInterfaceType scope,
                            SimpleName name,
                            NodeList<Type> typeArguments)

ClassOrInterfaceType

public ClassOrInterfaceType(ClassOrInterfaceType scope,
                            SimpleName name,
                            NodeList<Type> typeArguments,
                            NodeList<AnnotationExpr> annotations)

ClassOrInterfaceType

public ClassOrInterfaceType(TokenRange tokenRange,
                            ClassOrInterfaceType scope,
                            SimpleName name,
                            NodeList<Type> typeArguments,
                            NodeList<AnnotationExpr> annotations)

This constructor is used by the parser and is considered private.

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

getName

public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<ClassOrInterfaceType>

getNameWithScope

public String getNameWithScope()

getScope

public Optional<ClassOrInterfaceType> getScope()

isBoxedType

public boolean isBoxedType()

toUnboxedType

public PrimitiveType toUnboxedType()
                            throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setName

public ClassOrInterfaceType setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<ClassOrInterfaceType>

setScope

public ClassOrInterfaceType setScope(ClassOrInterfaceType scope)

Sets the scope

Parameters:

scope - the scope, can be null

Returns:

this, the ClassOrInterfaceType

getTypeArguments

public Optional<NodeList<Type>> getTypeArguments()

Specified by:

getTypeArguments in interface NodeWithTypeArguments<ClassOrInterfaceType>

Returns:

the types that can be found in the type arguments: <String, Integer>.

setTypeArguments

public ClassOrInterfaceType setTypeArguments(NodeList<Type> typeArguments)

Sets the typeArguments

Specified by:

setTypeArguments in interface NodeWithTypeArguments<ClassOrInterfaceType>

Parameters:

typeArguments - the typeArguments, can be null

Returns:

this, the ClassOrInterfaceType

setAnnotations

public ClassOrInterfaceType setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<ClassOrInterfaceType>

Overrides:

setAnnotations in class Type

remove

public boolean remove(Node node)

Overrides:

remove in class Type

asString

public String asString()

Specified by:

asString in class Type

toDescriptor

public String toDescriptor()

Specified by:

toDescriptor in class ReferenceType

removeScope

public ClassOrInterfaceType removeScope()

clone

public ClassOrInterfaceType clone()

Overrides:

clone in class ReferenceType

getMetaModel

public ClassOrInterfaceTypeMetaModel getMetaModel()

Overrides:

getMetaModel in class ReferenceType

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Type

isClassOrInterfaceType

public boolean isClassOrInterfaceType()

Overrides:

isClassOrInterfaceType in class Type

asClassOrInterfaceType

public ClassOrInterfaceType asClassOrInterfaceType()

Overrides:

asClassOrInterfaceType in class Type

ifClassOrInterfaceType

public void ifClassOrInterfaceType(Consumer<ClassOrInterfaceType> action)

Overrides:

ifClassOrInterfaceType in class Type

resolve

public ResolvedType resolve()

Specified by:

resolve in interface Resolvable<ResolvedType>

Specified by:

resolve in class Type

toClassOrInterfaceType

public Optional<ClassOrInterfaceType> toClassOrInterfaceType()

Overrides:

toClassOrInterfaceType in class Type

convertToUsage

public ResolvedType convertToUsage(Context context)

Convert a ClassOrInterfaceType into a ResolvedType.

Specified by:

convertToUsage in interface ConvertibleToUsage

Parameters:

classOrInterfaceType - The class of interface type to be converted.

context - The current context.

Returns:

The type resolved.