org.aspectj.org.eclipse.jdt.core.dom.Type Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.aspectj.org.eclipse.jdt.core.dom;
/**
* Abstract base class of all type reference AST node types. A type node represents a
* reference to a primitive type (including void), to an array type, or to a
* simple named type (or type variable), to a qualified type, to a
* parameterized type, to a union type, to an intersection type, or to a wildcard type. Note that not all of these
* are meaningful in all contexts; for example, a wildcard type is only
* meaningful in the type argument position of a parameterized type.
* UnionType got introduced in JLS4 to support common catch blocks for disjunctive types.
* For JLS8, optional annotations indicated by {Annotation} got added.
*
* Type:
* AnnotatableType:
* PrimitiveType
* SimpleType
* QualifiedType
* NameQualifiedType
* WildcardType
* ArrayType
* ParameterizedType
* UnionType
* IntersectionType
*
* {@link PrimitiveType}:
* { Annotation } byte
* { Annotation } short
* { Annotation } char
* { Annotation } int
* { Annotation } long
* { Annotation } float
* { Annotation } double
* { Annotation } boolean
* { Annotation } void
* {@link ArrayType}:
* Type Dimension { Dimension }
* {@link SimpleType}:
* { Annotation } TypeName
* {@link QualifiedType}:
* Type . {Annotation} SimpleName
* {@link NameQualifiedType}:
* Name . { Annotation } SimpleName
* {@link WildcardType}:
* { Annotation } ? [ ( extends | super) Type ]
* {@link ParameterizedType}:
* Type < Type { , Type } >
* {@link UnionType}:
* Type | Type { | Type }
* {@link IntersectionType}:
* Type & Type { & Type }
*
*
* @since 2.0
*/
public abstract class Type extends ASTNode {
/**
* Creates a new AST node for a type owned by the given AST.
*
* N.B. This constructor is package-private.
*
*
* @param ast the AST that is to own this node
*/
Type(AST ast) {
super(ast);
}
/**
* Returns whether this type is a primitive type
* ({@link PrimitiveType}).
*
* @return true if this is a primitive type, and
* false otherwise
*/
public final boolean isPrimitiveType() {
return (this instanceof PrimitiveType);
}
/**
* Returns whether this type is a simple type
* ({@link SimpleType}).
*
* @return true if this is a simple type, and
* false otherwise
*/
public final boolean isSimpleType() {
return (this instanceof SimpleType);
}
/**
* Returns whether this type is an array type
* ({@link ArrayType}).
*
* @return true if this is an array type, and
* false otherwise
*/
public final boolean isArrayType() {
return (this instanceof ArrayType);
}
/**
* Returns whether this type is a name qualified type
* ({@link NameQualifiedType}).
*
* @return true if this is a name qualified type, and
* false otherwise
* @since 3.10
*/
public final boolean isNameQualifiedType() {
return (this instanceof NameQualifiedType);
}
/**
* Returns whether this type is a parameterized type
* ({@link ParameterizedType}).
*
* @return true if this is a parameterized type, and
* false otherwise
* @since 3.1
*/
public final boolean isParameterizedType() {
return (this instanceof ParameterizedType);
}
/**
* Returns whether this type is a qualified type
* ({@link QualifiedType}).
*
* Note that a type like "A.B" can be represented either of two ways:
*
* -
*
QualifiedType(SimpleType(SimpleName("A")),SimpleName("B"))
*
* -
*
SimpleType(QualifiedName(SimpleName("A"),SimpleName("B")))
*
*
* The first form is preferred when "A" is known to be a type. However, a
* parser cannot always determine this. Clients should be prepared to handle
* either rather than make assumptions. (Note also that the first form
* became possible as of JLS3; only the second form existed in the
* JLS2 API.)
*
* @return true if this is a qualified type, and
* false otherwise
* @since 3.1
*/
public final boolean isQualifiedType() {
return (this instanceof QualifiedType);
}
/**
* Returns whether this type is a union type
* ({@link UnionType}).
*
* @return true if this is a union type, and
* false otherwise
* @since 3.7.1
*/
public final boolean isUnionType() {
return (this instanceof UnionType);
}
/**
* Returns whether this type is a var. The convenience method checks
* whether the type is so named.
*
* @return true if this is a var, and
* false otherwise
* @exception UnsupportedOperationException if this operation is used in
* an AST of level less than JLS10
* @since 3.14
*/
public boolean isVar() {
return false;
}
/**
* Returns whether this type is an intersection type
* ({@link IntersectionType}).
*
* @return true if this is an intersection type, and
* false otherwise
* @since 3.10
*/
public final boolean isIntersectionType() {
return (this instanceof IntersectionType);
}
/**
* Returns whether this type is a wildcard type
* ({@link WildcardType}).
*
* Note that a wildcard type is only meaningful as a
* type argument of a {@link ParameterizedType} node.
*
*
* @return true if this is a wildcard type, and
* false otherwise
* @since 3.1
*/
public final boolean isWildcardType() {
return (this instanceof WildcardType);
}
/**
* Returns whether this type can be annotated. All sub-classes of
* {@link AnnotatableType} can be annotated.
*
* @return true if this type is an instance of {@link AnnotatableType}, and
* false otherwise
*
* @since 3.10
*/
public boolean isAnnotatable() {
return (this instanceof AnnotatableType);
}
/**
* Resolves and returns the binding for this type.
*
* Note that bindings are generally unavailable unless requested when the
* AST is being built.
*
*
* @return the type binding, or null if the binding cannot be
* resolved
*/
public final ITypeBinding resolveBinding() {
return this.ast.getBindingResolver().resolveType(this);
}
}