jdk/src/jdk.jdi/share/classes/com/sun/jdi/Mirror.java
author clanger
Fri, 16 Jun 2017 14:09:31 +0200
changeset 45564 0149773a140c
parent 34894 3248b89d1921
permissions -rw-r--r--
8181417: Code cleanups in com.sun.jdi Reviewed-by: alanb, stuefe, sspitsyn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
     2
 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package com.sun.jdi;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    28
import com.sun.jdi.request.BreakpointRequest;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    29
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * A proxy used by a debugger to examine or manipulate some entity
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * in another virtual machine. Mirror is the root of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * interface hierarchy for this package. Mirrors can be proxies for objects
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * in the target VM ({@link ObjectReference}), primitive values
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * (for example, {@link IntegerValue}), types (for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * {@link ReferenceType}), dynamic application state (for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * {@link StackFrame}), and even debugger-specific constructs (for example,
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    38
 * {@link BreakpointRequest}).
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    39
 * The {@link VirtualMachine} itself is also considered a mirror,
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    40
 * representing the composite state of the target VM.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * There is no guarantee that a particular entity in the target VM will map
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * to a single instance of Mirror. Implementors are free to decide
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * whether a single mirror will be used for some or all mirrors. Clients
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * of this interface should always use <code>equals</code> to compare
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * two mirrors for equality.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <p>
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    48
 * Any method on a {@link Mirror} that takes a <code>Mirror</code> as an
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * parameter directly or indirectly (e.g., as a element in a <code>List</code>) will
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    50
 * throw {@link VMMismatchException} if the mirrors are from different
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * virtual machines.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * @see VirtualMachine
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * @author Robert Field
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * @author Gordon Hirsch
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @author James McIlree
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @since  1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
public interface Mirror {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * Gets the VirtualMachine to which this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Mirror belongs. A Mirror must be associated
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * with a VirtualMachine to have any meaning.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * @return the {@link VirtualMachine} for which this mirror is a proxy.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    VirtualMachine virtualMachine();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * Returns a String describing this mirror
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * @return a string describing this mirror.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    String toString();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
}