Home | History | Annotate | Download | only in request
      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 class is unloaded in the target VM.
     32  * When an enabled ClassUnloadRequest is satisfied, a
     33  * {@link com.sun.jdi.event.EventSet event set} containing an
     34  * {@link com.sun.jdi.event.ClassUnloadEvent ClassUnloadEvent} will
     35  * be placed on the {@link com.sun.jdi.event.EventQueue EventQueue}.
     36  * The collection of existing ClassUnloadRequests is
     37  * managed by the {@link EventRequestManager}
     38  * <p>
     39  * Refer to the Java Virtual Machine Specification for more information
     40  * on class unloading.
     41  *
     42  * @see com.sun.jdi.event.ClassUnloadEvent
     43  * @see com.sun.jdi.event.EventQueue
     44  * @see EventRequestManager
     45  *
     46  * @author Robert Field
     47  * @since  1.3
     48  */
     49 @jdk.Exported
     50 public interface ClassUnloadRequest extends EventRequest {
     51 
     52     /**
     53      * Restricts the events generated by this request to the
     54      * unloading of reference types whose name matches a restricted
     55      * regular expression. Regular expressions are limited to exact
     56      * matches and patterns that begin with '*' or end with '*'; for
     57      * example, "*.Foo" or "java.*".
     58      * @param classPattern the pattern String to filter for.
     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(String classPattern);
     64 
     65     /**
     66      * Restricts the events generated by this request to the
     67      * unloading of reference types whose name does <b>not</b> match
     68      * a restricted 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      * @param classPattern the pattern String to filter against.
     72      * @throws InvalidRequestStateException if this request is currently
     73      * enabled or has been deleted.
     74      * Filters may be added only to disabled requests.
     75      */
     76     void addClassExclusionFilter(String classPattern);
     77 }
     78