/core/src/com/bluemarsh/jswat/core/breakpoint/InstanceBreakpoint.java

 1/*
 2 * The contents of this file are subject to the terms of the Common Development
 3 * and Distribution License (the License). You may not use this file except in
 4 * compliance with the License.
 5 *
 6 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 7 * or http://www.netbeans.org/cddl.txt.
 8 *
 9 * When distributing Covered Code, include this CDDL Header Notice in each file
10 * and include the License file at http://www.netbeans.org/cddl.txt.
11 * If applicable, add the following below the CDDL Header, with the fields
12 * enclosed by brackets [] replaced by your own identifying information:
13 * "Portions Copyrighted [year] [name of copyright owner]"
14 *
15 * The Original Software is JSwat. The Initial Developer of the Original
16 * Software is Nathan L. Fiedler. Portions created by Nathan L. Fiedler
17 * are Copyright (C) 2006-2010. All Rights Reserved.
18 *
19 * Contributor(s): Nathan L. Fiedler.
20 *
21 * $Id: InstanceBreakpoint.java 276 2010-11-14 16:04:28Z nathanfiedler $
22 */
23package com.bluemarsh.jswat.core.breakpoint;
24
25import com.sun.jdi.ObjectReference;
26
27/**
28 * An InstanceBreakpoint applies only to a particular object reference.
29 * This is typically combined with other types of a breakpoints, such as
30 * WatchBreakpoint.
31 *
32 * @author  Nathan Fiedler
33 */
34public interface InstanceBreakpoint extends Breakpoint {
35
36    /** Name of 'objectReference' property. */
37    String PROP_OBJECTREFERENCE = "objectReference";
38
39    /**
40     * Returns the object reference this breakpoint is associated with.
41     *
42     * @return  object reference.
43     */
44    ObjectReference getObjectReference();
45
46    /**
47     * Sets the object reference this breakpoint should filter on.
48     *
49     * @param  obj  object reference to filter against.
50     */
51    void setObjectReference(ObjectReference obj);
52}