blob: 78ee19a42a63aaec2c432b68f406e63547c747bb (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*******************************************************************************
* Copyright (c) 2004, 2008 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 - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.dom.ast.cpp;
import org.eclipse.cdt.core.dom.ast.DOMException;
import org.eclipse.cdt.core.dom.ast.IBinding;
import org.eclipse.cdt.core.dom.ast.ICompositeType;
import org.eclipse.cdt.core.dom.ast.IField;
/**
* Represents a C++ class.
*
* @author Doug Schaefer
*/
public interface ICPPClassType extends ICompositeType, ICPPBinding {
public static final ICPPClassType [] EMPTY_CLASS_ARRAY = new ICPPClassType[0];
public static final int k_class = ICPPASTCompositeTypeSpecifier.k_class;
/**
* Returns a list of base class relationships. The list is empty if there
* are none.
*
* @return List of ICPPBase
*/
public ICPPBase[] getBases() 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.
*/
public IField[] getFields() 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.
*
* @param name
*/
public IField findField(String name) throws DOMException;
/**
* Returns a list of ICPPField objects representing fields declared in this
* class. It does not include fields inherited from base classes.
*
* @return List of ICPPField
*/
public ICPPField[] getDeclaredFields() 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).
*
* @return List of ICPPMethod
*/
public ICPPMethod[] getMethods() 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.
*
* @return List of ICPPMethod
*/
public ICPPMethod[] getAllDeclaredMethods() 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.
*
* @return List of ICPPMethod
*/
public ICPPMethod[] getDeclaredMethods() throws DOMException;
/**
* Returns an array of ICPPConstructor objects representing the contructors
* for this class. This list includes both declared and implicit
* constructors.
*
*/
public ICPPConstructor[] getConstructors() throws DOMException;
/**
* return an array of bindings for those classes/functions declared as
* friends of this class.
*
* @throws DOMException
*/
public IBinding[] getFriends() throws DOMException;
/**
* return an array of nested classes/structures
* @throws DOMException
*/
public ICPPClassType [] getNestedClasses() throws DOMException;
}
|
