001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ----------------------
028 * MarkerChangeEvent.java
029 * ----------------------
030 * (C) Copyright 2006-2020, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.event;
038
039import org.jfree.chart.plot.Marker;
040
041/**
042 * An event that can be forwarded to any {@link MarkerChangeListener} to
043 * signal a change to a {@link Marker}.
044 *
045 * @since 1.0.3
046 */
047public class MarkerChangeEvent extends ChartChangeEvent {
048
049    /** The plot that generated the event. */
050    private Marker marker;
051
052    /**
053     * Creates a new {@code MarkerChangeEvent} instance.
054     *
055     * @param marker  the marker that triggered the event ({@code null}
056     *     not permitted).
057     *
058     * @since 1.0.3
059     */
060    public MarkerChangeEvent(Marker marker) {
061        super(marker); // null check is in here
062        this.marker = marker;
063    }
064
065    /**
066     * Returns the marker that triggered the event.
067     *
068     * @return The marker that triggered the event (never {@code null}).
069     *
070     * @since 1.0.3
071     */
072    public Marker getMarker() {
073        return this.marker;
074    }
075
076}