/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is JSwat. The Initial Developer of the Original
 * Software is Nathan L. Fiedler. Portions created by Nathan L. Fiedler
 * are Copyright (C) 2006-2010. All Rights Reserved.
 *
 * Contributor(s): Nathan L. Fiedler.
 *
 * $Id: InstanceBreakpoint.java 276 2010-11-14 16:04:28Z nathanfiedler $
 */
package com.bluemarsh.jswat.core.breakpoint;

import com.sun.jdi.ObjectReference;

/**
 * An InstanceBreakpoint applies only to a particular object reference.
 * This is typically combined with other types of a breakpoints, such as
 * WatchBreakpoint.
 *
 * @author  Nathan Fiedler
 */
public interface InstanceBreakpoint extends Breakpoint {

    /** Name of 'objectReference' property. */
    String PROP_OBJECTREFERENCE = "objectReference";

    /**
     * Returns the object reference this breakpoint is associated with.
     *
     * @return  object reference.
     */
    ObjectReference getObjectReference();

    /**
     * Sets the object reference this breakpoint should filter on.
     *
     * @param  obj  object reference to filter against.
     */
    void setObjectReference(ObjectReference obj);
}