1 /*
   2  * Copyright (c) 1998, 2005, 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 class is prepared in the target VM.
  32  * When an enabled ClassPrepareRequest is satisfied, an
  33  * {@link com.sun.jdi.event.EventSet event set} containing a
  34  * {@link com.sun.jdi.event.ClassPrepareEvent ClassPrepareEvent}
  35  * will be placed on the
  36  * {@link com.sun.jdi.event.EventQueue EventQueue}.
  37  * The collection of existing ClassPrepareRequests is
  38  * managed by the {@link EventRequestManager}
  39  * <p>
  40  * Class preparation is defined in the Java Virtual Machine
  41  * Specification.
  42  *
  43  * @see com.sun.jdi.event.ClassPrepareEvent
  44  * @see com.sun.jdi.event.EventQueue
  45  * @see EventRequestManager
  46  *
  47  * @author Robert Field
  48  * @since  1.3
  49  */
  50 public interface ClassPrepareRequest extends EventRequest {
  51 
  52     /**
  53      * Restricts the events generated by this request to be the
  54      * preparation of the given reference type and any subtypes.
  55      * An event will be generated for any prepared reference type that can
  56      * be safely cast to the given reference type.
  57      *
  58      * @param refType the reference type 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 addClassFilter(ReferenceType refType);
  64 
  65     /**
  66      * Restricts the events generated by this request to the
  67      * preparation of reference types whose name matches this restricted
  68      * regular expression. Regular expressions are limited
  69      * to exact matches and patterns that begin with '*' or end with '*';
  70      * for example, "*.Foo" or "java.*".
  71      *
  72      * @param classPattern the pattern String to filter for.
  73      * @throws InvalidRequestStateException if this request is currently
  74      * enabled or has been deleted.
  75      * Filters may be added only to disabled requests.
  76      */
  77     void addClassFilter(String classPattern);
  78 
  79     /**
  80      * Restricts the events generated by this request to the
  81      * preparation of reference types whose name does <b>not</b> match
  82      * this restricted regular expression. Regular expressions are limited
  83      * to exact matches and patterns that begin with '*' or end with '*';
  84      * for example, "*.Foo" or "java.*".
  85      *
  86      * @param classPattern the pattern String to filter against.
  87      * @throws InvalidRequestStateException if this request is currently
  88      * enabled or has been deleted.
  89      * Filters may be added only to disabled requests.
  90      */
  91     void addClassExclusionFilter(String classPattern);
  92 
  93     /**
  94      * Restricts the events generated by this request to the
  95      * preparation of reference types for which the restricted regular
  96      * expression 'sourceNamePattern' matches one of the 'sourceNames' for
  97      * the reference type being prepared.
  98      * That is, if refType is the ReferenceType being prepared,
  99      * then there exists at least one stratum, call it 'someStratum'
 100      * on the list returned by
 101      *     refType.availableStrata();
 102      *
 103      * such that a name on the list returned by
 104      *     refType.sourceNames(someStratam)
 105      *
 106      * matches 'sourceNamePattern'.
 107      * Regular expressions are limited
 108      * to exact matches and patterns that begin with '*' or end with '*';
 109      * for example, "*.Foo" or "java.*".
 110      * <P>
 111      * Not all targets support this operation.
 112      * Use {@link VirtualMachine#canUseSourceNameFilters()}
 113      * to determine if the operation is supported.
 114      * @since 1.6
 115      * @param sourceNamePattern the pattern string to filter for.
 116      * @throws java.lang.UnsupportedOperationException if
 117      * the target virtual machine does not support this
 118      * operation.
 119      * @throws InvalidRequestStateException if this request is currently
 120      * enabled or has been deleted.
 121      * Filters may be added only to disabled requests.
 122      */
 123     void addSourceNameFilter(String sourceNamePattern);
 124 }