src/share/classes/com/sun/jdi/Mirror.java

Print this page




  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 }


  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 @jdk.Supported
  60 public interface Mirror {
  61 
  62     /**
  63      * Gets the VirtualMachine to which this
  64      * Mirror belongs. A Mirror must be associated
  65      * with a VirtualMachine to have any meaning.
  66      *
  67      * @return the {@link VirtualMachine} for which this mirror is a proxy.
  68      */
  69     VirtualMachine virtualMachine();
  70 
  71     /**
  72      * Returns a String describing this mirror
  73      *
  74      * @return a string describing this mirror.
  75      */
  76     String toString();
  77 }