01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.cnd.api.model.xref;
43:
44: import org.netbeans.modules.cnd.api.model.*;
45:
46: /**
47: * reference object in file
48: * i.e.
49: * A* B::foo() {
50: * }
51: * => there are 3 reference objects:
52: * 1) "A" pointed to class A
53: * 2) "B" pointed to class B
54: * 3) "foo" pointed to declaration of method foo in class B
55: *
56: * reference object could have owner.
57: * Owner reference is the connection between model objects and references.
58: * Could be used for instance for searching the scope of reference.
59: * in the example above:
60: * - reference "1" has as owner return type of method definition
61: * - reference "2" has owner method definition
62: * - reference "3" has owner method definition as well
63: *
64: *TODOD: think about example
65: * #define MACRO(x) #x
66: * #include MACRO(file.h)
67: * what are the references and owners?
68: *
69: * @author Vladimir Voskresensky
70: */
71: public interface CsmReference extends CsmOffsetable {
72:
73: /**
74: * returns referenced object
75: * this could be long operation of resolving, do not call in EQ
76: */
77: CsmObject getReferencedObject();
78:
79: CsmObject getOwner();
80: }
|