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