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: /** A representation of a single Object on a heap.
47: *
48: * @author Nenik
49: */
50: public interface Item {
51:
52: /**
53: * @return the type (class name) of the object.
54: */
55: public String getType();
56:
57: /**
58: * @return the estimated size of the object represented by this Item
59: */
60: public int getSize();
61:
62: /**
63: * @return the value of the object. For Items representing object of type
64: * "[C" (char array), returns the approximate content of the array. For
65: * other types returns null.
66: */
67: public String getValue();
68:
69: /**
70: * Provides an enumeration of all outgoing references, that is, content of
71: * all non-null reference field of the represented object.
72: *
73: * @return Enumeration of Items representing objects referenced from object
74: * of this Item.
75: */
76: public Enumeration<Item> outgoing();
77:
78: /**
79: * Provides an enumeration of all incomming references.
80: *
81: * @return Enumeration of Items representing objects that references object
82: * of this Item or String representing static fields.
83: */
84: public Enumeration<Object> incomming();
85:
86: /**
87: * Provides an unique integer identification of given object.
88: *
89: * @return unique identification of the object represented by this Item.
90: */
91: public int getId();
92: }
|