1 /*
   2  * Copyright 2006-2007 Sun Microsystems, Inc.  All Rights Reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  */
  23 
  24 /*
  25  * @test
  26  * @bug 6397298 6400986 6425592 6449798 6453386 6508401
  27  * @summary Tests that getElementsAnnotatedWith works properly.
  28  * @author  Joseph D. Darcy
  29  * @compile TestElementsAnnotatedWith.java
  30  * @compile InheritedAnnotation.java
  31  * @compile -processor TestElementsAnnotatedWith -proc:only SurfaceAnnotations.java
  32  * @compile -processor TestElementsAnnotatedWith -proc:only BuriedAnnotations.java
  33  * @compile -processor TestElementsAnnotatedWith -proc:only Part1.java Part2.java
  34  * @compile -processor TestElementsAnnotatedWith -proc:only TestElementsAnnotatedWith.java
  35  * @compile -processor TestElementsAnnotatedWith -proc:only C2.java
  36  */
  37 
  38 import java.lang.annotation.Annotation;
  39 import java.util.Collections;
  40 import java.util.Set;
  41 import java.util.HashSet;
  42 import java.util.Arrays;
  43 import javax.annotation.processing.*;
  44 import javax.lang.model.SourceVersion;
  45 import javax.lang.model.element.*;
  46 import javax.lang.model.util.*;
  47 import static javax.lang.model.util.ElementFilter.*;
  48 
  49 /**
  50  * This processor verifies that the information returned by
  51  * getElementsAnnotatedWith is consistent with the expected results
  52  * stored in an AnnotatedElementInfo annotation.
  53  */
  54 @SupportedAnnotationTypes("*")
  55 @AnnotatedElementInfo(annotationName="java.lang.SuppressWarnings", expectedSize=0, names={})
  56 public class TestElementsAnnotatedWith extends AbstractProcessor {
  57 
  58     public boolean process(Set<? extends TypeElement> annotations,
  59                            RoundEnvironment roundEnvironment) {
  60         Elements elementUtils = processingEnv.getElementUtils();
  61 
  62         TypeElement annotatedElementInfoElement =
  63             elementUtils.getTypeElement("AnnotatedElementInfo");
  64         Set<? extends Element> resultsMeta = Collections.emptySet();
  65         Set<? extends Element> resultsBase = Collections.emptySet();
  66 
  67         if (!roundEnvironment.processingOver()) {
  68             testNonAnnotations(roundEnvironment);
  69 
  70             // Verify AnnotatedElementInfo is present on the first
  71             // specified type.
  72 
  73             TypeElement firstType = typesIn(roundEnvironment.getRootElements()).iterator().next();
  74 
  75             AnnotatedElementInfo annotatedElementInfo = firstType.getAnnotation(AnnotatedElementInfo.class);
  76 
  77             boolean failed = false;
  78 
  79             if (annotatedElementInfo == null)
  80                 throw new IllegalArgumentException("Missing AnnotatedElementInfo annotation on " +
  81                                                   firstType);
  82             else {
  83                 // Verify that the annotation information is as
  84                 // expected.
  85 
  86                 Set<String> expectedNames = new HashSet<String>(Arrays.asList(annotatedElementInfo.names()));
  87 
  88                 resultsMeta =
  89                     roundEnvironment.
  90                     getElementsAnnotatedWith(elementUtils.
  91                                              getTypeElement(annotatedElementInfo.
  92                                                             annotationName())) ;
  93 
  94                 System.err.println("Results: " + resultsMeta);
  95 
  96                 if (resultsMeta.size() != annotatedElementInfo.expectedSize()) {
  97                     failed = true;
  98                     System.err.printf("Bad number of elements; expected %d, got %d%n",
  99                                       annotatedElementInfo.expectedSize(), resultsMeta.size());
 100                 } else {
 101                     for(Element element : resultsMeta) {
 102                         String simpleName = element.getSimpleName().toString();
 103                         if (!expectedNames.contains(simpleName) ) {
 104                             failed = true;
 105                             System.err.println("Name ``" + simpleName + "'' not expected.");
 106                         }
 107                     }
 108                 }
 109             }
 110 
 111             resultsBase = computeResultsBase(roundEnvironment, annotatedElementInfo.annotationName());
 112 
 113             if (!resultsMeta.equals(resultsBase)) {
 114                 failed = true;
 115                 System.err.println("Base and Meta sets unequal;\n meta: " + resultsMeta +
 116                                    "\nbase: " + resultsBase);
 117             }
 118 
 119             if (failed) {
 120                 System.err.println("AnnotatedElementInfo: " + annotatedElementInfo);
 121                 throw new RuntimeException();
 122             }
 123         } else {
 124             // If processing is over without an error, the specified
 125             // elements should be empty so an empty set should be returned.
 126             resultsMeta = roundEnvironment.getElementsAnnotatedWith(annotatedElementInfoElement);
 127             resultsBase = roundEnvironment.getElementsAnnotatedWith(AnnotatedElementInfo.class);
 128             if (!resultsMeta.isEmpty())
 129                 throw new RuntimeException("Nonempty resultsMeta: " + resultsMeta);
 130             if (!resultsBase.isEmpty())
 131                 throw new RuntimeException("Nonempty resultsBase: " + resultsBase);
 132 
 133         }
 134         return true;
 135     }
 136 
 137     private Set<? extends Element> computeResultsBase(RoundEnvironment roundEnvironment, String name) {
 138         try {
 139             return roundEnvironment.
 140                 getElementsAnnotatedWith(Class.forName(name).asSubclass(Annotation.class));
 141         } catch(ClassNotFoundException cnfe) {
 142             throw new RuntimeException(cnfe);
 143         }
 144     }
 145 
 146     /**
 147      * Verify non-annotation types result in
 148      * IllegalArgumentExceptions.
 149      */
 150     private void testNonAnnotations(RoundEnvironment roundEnvironment) {
 151         try {
 152             Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith((Class)Object.class );
 153             throw new RuntimeException("Illegal argument exception not thrown");
 154         } catch(IllegalArgumentException iae) {}
 155 
 156         try {
 157             Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(processingEnv.
 158                                                                                         getElementUtils().
 159                                                                                         getTypeElement("java.lang.Object") );
 160             throw new RuntimeException("Illegal argument exception not thrown");
 161         } catch(IllegalArgumentException iae) {}
 162     }
 163 
 164     @Override
 165     public SourceVersion getSupportedSourceVersion() {
 166         return SourceVersion.latest();
 167     }
 168 }