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