001: /*
002: * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.jdi.request;
027:
028: import com.sun.jdi.*;
029:
030: /**
031: * Identifies a {@link Field} in the target VM being watched.
032: *
033: * @see AccessWatchpointRequest
034: * @see ModificationWatchpointRequest
035: * @see com.sun.jdi.event.EventQueue
036: * @see EventRequestManager
037: *
038: * @author Robert Field
039: * @since 1.3
040: */
041: public interface WatchpointRequest extends EventRequest {
042:
043: /**
044: * Gets the Field being watched by this WatchpointRequest.
045: *
046: * @return the {@link Field} this Watchpoint is monitoring.
047: */
048: Field field();
049:
050: /**
051: * Restricts the events generated by this request to those in
052: * the given thread.
053: * @param thread the thread to filter on.
054: * @throws InvalidRequestStateException if this request is currently
055: * enabled or has been deleted.
056: * Filters may be added only to disabled requests.
057: */
058: void addThreadFilter(ThreadReference thread);
059:
060: /**
061: * Restricts the events generated by this request to those whose
062: * location is in the given reference type or any of its subtypes.
063: * An event will be generated for any location in a reference type
064: * that can be safely cast to the given reference type.
065: *
066: * @param refType the reference type to filter on.
067: * @throws InvalidRequestStateException if this request is currently
068: * enabled or has been deleted.
069: * Filters may be added only to disabled requests.
070: */
071: void addClassFilter(ReferenceType refType);
072:
073: /**
074: * Restricts the events generated by this request to those
075: * whose location is in a class whose name matches a restricted
076: * regular expression. Regular expressions are limited
077: * to exact matches and patterns that begin with '*' or end with '*';
078: * for example, "*.Foo" or "java.*".
079: *
080: * @param classPattern the pattern String to filter for.
081: * @throws InvalidRequestStateException if this request is currently
082: * enabled or has been deleted.
083: * Filters may be added only to disabled requests.
084: */
085: void addClassFilter(String classPattern);
086:
087: /**
088: * Restricts the events generated by this request to those
089: * whose location is in a class whose name does <b>not</b> match this
090: * restricted regular expression. Regular expressions are limited
091: * to exact matches and patterns that begin with '*' or end with '*';
092: * for example, "*.Foo" or "java.*".
093: *
094: * @param classPattern the pattern String to filter against.
095: * @throws InvalidRequestStateException if this request is currently
096: * enabled or has been deleted.
097: * Filters may be added only to disabled requests.
098: */
099: 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: }
|