Mercurial > jdk8-mips64-public > langtools / annotate
test/tools/javac/diags/DocCommentProcessor.java@71f35e4b93a5 (annotated)
test/tools/javac/diags/DocCommentProcessor.java
Wed, 23 Jan 2013 13:27:24 -0800
- author
- jjg
- date
- Wed, 23 Jan 2013 13:27:24 -0800
- changeset 1521
- 71f35e4b93a5
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
8006775: JSR 308: Compiler changes in JDK8
Reviewed-by: jjg
Contributed-by: mernst@cs.washington.edu, wmdietl@cs.washington.edu, mpapi@csail.mit.edu, mahmood@notnoop.com
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. |
| aoqi@0 | 8 | * |
| aoqi@0 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 13 | * accompanied this code). |
| aoqi@0 | 14 | * |
| aoqi@0 | 15 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 18 | * |
| aoqi@0 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 20 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 21 | * questions. |
| aoqi@0 | 22 | */ |
| aoqi@0 | 23 | |
| aoqi@0 | 24 | import java.util.*; |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | import javax.annotation.processing.*; |
| aoqi@0 | 27 | import javax.lang.model.*; |
| aoqi@0 | 28 | import javax.lang.model.element.*; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import com.sun.source.doctree.DocCommentTree; |
| aoqi@0 | 31 | import com.sun.source.doctree.ErroneousTree; |
| aoqi@0 | 32 | import com.sun.source.tree.ClassTree; |
| aoqi@0 | 33 | import com.sun.source.tree.MethodTree; |
| aoqi@0 | 34 | import com.sun.source.tree.VariableTree; |
| aoqi@0 | 35 | import com.sun.source.util.DocTreeScanner; |
| aoqi@0 | 36 | import com.sun.source.util.DocTrees; |
| aoqi@0 | 37 | import com.sun.source.util.TreePath; |
| aoqi@0 | 38 | import com.sun.source.util.TreePathScanner; |
| aoqi@0 | 39 | import com.sun.source.util.TreeScanner; |
| aoqi@0 | 40 | import com.sun.tools.javac.tree.DocPretty; |
| aoqi@0 | 41 | import java.io.PrintWriter; |
| aoqi@0 | 42 | import javax.tools.Diagnostic; |
| aoqi@0 | 43 | |
| aoqi@0 | 44 | /** |
| aoqi@0 | 45 | * Standard annotation processor for use by examples to |
| aoqi@0 | 46 | * scan DocCommentTree nodes looking for ErroneousTree, |
| aoqi@0 | 47 | * on which to call {@code getMessage}. |
| aoqi@0 | 48 | */ |
| aoqi@0 | 49 | @SupportedAnnotationTypes("*") |
| aoqi@0 | 50 | public class DocCommentProcessor extends AbstractProcessor { |
| aoqi@0 | 51 | @Override |
| aoqi@0 | 52 | public SourceVersion getSupportedSourceVersion() { |
| aoqi@0 | 53 | return SourceVersion.latest(); |
| aoqi@0 | 54 | } |
| aoqi@0 | 55 | |
| aoqi@0 | 56 | @Override |
| aoqi@0 | 57 | public void init(ProcessingEnvironment pEnv) { |
| aoqi@0 | 58 | super.init(pEnv); |
| aoqi@0 | 59 | trees = DocTrees.instance(pEnv); |
| aoqi@0 | 60 | messager = pEnv.getMessager(); |
| aoqi@0 | 61 | } |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | @Override |
| aoqi@0 | 64 | public boolean process(Set<? extends TypeElement> annos, RoundEnvironment rEnv) { |
| aoqi@0 | 65 | for (Element e : rEnv.getRootElements()) { |
| aoqi@0 | 66 | new DocCommentScanner().scan(e); |
| aoqi@0 | 67 | } |
| aoqi@0 | 68 | return true; |
| aoqi@0 | 69 | } |
| aoqi@0 | 70 | |
| aoqi@0 | 71 | class DocCommentScanner extends TreePathScanner<Void,Void> { |
| aoqi@0 | 72 | public void scan(Element e) { |
| aoqi@0 | 73 | scan(trees.getPath(e), null); |
| aoqi@0 | 74 | } |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | @Override |
| aoqi@0 | 77 | public Void visitClass(ClassTree tree, Void ignore) { |
| aoqi@0 | 78 | check(); |
| aoqi@0 | 79 | return super.visitClass(tree, ignore); |
| aoqi@0 | 80 | } |
| aoqi@0 | 81 | |
| aoqi@0 | 82 | @Override |
| aoqi@0 | 83 | public Void visitMethod(MethodTree tree, Void ignore) { |
| aoqi@0 | 84 | check(); |
| aoqi@0 | 85 | return super.visitMethod(tree, ignore); |
| aoqi@0 | 86 | } |
| aoqi@0 | 87 | |
| aoqi@0 | 88 | @Override |
| aoqi@0 | 89 | public Void visitVariable(VariableTree tree, Void ignore) { |
| aoqi@0 | 90 | check(); |
| aoqi@0 | 91 | return super.visitVariable(tree, ignore); |
| aoqi@0 | 92 | } |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | private void check() { |
| aoqi@0 | 95 | DocCommentTree dc = trees.getDocCommentTree(getCurrentPath()); |
| aoqi@0 | 96 | if (dc == null) |
| aoqi@0 | 97 | return; |
| aoqi@0 | 98 | |
| aoqi@0 | 99 | DocTreeScanner<Void, Void> s = new DocTreeScanner<Void, Void>() { |
| aoqi@0 | 100 | @Override |
| aoqi@0 | 101 | public Void visitErroneous(ErroneousTree tree, Void ignore) { |
| aoqi@0 | 102 | messager.printMessage(Diagnostic.Kind.NOTE, tree.getDiagnostic().getMessage(null)); |
| aoqi@0 | 103 | return null; |
| aoqi@0 | 104 | } |
| aoqi@0 | 105 | }; |
| aoqi@0 | 106 | |
| aoqi@0 | 107 | s.scan(dc, null); |
| aoqi@0 | 108 | } |
| aoqi@0 | 109 | |
| aoqi@0 | 110 | } |
| aoqi@0 | 111 | |
| aoqi@0 | 112 | private DocTrees trees; |
| aoqi@0 | 113 | private Messager messager; |
| aoqi@0 | 114 | } |
