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