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