0N/A/*
0N/A * Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
610N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
package com.sun.jdi.request;
import com.sun.jdi.*;
/**
* Identifies a {@link Field} in the target VM being watched.
*
* @see AccessWatchpointRequest
* @see ModificationWatchpointRequest
* @see com.sun.jdi.event.EventQueue
* @see EventRequestManager
*
* @author Robert Field
* @since 1.3
*/
public interface WatchpointRequest extends EventRequest {
/**
* Gets the Field being watched by this WatchpointRequest.
*
* @return the {@link Field} this Watchpoint is monitoring.
*/
Field field();
/**
* Restricts the events generated by this request to those in
* the given thread.
* @param thread the thread to filter on.
* @throws InvalidRequestStateException if this request is currently
* enabled or has been deleted.
* Filters may be added only to disabled requests.
*/
void addThreadFilter(ThreadReference thread);
/**
* Restricts the events generated by this request to those whose
* location is in the given reference type or any of its subtypes.
* An event will be generated for any location in a reference type
* that can be safely cast to the given reference type.
*
* @param refType the reference type to filter on.
* @throws InvalidRequestStateException if this request is currently
* enabled or has been deleted.
* Filters may be added only to disabled requests.
*/
void addClassFilter(ReferenceType refType);
/**
* Restricts the events generated by this request to those
* whose location is in a class whose name matches a restricted
* regular expression. Regular expressions are limited
* to exact matches and patterns that begin with '*' or end with '*';
* for example, "*.Foo" or "java.*".
*
* @param classPattern the pattern String to filter for.
* @throws InvalidRequestStateException if this request is currently
* enabled or has been deleted.
* Filters may be added only to disabled requests.
*/
void addClassFilter(String classPattern);
/**
* Restricts the events generated by this request to those
* whose location is in a class whose name does <b>not</b> match this
* restricted regular expression. Regular expressions are limited
* to exact matches and patterns that begin with '*' or end with '*';
* for example, "*.Foo" or "java.*".
*
* @param classPattern the pattern String to filter against.
* @throws InvalidRequestStateException if this request is currently
* enabled or has been deleted.
* Filters may be added only to disabled requests.
*/
void addClassExclusionFilter(String classPattern);
/**
* Restricts the events generated by this request to those in
* which the currently executing instance ("this") is the object
* specified.
* <P>
* Not all targets support this operation.
* Use {@link VirtualMachine#canUseInstanceFilters()}
* to determine if the operation is supported.
* @since 1.4
* @param instance the object which must be the current instance
* in order to pass this filter.
* @throws java.lang.UnsupportedOperationException if
* the target virtual machine does not support this
* operation.
* @throws InvalidRequestStateException if this request is currently
* enabled or has been deleted.
* Filters may be added only to disabled requests.
*/
void addInstanceFilter(ObjectReference instance);
}