/*
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.api.debug;

import com.oracle.truffle.api.source.LineLocation;

/**
 * A breakpoint associated with a {@linkplain LineLocation source line location}.
 *
 * @see Debugger
 */
public abstract class LineBreakpoint extends Breakpoint {

    private final LineLocation lineLocation;

    protected LineBreakpoint(State state, LineLocation lineLocation, int ignoreCount, boolean isOneShot) {
        super(state, ignoreCount, isOneShot);
        this.lineLocation = lineLocation;
    }

    /**
     * Gets the {@linkplain LineLocation source line location} that specifies where this breakpoint
     * will trigger.
     */
    public final LineLocation getLineLocation() {
        return lineLocation;
    }

    @Override
    public String getLocationDescription() {
        return "Line: " + lineLocation.getShortDescription();
    }
}