1 /*
   2  * Copyright (c) 2005, 2006, 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  * Request for notification when a thread in the target VM is about to
  32  * wait on a monitor object. That is, a thread is entering Object.wait().
  33  * When an enabled MonitorWaitRequest is satisfied, an
  34  * {@link com.sun.jdi.event.EventSet event set} containing a
  35  * {@link com.sun.jdi.event.MonitorWaitEvent MonitorWaitEvent}
  36  * will be placed on the
  37  * {@link com.sun.jdi.event.EventQueue EventQueue}.
  38  * The collection of existing MonitorWaitEvents is
  39  * managed by the {@link EventRequestManager}
  40  *
  41  * @see com.sun.jdi.event.MonitorWaitEvent
  42  * @see com.sun.jdi.event.EventQueue
  43  * @see EventRequestManager
  44  *
  45  * @author Swamy Venkataramanappa
  46  * @since  1.6
  47  */
  48 public interface MonitorWaitRequest extends EventRequest {
  49 
  50     /**
  51      * Restricts the events generated by this request to those in
  52      * the given thread.
  53      * @param thread the thread to filter on.
  54      * @throws InvalidRequestStateException if this request is currently
  55      * enabled or has been deleted.
  56      * Filters may be added only to disabled requests.
  57      */
  58     void addThreadFilter(ThreadReference thread);
  59 
  60     /**
  61      * Restricts the events generated by this request to those whose
  62      * monitor object is of the given reference type or any of
  63      * its subtypes.
  64      *
  65      * @param refType the reference type to filter on.
  66      * @throws InvalidRequestStateException if this request is currently
  67      * enabled or has been deleted.
  68      * Filters may be added only to disabled requests.
  69      */
  70     void addClassFilter(ReferenceType refType);
  71 
  72     /**
  73      * Restricts the events generated by this request to those
  74      * in which the name of the class of the monitor object matches this restricted
  75      * regular expression. Regular expressions are limited
  76      * to exact matches and patterns that begin with '*' or end with '*';
  77      * for example, "*.Foo" or "java.*".
  78      *
  79      * @param classPattern the pattern String to filter for.
  80      * @throws InvalidRequestStateException if this request is currently
  81      * enabled or has been deleted.
  82      * Filters may be added only to disabled requests.
  83      */
  84     void addClassFilter(String classPattern);
  85 
  86     /**
  87      * Restricts the events generated by this request to those
  88      * in which the name of the class of the monitor object does <b>not</b>match this restricted
  89      * regular expression, e.g.  "java.*" or "*.Foo".
  90      * @param classPattern the pattern String to filter against.
  91      * @throws InvalidRequestStateException if this request is currently
  92      * enabled or has been deleted.
  93      * Filters may be added only to disabled requests.
  94      */
  95     void addClassExclusionFilter(String classPattern);
  96 
  97     /**
  98      * Restricts the events generated by this request to those in
  99      * which the currently executing instance ("this") is the object
 100      * specified.
 101      * <P>
 102      * Not all targets support this operation.
 103      * Use {@link VirtualMachine#canUseInstanceFilters()}
 104      * to determine if the operation is supported.
 105      * @param instance the object which must be the current instance
 106      * in order to pass this filter.
 107      * @throws java.lang.UnsupportedOperationException if
 108      * the target virtual machine does not support this
 109      * operation.
 110      * @throws InvalidRequestStateException if this request is currently
 111      * enabled or has been deleted.
 112      * Filters may be added only to disabled requests.
 113      */
 114     void addInstanceFilter(ObjectReference instance);
 115 }