Top Description Fields Constructors Methods
com.github.javaparser.ast.type

public Class ClassOrInterfaceType

extends ReferenceType
implements NodeWithSimpleName<ClassOrInterfaceType>, NodeWithAnnotations<ClassOrInterfaceType>, NodeWithTypeArguments<ClassOrInterfaceType>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, com.github.javaparser.ast.nodeTypes.NodeWithSimpleName
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .NodeList, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .SimpleName, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, .NodeWithSimpleName, .NodeWithTypeArguments, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.ClassOrInterfaceTypeMetaModel, .JavaParserMetaModel, .OptionalProperty, java.util.Optional, com.github.javaparser.TokenRange, com.github.javaparser.resolution.types.ResolvedReferenceType, java.util.function.Consumer
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

Field Summary

Modifier and TypeField and Description
private SimpleName
name

private ClassOrInterfaceType
scope

private NodeList<Type>
typeArguments

Constructor Summary

AccessConstructor and Description
public
ClassOrInterfaceType()

public
ClassOrInterfaceType(final String name)

Deprecated use JavaParser.parseClassOrInterfaceType instead. This constructor does not understand generics.
public
ClassOrInterfaceType(final ClassOrInterfaceType scope, final String name)

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

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

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 Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public ClassOrInterfaceType
asClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.asClassOrInterfaceType.

public String
asString()

Implements abstract com.github.javaparser.ast.type.Type.asString.

public ClassOrInterfaceType
clone()

Overrides com.github.javaparser.ast.type.ReferenceType.clone.

Creates and returns a copy of this object.
public ClassOrInterfaceTypeMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.type.ReferenceType.getMetaModel.

public SimpleName
getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.getName.

public Optional<ClassOrInterfaceType>
getScope()

public Optional<NodeList<Type>>
getTypeArguments()

Implements com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments.getTypeArguments.

public void
ifClassOrInterfaceType(Consumer<ClassOrInterfaceType> action)

Overrides com.github.javaparser.ast.type.Type.ifClassOrInterfaceType.

public boolean
isBoxedType()

public boolean
isClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.isClassOrInterfaceType.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.type.ReferenceType.remove.

public ClassOrInterfaceType
removeScope()

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.type.ReferenceType.replace.

public ResolvedReferenceType
resolve()

Implements abstract com.github.javaparser.ast.type.Type.resolve.

Implements com.github.javaparser.resolution.Resolvable.resolve.

public ClassOrInterfaceType
setAnnotations(NodeList<AnnotationExpr> annotations)

Overrides com.github.javaparser.ast.type.Type.setAnnotations.

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

public ClassOrInterfaceType
setName(final SimpleName name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.setName.

public ClassOrInterfaceType

Returns:

this, the ClassOrInterfaceType
setScope(final ClassOrInterfaceType
the scope, can be null
scope)

Sets the scope

public ClassOrInterfaceType

Returns:

this, the ClassOrInterfaceType
setTypeArguments(final NodeList<Type>
the typeArguments, can be null
typeArguments)

Implements com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments.setTypeArguments.

Sets the typeArguments
public Optional<ClassOrInterfaceType>
toClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.toClassOrInterfaceType.

public PrimitiveType
toUnboxedType()

Inherited from com.github.javaparser.ast.type.ReferenceType:
asReferenceTypeifReferenceTypeisReferenceTypetoReferenceType

Field Detail

nameback to summary
private SimpleName name
scopeback to summary
private ClassOrInterfaceType scope
Annotations
@OptionalProperty
typeArgumentsback to summary
private NodeList<Type> typeArguments
Annotations
@OptionalProperty

Constructor Detail

ClassOrInterfaceTypeback to summary
public ClassOrInterfaceType()
ClassOrInterfaceTypeback to summary
public ClassOrInterfaceType(final String name)

Deprecated

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

ClassOrInterfaceTypeback to summary
public ClassOrInterfaceType(final ClassOrInterfaceType scope, final String name)
ClassOrInterfaceTypeback to summary
public ClassOrInterfaceType(final ClassOrInterfaceType scope, final SimpleName name, final NodeList<Type> typeArguments)
ClassOrInterfaceTypeback to summary
public ClassOrInterfaceType(final ClassOrInterfaceType scope, final SimpleName name, final NodeList<Type> typeArguments, final NodeList<AnnotationExpr> annotations)
Annotations
@AllFieldsConstructor
ClassOrInterfaceTypeback to summary
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.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
asClassOrInterfaceTypeback to summary
public ClassOrInterfaceType asClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.asClassOrInterfaceType.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
asStringback to summary
public String asString()

Implements abstract com.github.javaparser.ast.type.Type.asString.

Annotations
@Override
cloneback to summary
public ClassOrInterfaceType clone()

Overrides com.github.javaparser.ast.type.ReferenceType.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ClassOrInterfaceType

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getMetaModelback to summary
public ClassOrInterfaceTypeMetaModel getMetaModel()

Overrides com.github.javaparser.ast.type.ReferenceType.getMetaModel.

Returns:ClassOrInterfaceTypeMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getNameback to summary
public SimpleName getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.getName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getScopeback to summary
public Optional<ClassOrInterfaceType> getScope()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getTypeArgumentsback to summary
public Optional<NodeList<Type>> getTypeArguments()

Implements com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments.getTypeArguments.

Returns:Optional<NodeList<Type>>

Doc from com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments.getTypeArguments.

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
ifClassOrInterfaceTypeback to summary
public void ifClassOrInterfaceType(Consumer<ClassOrInterfaceType> action)

Overrides com.github.javaparser.ast.type.Type.ifClassOrInterfaceType.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isBoxedTypeback to summary
public boolean isBoxedType()
isClassOrInterfaceTypeback to summary
public boolean isClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.isClassOrInterfaceType.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.type.ReferenceType.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
removeScopeback to summary
public ClassOrInterfaceType removeScope()
Annotations
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.type.ReferenceType.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
resolveback to summary
public ResolvedReferenceType resolve()

Implements abstract com.github.javaparser.ast.type.Type.resolve.

Implements com.github.javaparser.resolution.Resolvable.resolve.

Annotations
@Override
setAnnotationsback to summary
public ClassOrInterfaceType setAnnotations(NodeList<AnnotationExpr> annotations)

Overrides com.github.javaparser.ast.type.Type.setAnnotations.

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

Annotations
@Override
setNameback to summary
public ClassOrInterfaceType setName(final SimpleName name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.setName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setScopeback to summary
public ClassOrInterfaceType setScope(final ClassOrInterfaceType scope)

Sets the scope

Parameters
scope:ClassOrInterfaceType

the scope, can be null

Returns:ClassOrInterfaceType

this, the ClassOrInterfaceType

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setTypeArgumentsback to summary
public ClassOrInterfaceType setTypeArguments(final NodeList<Type> typeArguments)

Implements com.github.javaparser.ast.nodeTypes.NodeWithTypeArguments.setTypeArguments.

Sets the typeArguments

Parameters
typeArguments:NodeList<Type>

the typeArguments, can be null

Returns:ClassOrInterfaceType

this, the ClassOrInterfaceType

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toClassOrInterfaceTypeback to summary
public Optional<ClassOrInterfaceType> toClassOrInterfaceType()

Overrides com.github.javaparser.ast.type.Type.toClassOrInterfaceType.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
toUnboxedTypeback to summary
public PrimitiveType toUnboxedType() throws UnsupportedOperationException