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 * Identifies a {@link Field} in the target VM being watched. 32 * 33 * @see AccessWatchpointRequest 34 * @see ModificationWatchpointRequest 35 * @see com.sun.jdi.event.EventQueue 36 * @see EventRequestManager 37 * 38 * @author Robert Field 39 * @since 1.3 40 */ 41 @jdk.Exported 42 public interface WatchpointRequest extends EventRequest { 43 44 /** 45 * Gets the Field being watched by this WatchpointRequest. 46 * 47 * @return the {@link Field} this Watchpoint is monitoring. 48 */ field()49 Field field(); 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 * location 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 location is in a class whose name matches a 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 location is in a class whose name does <b>not</b> match this 91 * restricted regular expression. Regular expressions are limited 92 * to exact matches and patterns that begin with '*' or end with '*'; 93 * for example, "*.Foo" or "java.*". 94 * 95 * @param classPattern the pattern String to filter against. 96 * @throws InvalidRequestStateException if this request is currently 97 * enabled or has been deleted. 98 * Filters may be added only to disabled requests. 99 */ addClassExclusionFilter(String classPattern)100 void addClassExclusionFilter(String classPattern); 101 102 /** 103 * Restricts the events generated by this request to those in 104 * which the currently executing instance ("this") is the object 105 * specified. 106 * <P> 107 * Not all targets support this operation. 108 * Use {@link VirtualMachine#canUseInstanceFilters()} 109 * to determine if the operation is supported. 110 * @since 1.4 111 * @param instance the object which must be the current instance 112 * in order to pass this filter. 113 * @throws java.lang.UnsupportedOperationException if 114 * the target virtual machine does not support this 115 * operation. 116 * @throws InvalidRequestStateException if this request is currently 117 * enabled or has been deleted. 118 * Filters may be added only to disabled requests. 119 */ addInstanceFilter(ObjectReference instance)120 void addInstanceFilter(ObjectReference instance); 121 } 122