Home | History | Annotate | Download | only in request
      1 /*
      2  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 
     26 package com.sun.jdi.request;
     27 
     28 import com.sun.jdi.*;
     29 
     30 /**
     31  * Identifies a {@link Location} in the target VM at which
     32  * execution should be stopped. When an enabled BreakpointRequest is
     33  * satisfied, an
     34  * {@link com.sun.jdi.event.EventSet event set} containing an
     35  * {@link com.sun.jdi.event.BreakpointEvent BreakpointEvent}
     36  * will be placed on the
     37  * {@link com.sun.jdi.event.EventQueue EventQueue} and
     38  * the application is interrupted. The collection of existing breakpoints is
     39  * managed by the {@link EventRequestManager}
     40  *
     41  * @see Location
     42  * @see com.sun.jdi.event.BreakpointEvent
     43  * @see com.sun.jdi.event.EventQueue
     44  * @see EventRequestManager
     45  *
     46  * @author Robert Field
     47  * @since  1.3
     48  */
     49 @jdk.Exported
     50 public interface BreakpointRequest extends EventRequest, Locatable {
     51 
     52     /**
     53      * Returns the location of the requested breakpoint.
     54      *
     55      * @return the {@link Location} where this breakpoint has been set.
     56      */
     57     Location location();
     58 
     59     /**
     60      * Restricts the events generated by this request to those in
     61      * the given thread.
     62      * @param thread the thread to filter on.
     63      * @throws InvalidRequestStateException if this request is currently
     64      * enabled or has been deleted.
     65      * Filters may be added only to disabled requests.
     66      */
     67     void addThreadFilter(ThreadReference thread);
     68 
     69     /**
     70      * Restricts the events generated by this request to those in
     71      * which the currently executing instance is the object
     72      * specified.
     73      * <P>
     74      * Not all targets support this operation.
     75      * Use {@link VirtualMachine#canUseInstanceFilters()}
     76      * to determine if the operation is supported.
     77      * @since 1.4
     78      * @param instance the object which must be the current instance
     79      * in order to pass this filter.
     80      * @throws java.lang.UnsupportedOperationException if
     81      * the target virtual machine does not support this
     82      * operation.
     83      * @throws InvalidRequestStateException if this request is currently
     84      * enabled or has been deleted.
     85      * Filters may be added only to disabled requests.
     86      */
     87     void addInstanceFilter(ObjectReference instance);
     88 }
     89