1 /*
 2  * Copyright (c) 1998, 2021, 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 import jdk.internal.javac.PreviewFeature;
33 
34 /**
35  * Request for notification when a thread starts execution in the target VM.
36  * When an enabled ThreadStartRequest is hit, an
37  * {@link EventSet event set} containing a
38  * {@link ThreadStartEvent ThreadStartEvent}
39  * will be placed on the
40  * {@link EventQueue EventQueue}.
41  * The collection of existing ThreadStartRequests is
42  * managed by the {@link EventRequestManager}
43  *
44  * @see ThreadStartEvent
45  * @see EventQueue
46  * @see EventRequestManager
47  *
48  * @author Robert Field
49  * @since  1.3
50  */
51 public interface ThreadStartRequest extends EventRequest {
52 
53     /**
54      * Restricts the events generated by this request to those in
55      * the given thread.
56      * The behavior of this method is unspecified when the event is restricted
57      * to only platform threads.
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 only
67      * <a href="{@docRoot}/java.base/java/lang/Thread.html#platform-threads">platform threads</a>.
68      * The behavior of this method is unspecified when the event is restricted
69      * to a specific thread.
70      *
71      * @implSpec
72      * The default implementation throws {@code UnsupportedOperationException}.
73      *
74      * @throws InvalidRequestStateException if this request is currently
75      * enabled or has been deleted
76      *
77      * @since 99
78      */
79     @PreviewFeature(feature = PreviewFeature.Feature.VIRTUAL_THREADS)
80     default void addPlatformThreadsOnlyFilter() {
81         throw new UnsupportedOperationException("Method not implemented");
82     }
83 }