archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-20 11:04:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8056061: Mark implementations of public interfaces with an annotation

Browse source 
Adding @DefinedBy annotation to mark methods that implement public API methods; annotating the methods; adding a coding rules analyzer to enforce all such methods are annotated.

Co-authored-by: Jonathan Gibbons <jonathan.gibbons@oracle.com>
Reviewed-by: jjg, mcimadamore, jfranck
This commit is contained in:
Jan Lahoda 2014-08-27 07:44:00 +02:00
parent afd18d4cd4
commit c9406c88c4
64 changed files with 1307 additions and 414 deletions
Download patch file Download diff file Expand all files Collapse all files

12
langtools/make/tools/crules/CodingRulesAnalyzerPlugin.java
View file

@ -41,6 +41,8 @@ import com.sun.source.util.Trees;
import com.sun.tools.javac.api.BasicJavacTask;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.DefinedBy;
import com.sun.tools.javac.util.DefinedBy.Api;
import com.sun.tools.javac.util.Log;
public class CodingRulesAnalyzerPlugin implements Plugin {
@ -48,6 +50,7 @@ public class CodingRulesAnalyzerPlugin implements Plugin {
protected Log log;
protected Trees trees;
@DefinedBy(Api.COMPILER_TREE)
public void init(JavacTask task, String... args) {
BasicJavacTask impl = (BasicJavacTask)task;
Context context = impl.getContext();
@ -55,7 +58,8 @@ public class CodingRulesAnalyzerPlugin implements Plugin {
trees = Trees.instance(task);
task.addTaskListener(new PostAnalyzeTaskListener(
new MutableFieldsAnalyzer(task),
new AssertCheckAnalyzer(task)
new AssertCheckAnalyzer(task),
new DefinedByAnalyzer(task)
));
}
@ -74,10 +78,10 @@ public class CodingRulesAnalyzerPlugin implements Plugin {
}
}
@Override
@Override @DefinedBy(Api.COMPILER_TREE)
public void started(TaskEvent taskEvent) {}
@Override
@Override @DefinedBy(Api.COMPILER_TREE)
public void finished(TaskEvent taskEvent) {
List<AbstractCodingRulesAnalyzer> currentAnalyzers = this.analyzers.get(taskEvent.getKind());
@ -99,7 +103,7 @@ public class CodingRulesAnalyzerPlugin implements Plugin {
}
}
@Override
@Override @DefinedBy(Api.COMPILER_TREE)
public String getName() {
return "coding_rules";
}