langtools/test/tools/javac/processing/filer/TestPackageInfo.java
author ohair
Tue, 25 May 2010 15:54:51 -0700
changeset 5520 86e4b9a9da40
parent 10 06bc494ca11e
child 6720 f16f91662ad8
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
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 6380018 6392177
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test the ability to create and process package-info.java files
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * @author  Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @compile TestPackageInfo.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @compile -processor TestPackageInfo -proc:only foo/bar/package-info.java TestPackageInfo.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import java.util.Set;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
import java.util.HashSet;
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import java.util.Map;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import javax.annotation.processing.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
import javax.lang.model.SourceVersion;
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
import static javax.lang.model.SourceVersion.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
import javax.lang.model.element.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
import javax.lang.model.util.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
import static javax.lang.model.util.ElementFilter.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
import static javax.tools.Diagnostic.Kind.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
import static javax.tools.StandardLocation.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
import java.io.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 * Test the ability to process annotations on package-info.java files:
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 * 1) Visibility of package-info files from the command line
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 * 2) Visibility of generated package-info.java source files
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
@SupportedAnnotationTypes("*")
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
public class TestPackageInfo extends AbstractProcessor {
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    private Elements eltUtils;
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    private Messager messager;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    private Filer filer;
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    private Map<String,String> options;
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    private int round = 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
    public boolean process(Set<? extends TypeElement> annotations,
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
                           RoundEnvironment roundEnv) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        round++;
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
        // Verify annotations are as expected
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        Set<TypeElement> expectedAnnotations = new HashSet<TypeElement>();
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        if (round == 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
            expectedAnnotations.add(eltUtils.
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
                                    getTypeElement("javax.annotation.processing.SupportedAnnotationTypes"));
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        expectedAnnotations.add(eltUtils.
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
                                getTypeElement("java.lang.SuppressWarnings"));
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        if (!roundEnv.processingOver()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
            System.out.println("\nRound " + round);
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
            int rootElementSize = roundEnv.getRootElements().size();
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
            for(Element elt : roundEnv.getRootElements()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
                System.out.printf("%nElement %s\tkind: %s%n", elt.getSimpleName(), elt.getKind());
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
                eltUtils.printElements(new PrintWriter(System.out), elt);
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
            switch (round) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
            case 1:
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
                if (rootElementSize != 2)
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
                    throw new RuntimeException("Unexpected root element size " + rootElementSize);
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
                // Note that foo.bar.FuBar, an element of package
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
                // foo.bar, contains @Deprecated which should *not* be
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
                // included in the set of annotations to process
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
                if (!expectedAnnotations.equals(annotations)) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
                    throw new RuntimeException("Unexpected annotations: " + annotations);
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
                try {
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
                    try {
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
                        filer.createClassFile("package-info");
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
                        throw new RuntimeException("Created class file for \"package-info\".");
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
                    } catch(FilerException fe) {}
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
                    PrintWriter pw = new PrintWriter(filer.createSourceFile("foo.package-info").openWriter());
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
                    pw.println("@SuppressWarnings(\"\")");
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
                    pw.println("package foo;");
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
                    pw.close();
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
                } catch(IOException ioe) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
                    throw new RuntimeException(ioe);
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
            case 2:
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
                // Expect foo.package-info
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
                Set<Element> expectedElement = new HashSet<Element>();
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
                expectedElement.add(eltUtils.getPackageElement("foo"));
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
                if (!expectedElement.equals(roundEnv.getRootElements()))
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
                    throw new RuntimeException("Unexpected root element set " + roundEnv.getRootElements());
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
                if (!expectedAnnotations.equals(annotations)) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
                    throw new RuntimeException("Unexpected annotations: " + annotations);
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
            default:
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
                throw new RuntimeException("Unexpected round number " + round);
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
        return false;
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
    public SourceVersion getSupportedSourceVersion() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
        return SourceVersion.latest();
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
    public void init(ProcessingEnvironment processingEnv) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
        super.init(processingEnv);
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
        eltUtils = processingEnv.getElementUtils();
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
        messager = processingEnv.getMessager();
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
        filer    = processingEnv.getFiler();
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
        options  = processingEnv.getOptions();
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
}