langtools/test/tools/javac/processing/model/util/deprecation/TestDeprecation.java
author darcy
Wed, 02 Jun 2010 19:08:47 -0700
changeset 5841 7a8448425bb7
parent 5520 86e4b9a9da40
child 6720 f16f91662ad8
permissions -rw-r--r--
6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7 Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     2
 * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
10
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.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 6392818
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Tests Elements.isDeprecated(Element)
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * @author  Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @compile TestDeprecation.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @compile -processor TestDeprecation -proc:only Dep1.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @compile Dep1.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @compile -processor TestDeprecation -proc:only Dep1 TestDeprecation.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import java.util.Set;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import java.util.HashSet;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
import java.util.Arrays;
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
import javax.annotation.processing.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
import javax.lang.model.SourceVersion;
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
import javax.lang.model.element.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
import javax.lang.model.util.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
import static javax.tools.Diagnostic.Kind.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
import java.io.Writer;
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 * This processor verifies that the information returned by
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * getElementsAnnotatedWith is consistent with the expected results
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 * stored in an AnnotatedElementInfo annotation.
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
@SupportedAnnotationTypes("*")
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
public class TestDeprecation extends AbstractProcessor {
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    public boolean process(Set<? extends TypeElement> annotations,
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
                           RoundEnvironment roundEnv) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        boolean failure = false;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        if (!roundEnv.processingOver()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
            DeprecationChecker deprecationChecker = new DeprecationChecker();
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
            for(Element element: roundEnv.getRootElements() ) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
                System.out.println("\nRoot Element: " + element.getSimpleName());
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
                failure = deprecationChecker.scan(element);
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
            if (failure)
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
                processingEnv.getMessager().printMessage(ERROR, "Deprecation mismatch found!");
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        return true;
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents: 5520
diff changeset
    70
    private class DeprecationChecker extends ElementScanner7<Boolean,Void> {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
        private Elements elementUtils;
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        private boolean failure;
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        DeprecationChecker() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
            super(false);
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
            elementUtils = processingEnv.getElementUtils();
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
            failure = false;
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        @Override
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
        public Boolean scan(Element e, Void p) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
            boolean expectedDeprecation = false;
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
            ExpectedDeprecation tmp = e.getAnnotation(ExpectedDeprecation.class);
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
            if (tmp != null)
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
                expectedDeprecation = tmp.value();
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
            boolean actualDeprecation = elementUtils.isDeprecated(e);
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
            System.out.printf("\tVisiting %s\t%s%n", e.getKind(), e.getSimpleName());
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
            if (expectedDeprecation != actualDeprecation) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
                failure = true;
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
                java.io.StringWriter w = new java.io.StringWriter();
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
                elementUtils.printElements(w, e);
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
                System.out.printf("For the deprecation of %n\t%s\t, expected %b, got %b.%n",
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
                                  w.getBuffer().toString(),
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
                                  expectedDeprecation, actualDeprecation);
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
            super.scan(e, p);
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
            return failure;
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    @Override
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    public SourceVersion getSupportedSourceVersion() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
        return SourceVersion.latest();
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
}