langtools/src/share/classes/com/sun/mirror/apt/RoundCompleteEvent.java
author darcy
Sun, 26 Jul 2009 21:27:11 -0700
changeset 3378 22011d9a9398
parent 10 06bc494ca11e
child 5520 86e4b9a9da40
permissions -rw-r--r--
6381698: Warn of decommissioning of apt Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
     2
 * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
 * have any questions.
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.mirror.apt;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * Event for the completion of a round of annotation processing.
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * <p>While this class extends the serializable <tt>EventObject</tt>, it
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * cannot meaningfully be serialized because all of the annotation
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * processing tool's internal state would potentially be needed.
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 *
3378
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    35
 * @deprecated All components of this API have been superseded by the
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    36
 * standardized annotation processing API.  This class has no direct
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    37
 * analog in the standardized API because the different round model
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    38
 * renders it unnecessary.
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    39
 *
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * @author Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * @author Scott Seligman
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * @since 1.5
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 */
3378
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    44
@Deprecated
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    45
@SuppressWarnings("deprecation")
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
public abstract class RoundCompleteEvent extends java.util.EventObject {
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    private RoundState rs;
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
     * The current <tt>AnnotationProcessorEnvironment</tt> is regarded
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
     * as the source of events.
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
     * @param source The source of events
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
     * @param rs     The state of the round
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    protected RoundCompleteEvent(AnnotationProcessorEnvironment source,
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
                                 RoundState rs) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        super(source);
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        this.rs = rs;
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     * Return round state.
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    public RoundState getRoundState() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        return rs;
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
     * Return source.
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    public AnnotationProcessorEnvironment getSource() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        return (AnnotationProcessorEnvironment)super.getSource();
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
}