1 /*
 2  * Copyright (c) 1998, 2023, 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.ThreadReference;
29 import com.sun.jdi.event.EventQueue;
30 import com.sun.jdi.event.EventSet;
31 import com.sun.jdi.event.ThreadStartEvent;
32 
33 /**
34  * Request for notification when a thread starts execution in the target VM.
35  * When an enabled ThreadStartRequest is hit, an
36  * {@link EventSet event set} containing a
37  * {@link ThreadStartEvent ThreadStartEvent}
38  * will be placed on the
39  * {@link EventQueue EventQueue}.
40  * The collection of existing ThreadStartRequests is
41  * managed by the {@link EventRequestManager}
42  *
43  * @see ThreadStartEvent
44  * @see EventQueue
45  * @see EventRequestManager
46  *
47  * @author Robert Field
48  * @since  1.3
49  */
50 public interface ThreadStartRequest extends EventRequest {
51 
52     /**
53      * Restricts the events generated by this request to those in
54      * the given thread.
55      * @param thread the thread to filter on.
56      * @throws InvalidRequestStateException if this request is currently
57      * enabled or has been deleted.
58      * Filters may be added only to disabled requests.
59      */
60     void addThreadFilter(ThreadReference thread);
61 
62     /**
63      * Restricts the events generated by this request to only
64      * <a href="{@docRoot}/java.base/java/lang/Thread.html#platform-threads">platform threads</a>.
65      *
66      * @implSpec
67      * The default implementation throws {@code UnsupportedOperationException}.
68      *
69      * @throws InvalidRequestStateException if this request is currently
70      * enabled or has been deleted
71      *
72      * @since 21
73      */
74     default void addPlatformThreadsOnlyFilter() {
75         throw new UnsupportedOperationException("Method not implemented");
76     }
77 }