blob: 96c3efbe8d4d92a0034ab1b8bd73e0b957f114b5 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.core.dom;
/**
* A type binding represents a class type, interface type, array type, a
* primitive type (including the special return type <code>void</code>), the
* null type, or a type variable.
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* Note: Support for generic types is an experimental language feature
* under discussion in JSR-014 and under consideration for inclusion
* in the 1.5 release of J2SE. The support here is therefore tentative
* and subject to change.
* </p>
*
* @see ITypeBinding#getDeclaredTypes()
* @since 2.0
*/
public interface ITypeBinding extends IBinding {
/**
* Returns the binary name of this type binding.
* The binary name of a class is defined in the Java Language
* Specification 2nd edition, section 13.1.
* <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
* @since 3.0
*/
public String getBinaryName();
/**
* 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>
* <p>
* The set of primitive types is mutually exclusive with the sets of
* array types, with the sets of class and interface types, with the null
* type, and with type variables.
* </p>
*
* @return <code>true</code> if this type binding is for a primitive type,
* and <code>false</code> otherwise
*
* @see #isArray()
* @see #isClass()
* @see #isInterface()
*/
public boolean isPrimitive();
/**
* Returns whether this type binding represents the null type.
* <p>
* The null type is the type of a <code>NullLiteral</code> node.
* </p>
* <p>
* The null type is mutually exclusive with the sets of
* array types, with the sets of class and interface types,
* with the set of primitive types, and with the set of type variables.
* </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 an array type.
* <p>
* The set of array types is mutually exclusive with the sets of
* primitive types, with the sets of class and interface types,
* with the null type, and with the set of type variables.
* </p>
*
* @return <code>true</code> if this type binding is for an array type,
* and <code>false</code> otherwise
* @see #isClass()
* @see #isInterface()
* @see #isPrimitive()
*/
public boolean isArray();
/**
* Returns whether this type binding represents a type variable.
* <p>
* A type variables is declared in <code>TypeParameter</code> node.
* </p>
* <p>
* Type variables are mutually exclusive with the sets of
* array types, with the sets of class and interface types,
* with the set of primitive types, and with the null type.
* </p>
* <p>
* Note: Support for generic types is an experimental language feature
* under discussion in JSR-014 and under consideration for inclusion
* in the 1.5 release of J2SE. The support here is therefore tentative
* and subject to change.
* </p>
*
* @return <code>true</code> if this type binding is for a type variable,
* and <code>false</code> otherwise
* @since 3.0
*/
public boolean isTypeVariable();
/**
* 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 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 whether this type binding represents a class type.
* <p>
* The set of class types is mutually exclusive with the sets of
* primive types, array types, interface types, the null type,
* and with the set of type variables.
* </p>
*
* @return <code>true</code> if this object represents a class,
* and <code>false</code> otherwise
*
* @see #isArray()
* @see #isInterface()
* @see #isPrimitive()
*/
public boolean isClass();
/**
* Returns whether this type binding represents an interface type.
* <p>
* The set of interface types is mutually exclusive with the sets of
* primive types, array types, class types, the null type,
* and with the set of type variables.
* </p>
*
* @return <code>true</code> if this object represents an interface,
* and <code>false</code> otherwise
*
* @see #isArray()
* @see #isClass()
* @see #isPrimitive()
*/
public boolean isInterface();
/**
* Returns the unqualified name of the type represented by this binding.
* <p>
* For named classes and interfaces, this is the simple name of the type.
* For primitive types, the name is the keyword for the primitive type. For array
* types, the name is the unqualified name of the component type followed by "[]".
* If this represents an anonymous class, it returns an empty string (note that
* it is impossible to have an array type with an anonymous class as element type).
* For the null type, it returns "null".
* For type variables, this is the name of the type variable.
* </p>
*
* @return the unqualified name of the type represented by this binding, an
* empty string this is an anonymous type, or "null" for the null type
* @see #getQualifiedName()
*/
public String getName();
/**
* Returns the binding for the package in which this class or interface is
* declared.
*
* @return the binding for the package in which this class or interface is
* declared, or <code>null</code> if this type binding represents a
* primitive type, an array type, the null type, or a type variable
*/
public IPackageBinding getPackage();
/**
* Returns the type binding representing the class or interface
* that declares this binding.
* <p>
* The declaring class of a member class or interface is the class or
* interface 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. Array types, primitive types, the null type, top-level types,
* and type variables have no declaring class.
* </p>
*
* @return the binding of the class or interface that declares this type,
* or <code>null</code> if none
*/
public ITypeBinding getDeclaringClass();
/**
* 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, or a type variable, 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 a list of type bindings representing the direct superinterfaces
* of the class or interface represented by this type binding.
* <p>
* If this type binding represents a class, 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
* <code>implements</code> clause of the original declaration of this class.
* </p>
* <p>
* 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
* <code>extends</code> clause of the original declaration of this interface.
* </p>
* <p>
* If the class implements no interfaces, or the interface extends no
* interfaces, or if this type binding represents an array type, a
* primitive type, the null type, or a type variable, this method returns
* an array of length 0.
* </p>
*
* @return the list of type bindings for the interfaces extended by this
* class, or interfaces extended by this interface, or otherwise the
* empty list
*/
public ITypeBinding[] getInterfaces();
/**
* Returns the compiled modifiers for this class or interface 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 <code>getDeclaredModifiers</code> method
* should be used if the original modifiers are needed.
* Returns 0 if this type does not represent a class or interface.
*
* @return the compiled modifiers for this class or interface binding or 0
* if this type does not represent a class or interface
* @see #getDeclaredModifiers()
*/
public int getModifiers();
/**
* 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 <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 whether this type binding represents a top-level class or
* interface.
* <p>
* A top-level type is any class or interface whose declaration does not
* occur within the body of another class or interface. 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
* or interface, and <code>false</code> otherwise
*/
public boolean isTopLevel();
/**
* Returns whether this type binding represents a nested class or
* interface.
* <p>
* A nested type is any class or interface whose declaration occurs within
* the body of another class or interface. 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
* or interface, and <code>false</code> otherwise
*/
public boolean isNested();
/**
* Returns whether this type binding represents a member class or
* interface.
* <p>
* A member type is any class or interface declared as a member of
* another class or interface. 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
* or interface, and <code>false</code> otherwise
*/
public boolean isMember();
/**
* Returns whether this type binding represents a local class.
* <p>
* A local class is any nested class 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 an interface cannot be local.
* </p>
*
* @return <code>true</code> if this type binding is for a local class,
* and <code>false</code> otherwise
*/
public boolean isLocal();
/**
* 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 a list of type bindings representing all the classes
* and interfaces declared as members of this class or interface type.
* These include public, protected, default (package-private) access,
* and private classes and interfaces declared by the class, but excludes
* inherited classes and interfaces. Returns an empty list if the
* class declares no classes or interfaces as members, or if this type
* binding represents an array type, a primitive type, 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 a list of bindings representing all the fields declared
* as members of this class or interface. 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.
* Returns an empty list if the class or interface declares no fields,
* or if this type binding represents a primitive type or an array type
* (the implicit <code>length</code> field of array types is not considered
* to be a declared field). The resulting bindings are in no particular
* order.
*
* @return the list of bindings for the field members of this type,
* or the empty list if this type does not have field members or is an
* array type, primitive type, or the null type
*/
public IVariableBinding[] getDeclaredFields();
/**
* Returns a list of method bindings representing all the methods and
* constructors declared for this class or interface. 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 or interface declares no methods or
* constructors, or if this type binding represents an array type, a
* primitive type, the null type, or a type variable.
* The resulting bindings are in no particular order.
*
* @return the list of method bindings for the methods and constructors
* declared by this class or interface, or the empty list if this type does
* not declare any methods or constructors
*/
public IMethodBinding[] getDeclaredMethods();
/**
* Returns whether this type binding originated in source code.
* Returns <code>false</code> for primitive types, the null type, array types,
* and classes, interfaces, and type variables 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 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 qualified by the package name (or unqualified if in a default
* package).
* Example: <code>"java.lang.String"</code>.</li>
* <li>For members of top-level types, the fully qualified name is the
* simple name of the type qualified by the fully qualified name of the
* enclosing type.
* Example: <code>"java.io.ObjectInputStream.GetField"</code>.</li>
* <li>For primitive types, the fully qualified name is the keyword for
* the primitive type.
* Example: <code>"int"</code>.</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 followed by "[]".
* Example: <code>"java.lang.String[]"</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 type variables, the fully qualified name is just the name of the
* type variable.
* Example: <code>"X"</code>.</li>
* </ul>
*
* @return the fully qualified name of the type represented by this
* binding, or an empty string if this type does not have such an
* unambiguous name
* @see #getName()
* @since 2.1
*/
public String getQualifiedName();
}