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 * AnnotationChangeEvent.java
029 * --------------------------
030 * (C) Copyright 2009-2020, by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  Peter Kolb (patch 2809117);
033 * Contributor(s):   ;
034 *
035 */
036
037package org.jfree.chart.event;
038
039import org.jfree.chart.annotations.Annotation;
040import org.jfree.chart.util.Args;
041
042/**
043 * An event that can be forwarded to any {@link AnnotationChangeListener} to
044 * signal a change to an {@link Annotation}.
045 *
046 * @since 1.0.14
047 */
048public class AnnotationChangeEvent extends ChartChangeEvent {
049
050    /** The annotation that generated the event. */
051    private Annotation annotation;
052
053    /**
054     * Creates a new {@code AnnotationChangeEvent} instance.
055     *
056     * @param source  the event source.
057     * @param annotation  the annotation that triggered the event
058     *     ({@code null} not permitted).
059     *
060     * @since 1.0.14
061     */
062    public AnnotationChangeEvent(Object source, Annotation annotation) {
063        super(source);
064        Args.nullNotPermitted(annotation, "annotation");
065        this.annotation = annotation;
066    }
067
068    /**
069     * Returns the annotation that triggered the event.
070     *
071     * @return The annotation that triggered the event (never {@code null}).
072     *
073     * @since 1.0.14
074     */
075    public Annotation getAnnotation() {
076        return this.annotation;
077    }
078
079}