/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.jsdt.core.dom;
/**
* A type binding represents fully-resolved type. There are a number of
* different kinds of type bindings:
* <ul>
* <li>a class - represents the class declaration;
* possibly with type parameters</li>
* <li>an interface - represents the class declaration;
* possibly with type parameters</li>
* <li>an enum - represents the enum declaration (enum types do not have
* have type parameters)</li>
* <li>an annotation - represents the annotation type declaration
* (annotation types do not have have type parameters)</li>
* <li>an array type - array types are referenced but not explicitly
* declared</li>
* <li>a primitive type (including the special return type <code>void</code>)
* - primitive types are referenced but not explicitly declared</li>
* <li>the null type - this is the special type of <code>null</code></li>
* <li>a type variable - represents the declaration of a type variable;
* possibly with type bounds</li>
* <li>a raw type - represents a legacy non-parameterized reference to
* a generic type</li>
* <li>a parameterized type - represents an copy of a type declaration
* with substitutions for its type parameters</li>
* <li>a capture - represents a capture binding</li>
* </ul>
* <p>
* This interface is not intended to be implemented by clients.
* </p>
*
* @see ITypeBinding#getDeclaredTypes()
*
* Provisional API: This class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early stage to solicit feedback
* from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
* (repeatedly) as the API evolves.
*/
public interface ITypeBinding extends IBinding {
/**
* Answer an array type binding using the receiver and the given dimension.
*
* <p>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.</p>
*
* @param dimension the given dimension
* @return an array type binding
* @throws IllegalArgumentException:<ul>
* <li>if the receiver represents the void type</li>
* <li>if the resulting dimensions is lower than one or greater than 255</li>
* </ul>
*
*/
public ITypeBinding createArrayType(int dimension);
/**
* Returns the binary name of this type binding.
* <p>
* Note that in some cases, the binary name may be unavailable.
* This may happen, for example, for a local type declared in
* unreachable code.
* </p>
*
* @return the binary name of this type, or <code>null</code>
* if the binary name is unknown
*
*/
public String getBinaryName();
/**
* Returns the binding representing the component type of this array type,
* or <code>null</code> if this is not an array type binding. The component
* type of an array might be an array type.
* <p>This is subject to change before 3.2 release.</p>
*
* @return the component type binding, or <code>null</code> if this is
* not an array type
*
*/
public ITypeBinding getComponentType();
/**
* Returns a list of bindings representing all the fields declared
* as members of this class, interface, or enum type.
*
* <p>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.</p>
*
* <p>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.</p>
*
* <p>The resulting bindings are in no particular order.</p>
*
* @return the list of bindings for the field members of this type,
* or the empty list if this type does not have field members
*/
public IVariableBinding[] getDeclaredFields();
/**
* Returns a list of method bindings representing all the methods and
* constructors declared for this class, interface, enum, or annotation
* type.
* <p>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.</p>
* <p>The resulting bindings are in no particular order.</p>
*
* @return 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
*/
public IFunctionBinding[] getDeclaredMethods();
/**
* 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 validator may change them (in particular, for inner
* class emulation). The <code>getModifiers</code> method should be used if
* the compiled modifiers are needed. Returns -1 if this type does not
* represent a class or interface.
*
* @return the bit-wise or of <code>Modifier</code> constants
* @see #getModifiers()
* @see Modifier
*/
public int getDeclaredModifiers();
/**
* 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 capture, or the null type.
* The resulting bindings are in no particular order.
*
* @return the list of type bindings for the member types of this type,
* or the empty list if this type does not have member types
*/
public ITypeBinding[] getDeclaredTypes();
/**
* Returns the type binding representing the class, interface, or enum
* that declares this binding.
* <p>
* 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.
* </p>
* <p>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
* <code>null</code> otherwise.
* </p>
* <p>The declaring class of a capture binding is the innermost class or
* interface containing the expression or statement in which this capture is
* declared.
* </p>
* <p>Array types, primitive types, the null type, top-level types,
* recovered binding have no declaring class.
* </p>
*
* @return the binding of the type that declares this type, or
* <code>null</code> if none
*/
public ITypeBinding getDeclaringClass();
/**
* Returns the method binding representing the method that declares this binding
* of a local type or type variable.
* <p>
* 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 <code>null</code> if the type
* is declared in an initializer.
* </p>
* <p>
* 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 <code>null</code> otherwise.
* </p>
* <p>Array types, primitive types, the null type, top-level types,
* capture bindings, and recovered binding have no
* declaring method.
* </p>
*
* @return the binding of the method that declares this type, or
* <code>null</code> if none
*
*/
public IFunctionBinding getDeclaringMethod();
/**
* Returns the dimensionality of this array type, or <code>0</code> if this
* is not an array type binding.
*
* @return the number of dimension of this array type binding, or
* <code>0</code> if this is not an array type
*/
public int getDimensions();
/**
* Returns the binding representing the element type of this array type,
* or <code>null</code> if this is not an array type binding. The element
* type of an array is never itself an array type.
*
* @return the element type binding, or <code>null</code> if this is
* not an array type
*/
public ITypeBinding getElementType();
/**
* Returns the erasure of this type binding.
* <ul>
* <li>For parameterized types ({@link #isParameterizedType()})
* - returns the binding for the corresponding generic type.</li>
* <li>For raw types ({@link #isRawType()})
* - returns the binding for the corresponding generic type.</li>
* java.lang.Object in other cases.</li>
* <li>For type variables ({@link #isTypeVariable()})
* - returns the binding for the erasure of the leftmost bound
* if it has bounds and java.lang.Object if it does not.</li>
* <li>For captures ({@link #isCapture()})
* - returns the binding for the erasure of the leftmost bound
* if it has bounds and java.lang.Object if it does not.</li>
* <li>For array types ({@link #isArray()}) - returns an array type of
* the same dimension ({@link #getDimensions()}) as this type
* binding for which the element type is the erasure of the element type
* ({@link #getElementType()}) of this type binding.</li>
* <li>For all other type bindings - returns the identical binding.</li>
* </ul>
*
* @return the erasure type binding
*
*/
public ITypeBinding getErasure();
/**
* 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 validator may change them (in particular,
* for inner class emulation). The <code>getDeclaredModifiers</code> 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.
*
* @return 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 #getDeclaredModifiers()
*/
public int getModifiers();
/**
* Returns the unqualified name of the type represented by this binding
* if it has one.
* <ul>
* <li>For top-level types, member types, and local types,
* the name is the simple name of the type.
* Example: <code>"String"</code> or <code>"Collection"</code>.
* Note that the type parameters of a generic type are not included.</li>
* <li>For primitive types, the name is the keyword for the primitive type.
* Example: <code>"int"</code>.</li>
* <li>For the null type, the name is the string "null".</li>
* <li>For anonymous classes, which do not have a name,
* this method returns an empty string.</li>
* <li>For array types, the name is the unqualified name of the component
* type (as computed by this method) followed by "[]".
* Example: <code>"String[]"</code>. Note that the component type is never an
* an anonymous class.</li>
* <li>For type variables, the name is just the simple name of the
* type variable (type bounds are not included).
* Example: <code>"X"</code>.</li>
* <li>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: <code>"Collection<String>"</code>.
* </li>
* <li>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: <code>"Collection"</code>.</li>
* <li>Capture types do not have a name. For these types,
* and array types thereof, this method returns an empty string.</li>
* </ul>
*
* @return the unqualified name of the type represented by this binding,
* or the empty string if it has none
* @see #getQualifiedName()
*/
public String getName();
/**
* Returns the binding for the package in which this type is declared.
*
* <p>The package of a recovered type reference binding is the package of the
* enclosing type.</p>
*
* @return the binding for the package in which this class, interface,
* enum, or annotation type is declared, or <code>null</code> if this type
* binding represents a primitive type, an array type, the null type,
* a type variable, a capture binding.
*/
public IPackageBinding getPackage();
/**
* Returns the fully qualified name of the type represented by this
* binding if it has one.
* <ul>
* <li>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: <code>"java.lang.String"</code> or <code>"java.util.Collection"</code>.
* Note that the type parameters of a generic type are not included.</li>
* <li>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: <code>"java.io.ObjectInputStream.GetField"</code>.
* 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: <code>"pkg.Outer.Inner<java.lang.String>"</code>.
* </li>
* <li>For primitive types, the fully qualified name is the keyword for
* the primitive type.
* Example: <code>"int"</code>.</li>
* <li>For the null type, the fully qualified name is the string
* "null".</li>
* <li>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.</li>
* <li>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: <code>"java.lang.String[]"</code>.</li>
* <li>For type variables, the fully qualified name is just the name of the
* type variable (type bounds are not included).
* Example: <code>"X"</code>.</li>
* <li>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: <code>"java.util.Collection<java.lang.String>"</code>.
* </li>
* <li>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: <code>"java.util.Collection"</code>. Note that the
* the type parameters are omitted.</li>
* <li>Capture types do not have a fully qualified name. For these types,
* and array types thereof, this method returns an empty string.</li>
* </ul>
*
* @return the fully qualified name of the type represented by this
* binding, or the empty string if it has none
* @see #getName()
*
*/
public String getQualifiedName();
/**
* Returns the type binding for the superclass of the type represented
* by this class binding.
* <p>
* If this type binding represents any class other than the class
* <code>java.lang.Object</code>, then the type binding for the direct
* superclass of this class is returned. If this type binding represents
* the class <code>java.lang.Object</code>, then <code>null</code> is
* returned.
* <p>
* Loops that ascend the class hierarchy need a suitable termination test.
* Rather than test the superclass for <code>null</code>, it is more
* transparent to check whether the class is <code>Object</code>, by
* comparing whether the class binding is identical to
* <code>ast.resolveWellKnownType("java.lang.Object")</code>.
* </p>
* <p>
* 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, or a capture binding then
* <code>null</code> is returned.
* </p>
*
* @return the superclass of the class represented by this type binding,
* or <code>null</code> if none
* @see AST#resolveWellKnownType(String)
*/
public ITypeBinding getSuperclass();
/**
* Returns the binding for the type declaration corresponding to this type
* binding.
* <p>For parameterized types ({@link #isParameterizedType()})
* and most raw types ({@link #isRawType()}), this method returns the binding
* for the corresponding generic type.</p>
* <p>For raw member types ({@link #isRawType()}, {@link #isMember()})
* of a raw declaring class, the type declaration is a generic or a non-generic
* type.</p>
* <p>A different non-generic binding will be returned when one of the declaring
* types/methods was parameterized.</p>
* <p>For other type bindings, this returns the same binding.</p>
*
* @return the type binding
*
*/
public ITypeBinding getTypeDeclaration();
/**
* Returns whether this type binding represents an anonymous class.
* <p>
* An anonymous class is a subspecies of local class, and therefore mutually
* exclusive with member types. Note that anonymous classes have no name
* (<code>getName</code> returns the empty string).
* </p>
*
* @return <code>true</code> if this type binding is for an anonymous class,
* and <code>false</code> otherwise
*/
public boolean isAnonymous();
/**
* Returns whether this type binding represents an array type.
*
* @return <code>true</code> if this type binding is for an array type,
* and <code>false</code> otherwise
* @see #getElementType()
* @see #getDimensions()
*/
public boolean isArray();
/**
* Returns whether an expression of this type can be assigned to a variable
* of the given type.
*
* <p>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 <code>java.lang.Object</code>.</p>
*
* @param variableType the type of a variable to check compatibility against
* @return <code>true</code> if an expression of this type can be assigned to a
* variable of the given type, and <code>false</code> otherwise
*
*/
public boolean isAssignmentCompatible(ITypeBinding variableType);
/**
* Returns whether this type is cast compatible with the given type.
* <p>
* NOTE: The cast compatibility check performs backwards.
* When testing whether type B can be cast to type A, one would use:
* <code>A.isCastCompatible(B)</code>
* </p>
*
* <p>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 <code>java.lang.Object</code>.</p>
*
* @param type the type to check compatibility against
* @return <code>true</code> if this type is cast compatible with the
* given type, and <code>false</code> otherwise
*
*/
public boolean isCastCompatible(ITypeBinding type);
/**
* Returns whether this type binding represents a class type or a recovered binding.
*
* @return <code>true</code> if this object represents a class or a recovered binding,
* and <code>false</code> otherwise
*/
public boolean isClass();
/**
* Returns whether this type binding originated in source code.
* Returns <code>false</code> 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, and capture bindings
* whose information came from a pre-compiled binary class file.
*
* @return <code>true</code> if the type is in source code,
* and <code>false</code> otherwise
*/
public boolean isFromSource();
/**
* Returns whether this type binding represents a local class.
* <p>
* 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.
* </p>
* <p>
* Also note that interfaces and annotation types cannot be local.
* </p>
*
* @return <code>true</code> if this type binding is for a local class or
* enum type, and <code>false</code> otherwise
*/
public boolean isLocal();
/**
* Returns whether this type binding represents a member class or
* interface.
* <p>
* 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.
* </p>
*
* @return <code>true</code> if this type binding is for a member class,
* interface, enum, or annotation type, and <code>false</code> otherwise
*/
public boolean isMember();
/**
* Returns whether this type binding represents a nested class, interface,
* enum, or annotation type.
* <p>
* 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.
* </p>
*
* @return <code>true</code> if this type binding is for a nested class,
* interface, enum, or annotation type, and <code>false</code> otherwise
*/
public boolean isNested();
/**
* Returns whether this type binding represents the null type.
* <p>
* The null type is the type of a <code>NullLiteral</code> node.
* </p>
*
* @return <code>true</code> if this type binding is for the null type,
* and <code>false</code> otherwise
*/
public boolean isNullType();
/**
* Returns whether this type binding represents a primitive type.
* <p>
* There are nine predefined type bindings to represent the eight primitive
* types and <code>void</code>. These have the same names as the primitive
* types that they represent, namely boolean, byte, char, short, int,
* long, float, and double, and void.
* </p>
*
* @return <code>true</code> if this type binding is for a primitive type,
* and <code>false</code> otherwise
*/
public boolean isPrimitive();
/**
* Returns whether this type is subtype compatible with the given type.
*
* <p>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 <code>java.lang.Object</code>.</p>
*
* @param type the type to check compatibility against
* @return <code>true</code> if this type is subtype compatible with the
* given type, and <code>false</code> otherwise
*
*/
public boolean isSubTypeCompatible(ITypeBinding type);
/**
* Returns whether this type binding represents a top-level class,
* interface, enum, or annotation type.
* <p>
* 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.
* </p>
*
* @return <code>true</code> if this type binding is for a top-level class,
* interface, enum, or annotation type, and <code>false</code> otherwise
*/
public boolean isTopLevel();
public boolean isCompilationUnit();
}