0N/A/*
553N/A * Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
553N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
553N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.jdi;
0N/A
0N/A/**
0N/A * A proxy used by a debugger to examine or manipulate some entity
0N/A * in another virtual machine. Mirror is the root of the
0N/A * interface hierarchy for this package. Mirrors can be proxies for objects
0N/A * in the target VM ({@link ObjectReference}), primitive values
0N/A * (for example, {@link IntegerValue}), types (for example,
0N/A * {@link ReferenceType}), dynamic application state (for example,
0N/A * {@link StackFrame}), and even debugger-specific constructs (for example,
0N/A * {@link com.sun.jdi.request.BreakpointRequest}).
0N/A * The {@link VirtualMachine} itself is also
0N/A * considered a mirror, representing the composite state of the
0N/A * target VM.
0N/A * <P>
* There is no guarantee that a particular entity in the target VM will map
* to a single instance of Mirror. Implementors are free to decide
* whether a single mirror will be used for some or all mirrors. Clients
* of this interface should always use <code>equals</code> to compare
* two mirrors for equality.
* <p>
* Any method on a {@link com.sun.jdi.Mirror} that takes a <code>Mirror</code> as an
* parameter directly or indirectly (e.g., as a element in a <code>List</code>) will
* throw {@link com.sun.jdi.VMMismatchException} if the mirrors are from different
* virtual machines.
*
* @see VirtualMachine
*
* @author Robert Field
* @author Gordon Hirsch
* @author James McIlree
* @since 1.3
*/
public interface Mirror {
/**
* Gets the VirtualMachine to which this
* Mirror belongs. A Mirror must be associated
* with a VirtualMachine to have any meaning.
*
* @return the {@link VirtualMachine} for which this mirror is a proxy.
*/
VirtualMachine virtualMachine();
/**
* Returns a String describing this mirror
*
* @return a string describing this mirror.
*/
String toString();
}