J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | |
| 27 | /* |
| 28 | * The contents of this file are subject to the Sun Public License |
| 29 | * Version 1.0 (the "License"); you may not use this file except in |
| 30 | * compliance with the License. A copy of the License is available at |
| 31 | * http://www.sun.com/, and in the file LICENSE.html in the |
| 32 | * doc directory. |
| 33 | * |
| 34 | * The Original Code is HAT. The Initial Developer of the |
| 35 | * Original Code is Bill Foote, with contributions from others |
| 36 | * at JavaSoft/Sun. Portions created by Bill Foote and others |
| 37 | * at Javasoft/Sun are Copyright (C) 1997-2004. All Rights Reserved. |
| 38 | * |
| 39 | * In addition to the formal license, I ask that you don't |
| 40 | * change the history or donations files without permission. |
| 41 | * |
| 42 | */ |
| 43 | |
| 44 | package com.sun.tools.hat.internal.model; |
| 45 | |
| 46 | import java.util.Enumeration; |
| 47 | import java.util.Hashtable; |
| 48 | |
| 49 | |
| 50 | /** |
| 51 | * |
| 52 | * @author Bill Foote |
| 53 | */ |
| 54 | |
| 55 | |
| 56 | /** |
| 57 | * Represents a java "Thing". A thing is anything that can be the value of |
| 58 | * a field. This includes JavaHeapObject, JavaObjectRef, and JavaValue. |
| 59 | */ |
| 60 | |
| 61 | public abstract class JavaThing { |
| 62 | |
| 63 | protected JavaThing() { |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * If this is a forward reference, figure out what it really |
| 68 | * refers to. |
| 69 | * |
| 70 | * @param snapshot The snapshot this is for |
| 71 | * @param field The field this thing represents. If null, it is |
| 72 | * assumed this thing is an object (and never a value). |
| 73 | */ |
| 74 | public JavaThing dereference(Snapshot shapshot, JavaField field) { |
| 75 | return this; |
| 76 | } |
| 77 | |
| 78 | |
| 79 | /** |
| 80 | * Are we the same type as other? |
| 81 | * |
| 82 | * @see JavaObject.isSameTypeAs() |
| 83 | */ |
| 84 | public boolean isSameTypeAs(JavaThing other) { |
| 85 | return getClass() == other.getClass(); |
| 86 | } |
| 87 | /** |
| 88 | * @return true iff this represents a heap-allocated object |
| 89 | */ |
| 90 | abstract public boolean isHeapAllocated(); |
| 91 | |
| 92 | /** |
| 93 | * @return the size of this object, in bytes, including VM overhead |
| 94 | */ |
| 95 | abstract public int getSize(); |
| 96 | |
| 97 | /** |
| 98 | * @return a human-readable string representation of this thing |
| 99 | */ |
| 100 | abstract public String toString(); |
| 101 | |
| 102 | /** |
| 103 | * Compare our string representation to other's |
| 104 | * @see java.lang.String.compareTo() |
| 105 | */ |
| 106 | public int compareTo(JavaThing other) { |
| 107 | return toString().compareTo(other.toString()); |
| 108 | } |
| 109 | |
| 110 | } |