langtools/test/tools/javac/processing/model/util/elements/doccomments/TestPackageInfoComments.java
author darcy
Thu, 17 Jul 2014 09:47:25 -0700
changeset 25690 b1dac768ab79
parent 25289 9573116c764c
child 27319 030080f03e4f
permissions -rw-r--r--
8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9 Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
25289
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     1
/*
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     2
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     4
 *
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     7
 * published by the Free Software Foundation.
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     8
 *
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    13
 * accompanied this code).
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    14
 *
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    18
 *
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    21
 * questions.
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    22
 */
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    23
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    24
/*
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    25
 * @test
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    26
 * @bug 8042345
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    27
 * @summary getDocComment() fails for doc comments on PackageElement found in package-info.java
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    28
 * @library /tools/javac/lib
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    29
 * @build JavacTestingAbstractProcessor TestPackageInfoComments
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    30
 * @run main TestPackageInfoComments
25289
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    31
 */
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    32
import com.sun.source.util.JavacTask;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    33
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    34
import java.io.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    35
import java.util.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    36
import javax.annotation.processing.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    37
import javax.lang.model.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    38
import javax.lang.model.element.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    39
import javax.lang.model.util.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    40
import javax.tools.*;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    41
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    42
public class TestPackageInfoComments extends JavacTestingAbstractProcessor {
25289
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    43
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    44
    public static void main(String... args) throws Exception {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    45
        String[] opts = {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    46
            "-implicit:none",
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    47
            "-processor", TestPackageInfoComments.class.getName(),
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    48
            "-processorpath", System.getProperty("test.class.path")
25289
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    49
        };
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    50
        File[] files = {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    51
            new File(System.getProperty("test.src"), "p/package-info.java")
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    52
        };
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    53
        run_test(opts, files);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    54
    }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    55
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    56
    static void run_test(String[] opts, File[] files) throws IOException {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    57
        DiagnosticListener<JavaFileObject> dl = new DiagnosticListener<JavaFileObject>() {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    58
            public void report(Diagnostic diagnostic) {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    59
                throw new Error(diagnostic.toString());
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    60
            }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    61
        };
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    62
        JavaCompiler c = ToolProvider.getSystemJavaCompiler();
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    63
        StandardJavaFileManager fm = c.getStandardFileManager(null, null, null);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    64
        Iterable<? extends JavaFileObject> units = fm.getJavaFileObjects(files);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    65
        JavacTask t = (JavacTask) c.getTask(null, fm, dl, Arrays.asList(opts), null, units);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    66
        t.parse();
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    67
        t.analyze();
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    68
    }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    69
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    70
    // -- Annotation processor: Check all PackageDecl's have a doc comment
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    71
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    72
    @Override
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    73
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    74
        for (Element e: roundEnv.getRootElements())
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    75
            new TestElementScanner().scan(e);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    76
        return true;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    77
    }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    78
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 25289
diff changeset
    79
    class TestElementScanner extends ElementScanner<Void, Void> {
25289
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    80
        @Override
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    81
        public Void visitPackage(PackageElement e, Void v) {
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    82
            if (elements.getDocComment(e) == null)
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    83
                messager.printMessage(Diagnostic.Kind.ERROR, "doc comment is null", e);
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    84
            return v;
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    85
        }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    86
    }
9573116c764c 8042345: getDocComment fails for doc comments on PackageElement found in package-info.java
pgovereau
parents:
diff changeset
    87
}