jdk/src/jdk.jdi/share/classes/com/sun/jdi/request/MonitorContendedEnteredRequest.java
author clanger
Fri, 16 Jun 2017 14:09:31 +0200
changeset 45564 0149773a140c
parent 34894 3248b89d1921
permissions -rw-r--r--
8181417: Code cleanups in com.sun.jdi Reviewed-by: alanb, stuefe, sspitsyn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
     2
 * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package com.sun.jdi.request;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    28
import com.sun.jdi.ObjectReference;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    29
import com.sun.jdi.ReferenceType;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    30
import com.sun.jdi.ThreadReference;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    31
import com.sun.jdi.VirtualMachine;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    32
import com.sun.jdi.event.EventQueue;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    33
import com.sun.jdi.event.EventSet;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    34
import com.sun.jdi.event.MonitorContendedEnteredEvent;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * Request for notification of a thread in the target VM entering a monitor
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * after waiting for it to be released by another thread.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * When an enabled MonitorContededEnteredRequest is satisfied, an
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    40
 * {@link EventSet event set} containing a
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    41
 * {@link MonitorContendedEnteredEvent MonitorContendedEnteredEvent}
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    42
 * will be placed on the {@link EventQueue EventQueue}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * The collection of existing MonitorContendedEnteredEvents is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * managed by the {@link EventRequestManager}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    46
 * @see MonitorContendedEnteredEvent
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    47
 * @see EventQueue
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @see EventRequestManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @author Swamy Venkataramanappa
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * @since  1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
public interface MonitorContendedEnteredRequest extends EventRequest {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * Restricts the events generated by this request to those in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * the given thread.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * @param thread the thread to filter on.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    void addThreadFilter(ThreadReference thread);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * Restricts the events generated by this request to those whose
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * method is in the given reference type or any of its subtypes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * An event will be generated for any location in a reference type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * that can be safely cast to the given reference type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * @param refType the reference type to filter on.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    void addClassFilter(ReferenceType refType);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * Restricts the events generated by this request to those
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * whose method is in a class whose name matches this restricted
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * regular expression. Regular expressions are limited
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * to exact matches and patterns that begin with '*' or end with '*';
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * for example, "*.Foo" or "java.*".
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * @param classPattern the pattern String to filter for.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    void addClassFilter(String classPattern);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * Restricts the events generated by this request to those
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * whose method is in a class whose name does <b>not</b> match this restricted
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * regular expression, e.g. "java.*" or "*.Foo".
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * @param classPattern the pattern String to filter against.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    void addClassExclusionFilter(String classPattern);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * Restricts the events generated by this request to those in
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * which the currently executing instance ("this") is the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * specified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * Not all targets support this operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * Use {@link VirtualMachine#canUseInstanceFilters()}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * to determine if the operation is supported.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     * @param instance the object which must be the current instance
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     * in order to pass this filter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * @throws java.lang.UnsupportedOperationException if
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     * the target virtual machine does not support this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     * operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
     * @throws InvalidRequestStateException if this request is currently
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     * enabled or has been deleted.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     * Filters may be added only to disabled requests.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
    void addInstanceFilter(ObjectReference instance);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
}