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