|
 |
|
|
org.eclipse.jdt.core.dom
Interface ITypeBinding
-
All Superinterfaces:
-
IBinding
-
public interface ITypeBinding
- extends
IBinding
A type binding represents fully-resolved type. There are a number of
different kinds of type bindings:
- a class - represents the class declaration;
possibly with type parameters
- an interface - represents the class declaration;
possibly with type parameters
- an enum - represents the enum declaration (enum types do not have
have type parameters)
- an annotation - represents the annotation type declaration
(annotation types do not have have type parameters)
- an array type - array types are referenced but not explicitly
declared
- a primitive type (including the special return type
void )
- primitive types are referenced but not explicitly declared
- the null type - this is the special type of
null
- a type variable - represents the declaration of a type variable;
possibly with type bounds
- a wildcard type - represents a wild card used as a type argument in
a parameterized type reference
- a raw type - represents a legacy non-parameterized reference to
a generic type
- a parameterized type - represents an copy of a type declaration
with substitutions for its type parameters
- a capture - represents a capture binding
-
Since:
- 2.0
-
See Also:
-
getDeclaredTypes()
-
Restriction:
- This interface is not intended to be implemented by clients.
Method Summary
|
ITypeBinding
|
createArrayType
(int dimension)
Answer an array type binding using the receiver and the given dimension. |
String
|
getBinaryName
()
Returns the binary name of this type binding. |
ITypeBinding
|
getBound
()
Returns the bound of this wildcard type if it has one. |
ITypeBinding
|
getComponentType
()
Returns the binding representing the component type of this array type,
or null if this is not an array type binding. |
IVariableBinding[]
|
getDeclaredFields
()
Returns a list of bindings representing all the fields declared
as members of this class, interface, or enum type. |
IMethodBinding[]
|
getDeclaredMethods
()
Returns a list of method bindings representing all the methods and
constructors declared for this class, interface, enum, or annotation
type. |
int
|
getDeclaredModifiers
()
Returns the declared modifiers for this class or interface binding
as specified in the original source declaration of the class or
interface. |
ITypeBinding[]
|
getDeclaredTypes
()
Returns a list of type bindings representing all the types declared as
members of this class, interface, or enum type. |
ITypeBinding
|
getDeclaringClass
()
Returns the type binding representing the class, interface, or enum
that declares this binding. |
IMethodBinding
|
getDeclaringMethod
()
Returns the method binding representing the method that declares this binding
of a local type or type variable. |
int
|
getDimensions
()
Returns the dimensionality of this array type, or 0 if this
is not an array type binding. |
ITypeBinding
|
getElementType
()
Returns the binding representing the element type of this array type,
or null if this is not an array type binding. |
ITypeBinding
|
getErasure
()
Returns the erasure of this type binding. |
ITypeBinding
|
getGenericTypeOfWildcardType
()
Returns the generic type associated with this wildcard type, if it has one. |
ITypeBinding[]
|
getInterfaces
()
Returns a list of type bindings representing the direct superinterfaces
of the class, interface, or enum type represented by this type binding. |
int
|
getModifiers
()
Returns the compiled modifiers for this class, interface, enum,
or annotation type binding. |
String
|
getName
()
Returns the unqualified name of the type represented by this binding
if it has one. |
IPackageBinding
|
getPackage
()
Returns the binding for the package in which this type is declared. |
String
|
getQualifiedName
()
Returns the fully qualified name of the type represented by this
binding if it has one. |
int
|
getRank
()
Returns the rank associated with this wildcard type. |
ITypeBinding
|
getSuperclass
()
Returns the type binding for the superclass of the type represented
by this class binding. |
ITypeBinding[]
|
getTypeArguments
()
Returns the type arguments of this generic type instance, or the
empty list for other type bindings. |
ITypeBinding[]
|
getTypeBounds
()
Returns the declared type bounds of this type variable or capture. |
ITypeBinding
|
getTypeDeclaration
()
Returns the binding for the type declaration corresponding to this type
binding. |
ITypeBinding[]
|
getTypeParameters
()
Returns the type parameters of this class or interface type binding. |
ITypeBinding
|
getWildcard
()
Returns the corresponding wildcard binding of this capture binding. |
boolean
|
isAnnotation
()
Returns whether this type binding represents an annotation type. |
boolean
|
isAnonymous
()
Returns whether this type binding represents an anonymous class. |
boolean
|
isArray
()
Returns whether this type binding represents an array type. |
boolean
|
isAssignmentCompatible
(
ITypeBinding variableType)
Returns whether an expression of this type can be assigned to a variable
of the given type, as specified in section 5.2 of The Java Language
Specification, Third Edition (JLS3). |
boolean
|
isCapture
()
Returns whether this type binding represents a capture binding. |
boolean
|
isCastCompatible
(
ITypeBinding type)
Returns whether this type is cast compatible with the given type,
as specified in section 5.5 of The Java Language
Specification, Third Edition (JLS3). |
boolean
|
isClass
()
Returns whether this type binding represents a class type or a recovered binding. |
boolean
|
isEnum
()
Returns whether this type binding represents an enum type. |
boolean
|
isFromSource
()
Returns whether this type binding originated in source code. |
boolean
|
isGenericType
()
Returns whether this type binding represents a declaration of
a generic class or interface. |
boolean
|
isInterface
()
Returns whether this type binding represents an interface type. |
boolean
|
isLocal
()
Returns whether this type binding represents a local class. |
boolean
|
isMember
()
Returns whether this type binding represents a member class or
interface. |
boolean
|
isNested
()
Returns whether this type binding represents a nested class, interface,
enum, or annotation type. |
boolean
|
isNullType
()
Returns whether this type binding represents the null type. |
boolean
|
isParameterizedType
()
Returns whether this type binding represents an instance of
a generic type corresponding to a parameterized type reference. |
boolean
|
isPrimitive
()
Returns whether this type binding represents a primitive type. |
boolean
|
isRawType
()
Returns whether this type binding represents an instance of
a generic type corresponding to a raw type reference. |
boolean
|
isSubTypeCompatible
(
ITypeBinding type)
Returns whether this type is subtype compatible with the given type,
as specified in section 4.10 of The Java Language
Specification, Third Edition (JLS3). |
boolean
|
isTopLevel
()
Returns whether this type binding represents a top-level class,
interface, enum, or annotation type. |
boolean
|
isTypeVariable
()
Returns whether this type binding represents a type variable. |
boolean
|
isUpperbound
()
Returns whether this wildcard type is an upper bound
("extends") as opposed to a lower bound ("super"). |
boolean
|
isWildcardType
()
Returns whether this type binding represents a wildcard type. |
createArrayType
ITypeBinding createArrayType(int dimension)
- Answer an array type binding using the receiver and the given dimension.
If the receiver is an array binding, then the resulting dimension is the given dimension
plus the dimension of the receiver. Otherwise the resulting dimension is the given
dimension.
-
-
-
Parameters:
-
dimension - the given dimension
-
Returns:
- an array type binding
-
Throws:
-
IllegalArgumentException:
- - if the receiver represents the void type
- if the resulting dimensions is lower than one or greater than 255
-
Since:
- 3.3
getBinaryName
String getBinaryName()
- Returns the binary name of this type binding.
The binary name of a class is defined in the Java Language
Specification 3rd edition, section 13.1.
Note that in some cases, the binary name may be unavailable.
This may happen, for example, for a local type declared in
unreachable code.
-
-
-
Returns:
- the binary name of this type, or
null
if the binary name is unknown -
Since:
- 3.0
getBound
ITypeBinding getBound()
- Returns the bound of this wildcard type if it has one.
Returns
null if this is not a wildcard type.
-
-
-
Returns:
- the bound of this wildcard type, or
null if none -
Since:
- 3.1
-
See Also:
-
isWildcardType() ,
isUpperbound()
getGenericTypeOfWildcardType
ITypeBinding getGenericTypeOfWildcardType()
- Returns the generic type associated with this wildcard type, if it has one.
Returns
null if this is not a wildcard type.
-
-
-
Returns:
- the generic type associated with this wildcard type, or
null if none -
Since:
- 3.5
-
See Also:
-
isWildcardType()
getRank
int getRank()
- Returns the rank associated with this wildcard type. The rank of this wild card type is the relative
position of the wild card type in the parameterization of the associated generic type.
Returns
-1 if this is not a wildcard type.
-
-
-
Returns:
- the rank associated with this wildcard type, or
-1 if none -
Since:
- 3.5
-
See Also:
-
isWildcardType()
getComponentType
ITypeBinding getComponentType()
- Returns the binding representing the component type of this array type,
or
null if this is not an array type binding. The component
type of an array might be an array type.
This is subject to change before 3.2 release.
-
-
-
Returns:
- the component type binding, or
null if this is
not an array type -
Since:
- 3.2
getDeclaredFields
IVariableBinding[] getDeclaredFields()
- Returns a list of bindings representing all the fields declared
as members of this class, interface, or enum type.
These include public, protected, default (package-private) access,
and private fields declared by the class, but excludes inherited fields.
Synthetic fields may or may not be included. Fields from binary types that
reference unresolvable types may not be included.
Returns an empty list if the class, interface, or enum declares no fields,
and for other kinds of type bindings that do not directly have members.
The resulting bindings are in no particular order.
-
-
-
Returns:
- the list of bindings for the field members of this type,
or the empty list if this type does not have field members
getDeclaredMethods
IMethodBinding[] getDeclaredMethods()
- Returns a list of method bindings representing all the methods and
constructors declared for this class, interface, enum, or annotation
type.
These include public, protected, default (package-private) access,
and private methods Synthetic methods and constructors may or may not be
included. Returns an empty list if the class, interface, or enum,
type declares no methods or constructors, if the annotation type declares
no members, or if this type binding represents some other kind of type
binding. Methods from binary types that reference unresolvable types may
not be included.
The resulting bindings are in no particular order.
-
-
-
Returns:
- the list of method bindings for the methods and constructors
declared by this class, interface, enum type, or annotation type,
or the empty list if this type does not declare any methods or constructors
getDeclaredModifiers
int getDeclaredModifiers()
- Returns the declared modifiers for this class or interface binding
as specified in the original source declaration of the class or
interface. The result may not correspond to the modifiers in the compiled
binary, since the compiler may change them (in particular, for inner
class emulation). The
getModifiers method should be used if
the compiled modifiers are needed. Returns -1 if this type does not
represent a class or interface.
-
-
-
Returns:
- the bit-wise or of
Modifier constants -
See Also:
-
getModifiers() ,
Modifier
getDeclaredTypes
ITypeBinding[] getDeclaredTypes()
- Returns a list of type bindings representing all the types declared as
members of this class, interface, or enum type.
These include public, protected, default (package-private) access,
and private classes, interfaces, enum types, and annotation types
declared by the type, but excludes inherited types. Returns an empty
list if the type declares no type members, or if this type
binding represents an array type, a primitive type, a type variable,
a wildcard type, a capture, or the null type.
The resulting bindings are in no particular order.
-
-
-
Returns:
- the list of type bindings for the member types of this type,
or the empty list if this type does not have member types
getDeclaringClass
ITypeBinding getDeclaringClass()
- Returns the type binding representing the class, interface, or enum
that declares this binding.
The declaring class of a member class, interface, enum, annotation
type is the class, interface, or enum type of which it is a member.
The declaring class of a local class or interface (including anonymous
classes) is the innermost class or interface containing the expression
or statement in which this type is declared.
The declaring class of a type variable is the class in which the type
variable is declared if it is declared on a type. It returns
null otherwise.
The declaring class of a capture binding is the innermost class or
interface containing the expression or statement in which this capture is
declared.
Array types, primitive types, the null type, top-level types,
wildcard types, recovered binding have no declaring class.
-
-
-
Returns:
- the binding of the type that declares this type, or
null if none
getDeclaringMethod
IMethodBinding getDeclaringMethod()
- Returns the method binding representing the method that declares this binding
of a local type or type variable.
The declaring method of a local class or interface (including anonymous
classes) is the innermost method containing the expression or statement in
which this type is declared. Returns null if the type
is declared in an initializer.
The declaring method of a type variable is the method in which the type
variable is declared if it is declared on a method. It
returns null otherwise.
Array types, primitive types, the null type, top-level types,
wildcard types, capture bindings, and recovered binding have no
declaring method.
-
-
-
Returns:
- the binding of the method that declares this type, or
null if none -
Since:
- 3.1
getDimensions
int getDimensions()
- Returns the dimensionality of this array type, or
0 if this
is not an array type binding.
-
-
-
Returns:
- the number of dimension of this array type binding, or
0 if this is not an array type
getElementType
ITypeBinding getElementType()
- Returns the binding representing the element type of this array type,
or
null if this is not an array type binding. The element
type of an array is never itself an array type.
-
-
-
Returns:
- the element type binding, or
null if this is
not an array type
getErasure
ITypeBinding getErasure()
- Returns the erasure of this type binding.
- For parameterized types (
isParameterizedType() )
- returns the binding for the corresponding generic type.
- For raw types (
isRawType() )
- returns the binding for the corresponding generic type.
- For wildcard types (
isWildcardType() )
- returns the binding for the upper bound if it has one and
java.lang.Object in other cases.
- For type variables (
isTypeVariable() )
- returns the binding for the erasure of the leftmost bound
if it has bounds and java.lang.Object if it does not.
- For captures (
isCapture() )
- returns the binding for the erasure of the leftmost bound
if it has bounds and java.lang.Object if it does not.
- For array types (
isArray() ) - returns an array type of
the same dimension (
getDimensions() ) as this type
binding for which the element type is the erasure of the element type
(
getElementType() ) of this type binding.
- For all other type bindings - returns the identical binding.
-
-
-
Returns:
- the erasure type binding
-
Since:
- 3.1
getInterfaces
ITypeBinding[] getInterfaces()
- Returns a list of type bindings representing the direct superinterfaces
of the class, interface, or enum type represented by this type binding.
If this type binding represents a class or enum type, the return value
is an array containing type bindings representing all interfaces
directly implemented by this class. The number and order of the interface
objects in the array corresponds to the number and order of the interface
names in the implements clause of the original declaration
of this type.
If this type binding represents an interface, the array contains
type bindings representing all interfaces directly extended by this
interface. The number and order of the interface objects in the array
corresponds to the number and order of the interface names in the
extends clause of the original declaration of this interface.
If the class or enum implements no interfaces, or the interface extends
no interfaces, or if this type binding represents an array type, a
primitive type, the null type, a type variable, an annotation type,
a wildcard type, or a capture binding, this method returns an array of
length 0.
-
-
-
Returns:
- the list of type bindings for the interfaces extended by this
class or enum, or interfaces extended by this interface, or otherwise
the empty list
getModifiers
int getModifiers()
- Returns the compiled modifiers for this class, interface, enum,
or annotation type binding.
The result may not correspond to the modifiers as declared in the
original source, since the compiler may change them (in particular,
for inner class emulation). The
getDeclaredModifiers method
should be used if the original modifiers are needed.
Returns 0 if this type does not represent a class, an interface, an enum, an annotation
type or a recovered type.
-
-
Specified by:
-
getModifiers
in interface
IBinding
-
-
Returns:
- the compiled modifiers for this type binding or 0
if this type does not represent a class, an interface, an enum, an annotation
type or a recovered type.
-
See Also:
-
getDeclaredModifiers()
getName
String getName()
- Returns the unqualified name of the type represented by this binding
if it has one.
- For top-level types, member types, and local types,
the name is the simple name of the type.
Example:
"String" or "Collection" .
Note that the type parameters of a generic type are not included.
- For primitive types, the name is the keyword for the primitive type.
Example:
"int" .
- For the null type, the name is the string "null".
- For anonymous classes, which do not have a name,
this method returns an empty string.
- For array types, the name is the unqualified name of the component
type (as computed by this method) followed by "[]".
Example:
"String[]" . Note that the component type is never an
an anonymous class.
- For type variables, the name is just the simple name of the
type variable (type bounds are not included).
Example:
"X" .
- For type bindings that correspond to particular instances of a generic
type arising from a parameterized type reference,
the name is the unqualified name of the erasure type (as computed by this method)
followed by the names (again, as computed by this method) of the type arguments
surrounded by "<>" and separated by ",".
Example:
"Collection<String>" .
- For type bindings that correspond to particular instances of a generic
type arising from a raw type reference, the name is the unqualified name of
the erasure type (as computed by this method).
Example:
"Collection" .
- For wildcard types, the name is "?" optionally followed by
a single space followed by the keyword "extends" or "super"
followed a single space followed by the name of the bound (as computed by
this method) when present.
Example:
"? extends InputStream" .
- Capture types do not have a name. For these types,
and array types thereof, this method returns an empty string.
-
-
Specified by:
-
getName
in interface
IBinding
-
-
Returns:
- the unqualified name of the type represented by this binding,
or the empty string if it has none
-
See Also:
-
getQualifiedName()
getPackage
IPackageBinding getPackage()
- Returns the binding for the package in which this type is declared.
The package of a recovered type reference binding is either
the package of the enclosing type, or, if the type name is the name of a
well-known type,
the package of the matching well-known type.
-
-
-
Returns:
- the binding for the package in which this class, interface,
enum, or annotation type is declared, or
null if this type
binding represents a primitive type, an array type, the null type,
a type variable, a wildcard type, a capture binding.
getQualifiedName
String getQualifiedName()
- Returns the fully qualified name of the type represented by this
binding if it has one.
- For top-level types, the fully qualified name is the simple name of
the type preceded by the package name (or unqualified if in a default package)
and a ".".
Example:
"java.lang.String" or "java.util.Collection" .
Note that the type parameters of a generic type are not included.
- For members of top-level types, the fully qualified name is the
simple name of the type preceded by the fully qualified name of the
enclosing type (as computed by this method) and a ".".
Example:
"java.io.ObjectInputStream.GetField" .
If the binding is for a member type that corresponds to a particular instance
of a generic type arising from a parameterized type reference, the simple
name of the type is followed by the fully qualified names of the type arguments
(as computed by this method) surrounded by "<>" and separated by ",".
Example: "pkg.Outer.Inner<java.lang.String>" .
- For primitive types, the fully qualified name is the keyword for
the primitive type.
Example:
"int" .
- For the null type, the fully qualified name is the string
"null".
- Local types (including anonymous classes) and members of local
types do not have a fully qualified name. For these types, and array
types thereof, this method returns an empty string.
- For array types whose component type has a fully qualified name,
the fully qualified name is the fully qualified name of the component
type (as computed by this method) followed by "[]".
Example:
"java.lang.String[]" .
- For type variables, the fully qualified name is just the name of the
type variable (type bounds are not included).
Example:
"X" .
- For type bindings that correspond to particular instances of a generic
type arising from a parameterized type reference,
the fully qualified name is the fully qualified name of the erasure
type followed by the fully qualified names of the type arguments surrounded by "<>" and separated by ",".
Example:
"java.util.Collection<java.lang.String>" .
- For type bindings that correspond to particular instances of a generic
type arising from a raw type reference,
the fully qualified name is the fully qualified name of the erasure type.
Example:
"java.util.Collection" . Note that the
the type parameters are omitted.
- For wildcard types, the fully qualified name is "?" optionally followed by
a single space followed by the keyword "extends" or "super"
followed a single space followed by the fully qualified name of the bound
(as computed by this method) when present.
Example:
"? extends java.io.InputStream" .
- Capture types do not have a fully qualified name. For these types,
and array types thereof, this method returns an empty string.
-
-
-
Returns:
- the fully qualified name of the type represented by this
binding, or the empty string if it has none
-
Since:
- 2.1
-
See Also:
-
getName()
getSuperclass
ITypeBinding getSuperclass()
- Returns the type binding for the superclass of the type represented
by this class binding.
If this type binding represents any class other than the class
java.lang.Object , then the type binding for the direct
superclass of this class is returned. If this type binding represents
the class java.lang.Object , then null is
returned.
Loops that ascend the class hierarchy need a suitable termination test.
Rather than test the superclass for null , it is more
transparent to check whether the class is Object , by
comparing whether the class binding is identical to
ast.resolveWellKnownType("java.lang.Object") .
If this type binding represents an interface, an array type, a
primitive type, the null type, a type variable, an enum type,
an annotation type, a wildcard type, or a capture binding then
null is returned.
-
-
-
Returns:
- the superclass of the class represented by this type binding,
or
null if none -
See Also:
-
AST.resolveWellKnownType(String)
getTypeArguments
ITypeBinding[] getTypeArguments()
- Returns the type arguments of this generic type instance, or the
empty list for other type bindings.
Note that type arguments only occur on a type binding that represents
an instance of a generic type corresponding to a parameterized type
reference (e.g., Collection<String> ).
Do not confuse these with type parameters which only occur on the
type binding corresponding directly to the declaration of the
generic class or interface (e.g., Collection<T> ).
-
-
-
Returns:
- the list of type bindings for the type arguments used to
instantiate the corresponding generic type, or otherwise the empty list
-
Since:
- 3.1
-
See Also:
-
getTypeDeclaration() ,
isGenericType() ,
isParameterizedType() ,
isRawType()
getTypeBounds
ITypeBinding[] getTypeBounds()
- Returns the declared type bounds of this type variable or capture. If the
variable or the capture had no explicit bound, then it returns an empty list.
Note that per construction, it can only contain one class or array type,
at most, and then it is located in first position.
Also note that array type bound may only occur in the case of a capture
binding, e.g. capture-of ? extends Object[]
-
-
-
Returns:
- the list of type bindings for this type variable or capture,
or otherwise the empty list
-
Since:
- 3.1
-
See Also:
-
isCapture() ,
isTypeVariable()
getTypeDeclaration
ITypeBinding getTypeDeclaration()
- Returns the binding for the type declaration corresponding to this type
binding.
For parameterized types (
isParameterizedType() )
and most raw types (
isRawType() ), this method returns the binding
for the corresponding generic type.
For raw member types (
isRawType() ,
isMember() )
of a raw declaring class, the type declaration is a generic or a non-generic
type.
A different non-generic binding will be returned when one of the declaring
types/methods was parameterized.
For other type bindings, this returns the same binding.
-
-
-
Returns:
- the type binding
-
Since:
- 3.1
getTypeParameters
ITypeBinding[] getTypeParameters()
- Returns the type parameters of this class or interface type binding.
Note that type parameters only occur on the binding of the
declaring generic class or interface; e.g., Collection<T> .
Type bindings corresponding to a raw or parameterized reference to a generic
type do not carry type parameters (they instead have non-empty type arguments
and non-trivial erasure).
-
-
-
Returns:
- the list of binding for the type variables for the type
parameters of this type, or otherwise the empty list
-
Since:
- 3.1
-
See Also:
-
isTypeVariable()
getWildcard
ITypeBinding getWildcard()
- Returns the corresponding wildcard binding of this capture binding.
Returns
null if this type bindings does not represent
a capture binding.
-
-
-
Returns:
- the corresponding wildcard binding for a capture
binding,
null otherwise -
Since:
- 3.1
isAnnotation
boolean isAnnotation()
- Returns whether this type binding represents an annotation type.
Note that an annotation type is always an interface.
-
-
-
Returns:
-
true if this object represents an annotation type,
and false otherwise -
Since:
- 3.1
isAnonymous
boolean isAnonymous()
- Returns whether this type binding represents an anonymous class.
An anonymous class is a subspecies of local class, and therefore mutually
exclusive with member types. Note that anonymous classes have no name
(getName returns the empty string).
-
-
-
Returns:
-
true if this type binding is for an anonymous class,
and false otherwise
isArray
boolean isArray()
- Returns whether this type binding represents an array type.
-
-
-
Returns:
-
true if this type binding is for an array type,
and false otherwise -
See Also:
-
getElementType() ,
getDimensions()
isAssignmentCompatible
boolean isAssignmentCompatible(
ITypeBinding variableType)
- Returns whether an expression of this type can be assigned to a variable
of the given type, as specified in section 5.2 of The Java Language
Specification, Third Edition (JLS3).
If the receiver or the argument is a recovered type, the answer is always false,
unless the two types are identical or the argument is java.lang.Object .
-
-
-
Parameters:
-
variableType - the type of a variable to check compatibility against
-
Returns:
-
true if an expression of this type can be assigned to a
variable of the given type, and false otherwise -
Since:
- 3.1
isCapture
boolean isCapture()
- Returns whether this type binding represents a capture binding.
Capture bindings result from capture conversion as specified
in section 5.1.10 of The Java Language Specification,
Third Edition (JLS3).
A capture binding may have upper bounds and a lower bound.
Upper bounds may be accessed using
getTypeBounds() ,
the lower bound must be accessed indirectly through the associated
wildcard
getWildcard() when it is a lower bound wildcard.
Note that capture bindings are distinct from type variables
(even though they are often depicted as synthetic type
variables); as such,
isTypeVariable() answers
false for capture bindings, and
isCapture() answers false for type variables.
-
-
-
Returns:
-
true if this type binding is a capture,
and false otherwise -
Since:
- 3.1
-
See Also:
-
getTypeBounds() ,
getWildcard()
isCastCompatible
boolean isCastCompatible(
ITypeBinding type)
- Returns whether this type is cast compatible with the given type,
as specified in section 5.5 of The Java Language
Specification, Third Edition (JLS3).
NOTE: The cast compatibility check performs backwards.
When testing whether type B can be cast to type A, one would use:
A.isCastCompatible(B)
If the receiver or the argument is a recovered type, the answer is always false,
unless the two types are identical or the argument is java.lang.Object .
-
-
-
Parameters:
-
type - the type to check compatibility against
-
Returns:
-
true if this type is cast compatible with the
given type, and false otherwise -
Since:
- 3.1
isClass
boolean isClass()
- Returns whether this type binding represents a class type or a recovered binding.
-
-
-
Returns:
-
true if this object represents a class or a recovered binding,
and false otherwise
isEnum
boolean isEnum()
- Returns whether this type binding represents an enum type.
-
-
-
Returns:
-
true if this object represents an enum type,
and false otherwise -
Since:
- 3.1
isFromSource
boolean isFromSource()
- Returns whether this type binding originated in source code.
Returns
false for all primitive types, the null type,
array types, and for all classes, interfaces, enums, annotation
types, type variables, parameterized type references,
raw type references, wildcard types, and capture bindings
whose information came from a pre-compiled binary class file.
-
-
-
Returns:
-
true if the type is in source code,
and false otherwise
isGenericType
boolean isGenericType()
- Returns whether this type binding represents a declaration of
a generic class or interface.
Note that type parameters only occur on the binding of the
declaring generic class or interface; e.g., Collection<T> .
Type bindings corresponding to a raw or parameterized reference to a generic
type do not carry type parameters (they instead have non-empty type arguments
and non-trivial erasure).
This method is fully equivalent to getTypeParameters().length > 0) .
Note that
isGenericType() ,
isParameterizedType() ,
and
isRawType() are mutually exclusive.
-
-
-
Returns:
-
true if this type binding represents a
declaration of a generic class or interface, and false otherwise -
Since:
- 3.1
-
See Also:
-
getTypeParameters()
isInterface
boolean isInterface()
- Returns whether this type binding represents an interface type.
Note that an interface can also be an annotation type.
-
-
-
Returns:
-
true if this object represents an interface,
and false otherwise
isLocal
boolean isLocal()
- Returns whether this type binding represents a local class.
A local class is any nested class or enum type not declared as a member
of another class or interface. A local class is a subspecies of nested
type, and mutually exclusive with member types. Note that anonymous
classes are a subspecies of local classes.
Also note that interfaces and annotation types cannot be local.
-
-
-
Returns:
-
true if this type binding is for a local class or
enum type, and false otherwise
isMember
boolean isMember()
- Returns whether this type binding represents a member class or
interface.
A member type is any type declared as a member of
another type. A member type is a subspecies of nested
type, and mutually exclusive with local types.
-
-
-
Returns:
-
true if this type binding is for a member class,
interface, enum, or annotation type, and false otherwise
isNested
boolean isNested()
- Returns whether this type binding represents a nested class, interface,
enum, or annotation type.
A nested type is any type whose declaration occurs within
the body of another. The set of nested types is disjoint from the set of
top-level types. Nested types further subdivide into member types, local
types, and anonymous types.
-
-
-
Returns:
-
true if this type binding is for a nested class,
interface, enum, or annotation type, and false otherwise
isNullType
boolean isNullType()
- Returns whether this type binding represents the null type.
The null type is the type of a NullLiteral node.
-
-
-
Returns:
-
true if this type binding is for the null type,
and false otherwise
isParameterizedType
boolean isParameterizedType()
- Returns whether this type binding represents an instance of
a generic type corresponding to a parameterized type reference.
For example, an AST type like
Collection<String> typically resolves to a
type binding whose type argument is the type binding for the
class java.lang.String and whose erasure is the type
binding for the generic type java.util.Collection .
Note that
isGenericType() ,
isParameterizedType() ,
and
isRawType() are mutually exclusive.
-
-
-
Returns:
-
true if this type binding represents a
an instance of a generic type corresponding to a parameterized
type reference, and false otherwise -
Since:
- 3.1
-
See Also:
-
getTypeArguments() ,
getTypeDeclaration()
isPrimitive
boolean isPrimitive()
- Returns whether this type binding represents a primitive type.
There are nine predefined type bindings to represent the eight primitive
types and void . These have the same names as the primitive
types that they represent, namely boolean, byte, char, short, int,
long, float, and double, and void.
-
-
-
Returns:
-
true if this type binding is for a primitive type,
and false otherwise
isRawType
boolean isRawType()
- Returns whether this type binding represents an instance of
a generic type corresponding to a raw type reference.
For example, an AST type like
Collection typically resolves to a
type binding whose type argument is the type binding for
the class java.lang.Object (the
default bound for the single type parameter of
java.util.Collection ) and whose erasure is the
type binding for the generic type
java.util.Collection .
Note that
isGenericType() ,
isParameterizedType() ,
and
isRawType() are mutually exclusive.
-
-
-
Returns:
-
true if this type binding represents a
an instance of a generic type corresponding to a raw
type reference, and false otherwise -
Since:
- 3.1
-
See Also:
-
getTypeDeclaration() ,
getTypeArguments()
isSubTypeCompatible
boolean isSubTypeCompatible(
ITypeBinding type)
- Returns whether this type is subtype compatible with the given type,
as specified in section 4.10 of The Java Language
Specification, Third Edition (JLS3).
If the receiver or the argument is a recovered type, the answer is always false,
unless the two types are identical or the argument is java.lang.Object .
-
-
-
Parameters:
-
type - the type to check compatibility against
-
Returns:
-
true if this type is subtype compatible with the
given type, and false otherwise -
Since:
- 3.1
isTopLevel
boolean isTopLevel()
- Returns whether this type binding represents a top-level class,
interface, enum, or annotation type.
A top-level type is any type whose declaration does not occur within the
body of another type declaration. The set of top level types is disjoint
from the set of nested types.
-
-
-
Returns:
-
true if this type binding is for a top-level class,
interface, enum, or annotation type, and false otherwise
isTypeVariable
boolean isTypeVariable()
- Returns whether this type binding represents a type variable.
Type variables bindings carry the type variable's bounds.
Note that type variables are distinct from capture bindings
(even though capture bindings are often depicted as synthetic
type variables); as such,
isTypeVariable() answers
false for capture bindings, and
isCapture() answers false for type variables.
-
-
-
Returns:
-
true if this type binding is for a type variable,
and false otherwise -
Since:
- 3.1
-
See Also:
-
getName() ,
getTypeBounds()
isUpperbound
boolean isUpperbound()
- Returns whether this wildcard type is an upper bound
("extends") as opposed to a lower bound ("super").
Note that this property is only relevant for wildcards
that have a bound.
-
-
-
Returns:
-
true if this wildcard type has a bound that is
an upper bound, and false in all other cases -
Since:
- 3.1
-
See Also:
-
isWildcardType() ,
getBound()
isWildcardType
boolean isWildcardType()
- Returns whether this type binding represents a wildcard type. A wildcard
type occus only as an argument to a parameterized type reference.
For example, a AST type like
Collection<? extends Object> typically resolves to a
parameterized type binding whose type argument is a wildcard type
with upper type bound java.util.Object .
-
-
-
Returns:
-
true if this object represents a wildcard type,
and false otherwise -
Since:
- 3.1
-
See Also:
-
getBound() ,
isUpperbound()
Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.
|
|
|