001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.apt;
027    
028    /**
029     * Event for the completion of a round of annotation processing.
030     *
031     * <p>While this class extends the serializable <tt>EventObject</tt>, it
032     * cannot meaningfully be serialized because all of the annotation
033     * processing tool's internal state would potentially be needed.
034     *
035     * @author Joseph D. Darcy
036     * @author Scott Seligman
037     * @since 1.5
038     */
039    public abstract class RoundCompleteEvent extends java.util.EventObject {
040        private RoundState rs;
041    
042        /**
043         * The current <tt>AnnotationProcessorEnvironment</tt> is regarded
044         * as the source of events.
045         *
046         * @param source The source of events
047         * @param rs     The state of the round
048         */
049        protected RoundCompleteEvent(AnnotationProcessorEnvironment source,
050                                     RoundState rs) {
051            super(source);
052            this.rs = rs;
053        }
054    
055        /**
056         * Return round state.
057         */
058        public RoundState getRoundState() {
059            return rs;
060        }
061    
062        /**
063         * Return source.
064         */
065        public AnnotationProcessorEnvironment getSource() {
066            return (AnnotationProcessorEnvironment)super.getSource();
067        }
068    }