Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.dom.ast.cpp
Interface ICPPClassType

All Superinterfaces:
Cloneable, IBinding, ICompositeType, ICPPBinding, IType

public interface ICPPClassType
extends ICompositeType, ICPPBinding

Represents a C++ class.


Field Summary
static ICPPClassType[] EMPTY_CLASS_ARRAY
           
static int k_class
           
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.ICompositeType
k_struct, k_union
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IBinding
EMPTY_BINDING_ARRAY
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IType
EMPTY_TYPE_ARRAY
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IBinding
EMPTY_BINDING_ARRAY
 
Method Summary
 IField findField(String name)
          findField is restated here to point out that this method looks through the inheritance tree of this class while looking for a field with the given name If no field is found, null is returned, if the name is found to be ambiguous a IProblemBinding is returned.
 ICPPMethod[] getAllDeclaredMethods()
          Returns a list of ICPPMethod objects representing all method explicitly declared by this class and inherited from base classes.
 ICPPBase[] getBases()
          Returns a list of base class relationships.
 ICPPConstructor[] getConstructors()
          Returns an array of ICPPConstructor objects representing the contructors for this class.
 ICPPField[] getDeclaredFields()
          Returns a list of ICPPField objects representing fields declared in this class.
 ICPPMethod[] getDeclaredMethods()
          Returns a list of ICPPMethod objects representing all methods explicitly declared by this class.
 IField[] getFields()
          Get fields is restated here just to point out that this method returns a list of ICPPField objects representing all fields, declared or inherited.
 IBinding[] getFriends()
          return an array of bindings for those classes/functions declared as friends of this class.
 ICPPMethod[] getMethods()
          Returns a list of ICPPMethod objects representing all methods defined for this class including those declared, inherited, or generated (e.g.
 ICPPClassType[] getNestedClasses()
          return an array of nested classes/structures
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.ICompositeType
getCompositeScope, getKey
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IBinding
getName, getNameCharArray, getScope
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IType
clone, isSameType
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.cpp.ICPPBinding
getQualifiedName, getQualifiedNameCharArray, isGloballyQualified
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IBinding
getName, getNameCharArray, getScope
 

Field Detail

EMPTY_CLASS_ARRAY

static final ICPPClassType[] EMPTY_CLASS_ARRAY

k_class

static final int k_class
See Also:
Constant Field Values
Method Detail

getBases

ICPPBase[] getBases()
                    throws DOMException
Returns a list of base class relationships. The list is empty if there are none.

Returns:
List of ICPPBase
Throws:
DOMException

getFields

IField[] getFields()
                   throws DOMException
Get fields is restated here just to point out that this method returns a list of ICPPField objects representing all fields, declared or inherited.

Specified by:
getFields in interface ICompositeType
Returns:
List of IField
Throws:
DOMException

findField

IField findField(String name)
                 throws DOMException
findField is restated here to point out that this method looks through the inheritance tree of this class while looking for a field with the given name If no field is found, null is returned, if the name is found to be ambiguous a IProblemBinding is returned.

Specified by:
findField in interface ICompositeType
Parameters:
name -
Returns:
Throws:
DOMException

getDeclaredFields

ICPPField[] getDeclaredFields()
                              throws DOMException
Returns a list of ICPPField objects representing fields declared in this class. It does not include fields inherited from base classes.

Returns:
List of ICPPField
Throws:
DOMException

getMethods

ICPPMethod[] getMethods()
                        throws DOMException
Returns a list of ICPPMethod objects representing all methods defined for this class including those declared, inherited, or generated (e.g. default constructors and the like).

Returns:
List of ICPPMethod
Throws:
DOMException

getAllDeclaredMethods

ICPPMethod[] getAllDeclaredMethods()
                                   throws DOMException
Returns a list of ICPPMethod objects representing all method explicitly declared by this class and inherited from base classes. It does not include automatically generated methods.

Returns:
List of ICPPMethod
Throws:
DOMException

getDeclaredMethods

ICPPMethod[] getDeclaredMethods()
                                throws DOMException
Returns a list of ICPPMethod objects representing all methods explicitly declared by this class. It does not include inherited methods or automatically generated methods.

Returns:
List of ICPPMethod
Throws:
DOMException

getConstructors

ICPPConstructor[] getConstructors()
                                  throws DOMException
Returns an array of ICPPConstructor objects representing the contructors for this class. This list includes both declared and implicit constructors.

Returns:
Throws:
DOMException

getFriends

IBinding[] getFriends()
                      throws DOMException
return an array of bindings for those classes/functions declared as friends of this class.

Returns:
Throws:
DOMException

getNestedClasses

ICPPClassType[] getNestedClasses()
                                 throws DOMException
return an array of nested classes/structures

Returns:
Throws:
DOMException

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.