jdk/src/share/classes/com/sun/jdi/request/BreakpointRequest.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1998-2001 Sun Microsystems, Inc.  All Rights Reserved.
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
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
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
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.request;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import com.sun.jdi.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * Identifies a {@link Location} in the target VM at which
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * execution should be stopped. When an enabled BreakpointRequest is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * satisfied, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * {@link com.sun.jdi.event.EventSet event set} containing an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * {@link com.sun.jdi.event.BreakpointEvent BreakpointEvent}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * will be placed on the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * {@link com.sun.jdi.event.EventQueue EventQueue} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * the application is interrupted. The collection of existing breakpoints is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * managed by the {@link EventRequestManager}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * @see Location
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * @see com.sun.jdi.event.BreakpointEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * @see com.sun.jdi.event.EventQueue
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * @see EventRequestManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @author Robert Field
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * @since  1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
public interface BreakpointRequest extends EventRequest, Locatable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * Returns the location of the requested breakpoint.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * @return the {@link Location} where this breakpoint has been set.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    Location location();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * Restricts the events generated by this request to those in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * the given thread.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * @param thread the thread to filter on.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    void addThreadFilter(ThreadReference thread);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * Restricts the events generated by this request to those in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * which the currently executing instance is the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * specified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * Not all targets support this operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * Use {@link VirtualMachine#canUseInstanceFilters()}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * to determine if the operation is supported.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * @param instance the object which must be the current instance
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * in order to pass this filter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * @throws java.lang.UnsupportedOperationException if
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * the target virtual machine does not support this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    void addInstanceFilter(ObjectReference instance);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
}