Eclipse CDT
7.0

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

All Superinterfaces:
java.lang.Cloneable, IBinding, ICompositeType, ICPPBinding, IType
All Known Subinterfaces:
ICPPClassSpecialization, ICPPClassTemplate, ICPPClassTemplatePartialSpecialization, ICPPClassTemplatePartialSpecializationSpecialization, ICPPTemplateTemplateParameter

public interface ICPPClassType
extends ICompositeType, ICPPBinding

Represents a C++ class.


Field Summary
static ICPPClassType[] EMPTY_CLASS_ARRAY
           
static int k_class
           
static int v_private
           
static int v_protected
           
static int v_public
           
 
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.IType
EMPTY_TYPE_ARRAY, TYPE_MATCHER
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IBinding
EMPTY_BINDING_ARRAY
 
Method Summary
 IField findField(java.lang.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 an array of base class relationships.
 ICPPConstructor[] getConstructors()
          Returns an array of ICPPConstructor objects representing the constructors 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()
          Returns 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. default constructors and the like).
 ICPPClassType[] getNestedClasses()
          Returns an array of nested classes/structures
 int getVisibility(IBinding member)
          Gets the access specifier of the member.
 boolean isFinal()
          Returns whether this type is declared final.
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.ICompositeType
getCompositeScope, getKey, isAnonymous
 
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
getLinkage, getName, getNameCharArray, getOwner, getScope
 

Field Detail

EMPTY_CLASS_ARRAY

static final ICPPClassType[] EMPTY_CLASS_ARRAY

k_class

static final int k_class
See Also:
Constant Field Values

v_public

static final int v_public
Since:
5.5
See Also:
Constant Field Values

v_protected

static final int v_protected
Since:
5.5
See Also:
Constant Field Values

v_private

static final int v_private
Since:
5.5
See Also:
Constant Field Values
Method Detail

getBases

ICPPBase[] getBases()
Returns an array of base class relationships. The returned array is empty if there are none.


getFields

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.

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

findField

IField findField(java.lang.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.

Specified by:
findField in interface ICompositeType
Parameters:
name -

getDeclaredFields

ICPPField[] getDeclaredFields()
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

getMethods

ICPPMethod[] getMethods()
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

getAllDeclaredMethods

ICPPMethod[] getAllDeclaredMethods()
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

getDeclaredMethods

ICPPMethod[] getDeclaredMethods()
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

getConstructors

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


getFriends

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


getNestedClasses

ICPPClassType[] getNestedClasses()
Returns an array of nested classes/structures


isFinal

boolean isFinal()
Returns whether this type is declared final.

Since:
5.5

getVisibility

int getVisibility(IBinding member)
Gets the access specifier of the member.

Parameters:
member - The binding of the member to get the visibility for. member must be a member of this class.
Returns:
the visibility of the specified member.
Throws:
java.lang.IllegalArgumentException - if member is not a member of this class.
Since:
5.5

Eclipse CDT
7.0

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