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.MonitorContendedEnteredEvent;
35
36/**
37 * Request for notification of a thread in the target VM entering a monitor
38 * after waiting for it to be released by another thread.
39 * When an enabled MonitorContededEnteredRequest is satisfied, an
40 * {@link EventSet event set} containing a
41 * {@link MonitorContendedEnteredEvent MonitorContendedEnteredEvent}
42 * will be placed on the {@link EventQueue EventQueue}.
43 * The collection of existing MonitorContendedEnteredEvents is
44 * managed by the {@link EventRequestManager}
45 *
46 * @see MonitorContendedEnteredEvent
47 * @see EventQueue
48 * @see EventRequestManager
49 *
50 * @author Swamy Venkataramanappa
51 * @since  1.6
52 */
53public interface MonitorContendedEnteredRequest 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     * method is in the given reference type or any of its subtypes.
68     * An event will be generated for any location in a reference type
69     * that can be safely cast to the given reference type.
70     *
71     * @param refType the reference type to filter on.
72     * @throws InvalidRequestStateException if this request is currently
73     * enabled or has been deleted.
74     * Filters may be added only to disabled requests.
75     */
76    void addClassFilter(ReferenceType refType);
77
78    /**
79     * Restricts the events generated by this request to those
80     * whose method is in a class whose name matches this restricted
81     * regular expression. Regular expressions are limited
82     * to exact matches and patterns that begin with '*' or end with '*';
83     * for example, "*.Foo" or "java.*".
84     *
85     * @param classPattern the pattern String to filter for.
86     * @throws InvalidRequestStateException if this request is currently
87     * enabled or has been deleted.
88     * Filters may be added only to disabled requests.
89     */
90    void addClassFilter(String classPattern);
91
92    /**
93     * Restricts the events generated by this request to those
94     * whose method is in a class whose name does <b>not</b> match this restricted
95     * regular expression, e.g. "java.*" or "*.Foo".
96     * @param classPattern the pattern String to filter against.
97     * @throws InvalidRequestStateException if this request is currently
98     * enabled or has been deleted.
99     * Filters may be added only to disabled requests.
100     */
101    void addClassExclusionFilter(String classPattern);
102
103    /**
104     * Restricts the events generated by this request to those in
105     * which the currently executing instance ("this") is the object
106     * specified.
107     * <P>
108     * Not all targets support this operation.
109     * Use {@link VirtualMachine#canUseInstanceFilters()}
110     * to determine if the operation is supported.
111     * @param instance the object which must be the current instance
112     * in order to pass this filter.
113     * @throws java.lang.UnsupportedOperationException if
114     * the target virtual machine does not support this
115     * operation.
116     * @throws InvalidRequestStateException if this request is currently
117     * enabled or has been deleted.
118     * Filters may be added only to disabled requests.
119     */
120    void addInstanceFilter(ObjectReference instance);
121}
122