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-2006 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.insane.model;
43:
44: import java.util.*;
45:
46: /**
47: * A simplified model of the Java heap. It represents relations between
48: * Java objects, set of known root references and a set of types. It does not
49: * represent values of the primitive object fields.
50: *
51: * @author Nenik
52: */
53: public interface HeapModel {
54:
55: /**
56: * Provides access to all known instances on the heap.
57: *
58: * @return Iterator of all Items
59: */
60: public Iterator<Item> getAllItems();
61:
62: /**
63: * Provides access to all known instances of given type.
64: *
65: * @return Collection of Items of given type
66: */
67: public Collection<Item> getObjectsOfType(String type);
68:
69: /**
70: * Provides a collection of known root (static) references
71: *
72: * @return Collection of Strings representing the names
73: * of static fields
74: */
75: public Collection<String> getRoots();
76:
77: /* Access an object referenced from given field
78: *
79: * @param staticRefName the name of the static field as returned
80: * from getRoots() method.
81: * @return Item representing the object at given static reference
82: */
83: public Item getObjectAt(String staticRefName);
84:
85: /* Access an object with a known ID
86: *
87: * @param id the id of the object
88: * @return Item with given id, if such Item exists.
89: * @throws IllegalArgumentException if no Item whith given id exists.
90: */
91: Item getItem(int id);
92: }
|