| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2001 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 | package com.sun.jdi; |
| 27 | |
| 28 | /** |
| 29 | * A proxy used by a debugger to examine or manipulate some entity |
| 30 | * in another virtual machine. Mirror is the root of the |
| 31 | * interface hierarchy for this package. Mirrors can be proxies for objects |
| 32 | * in the target VM ({@link ObjectReference}), primitive values |
| 33 | * (for example, {@link IntegerValue}), types (for example, |
| 34 | * {@link ReferenceType}), dynamic application state (for example, |
| 35 | * {@link StackFrame}), and even debugger-specific constructs (for example, |
| 36 | * {@link com.sun.jdi.request.BreakpointRequest}). |
| 37 | * The {@link VirtualMachine} itself is also |
| 38 | * considered a mirror, representing the composite state of the |
| 39 | * target VM. |
| 40 | * <P> |
| 41 | * There is no guarantee that a particular entity in the target VM will map |
| 42 | * to a single instance of Mirror. Implementors are free to decide |
| 43 | * whether a single mirror will be used for some or all mirrors. Clients |
| 44 | * of this interface should always use <code>equals</code> to compare |
| 45 | * two mirrors for equality. |
| 46 | * <p> |
| 47 | * Any method on a {@link com.sun.jdi.Mirror} that takes a <code>Mirror</code> as an |
| 48 | * parameter directly or indirectly (e.g., as a element in a <code>List</code>) will |
| 49 | * throw {@link com.sun.jdi.VMMismatchException} if the mirrors are from different |
| 50 | * virtual machines. |
| 51 | * |
| 52 | * @see VirtualMachine |
| 53 | * |
| 54 | * @author Robert Field |
| 55 | * @author Gordon Hirsch |
| 56 | * @author James McIlree |
| 57 | * @since 1.3 |
| 58 | */ |
| 59 | public interface Mirror { |
| 60 | |
| 61 | /** |
| 62 | * Gets the VirtualMachine to which this |
| 63 | * Mirror belongs. A Mirror must be associated |
| 64 | * with a VirtualMachine to have any meaning. |
| 65 | * |
| 66 | * @return the {@link VirtualMachine} for which this mirror is a proxy. |
| 67 | */ |
| 68 | VirtualMachine virtualMachine(); |
| 69 | |
| 70 | /** |
| 71 | * Returns a String describing this mirror |
| 72 | * |
| 73 | * @return a string describing this mirror. |
| 74 | */ |
| 75 | String toString(); |
| 76 | } |