AnnaBot : A Static Verifier for Java Annotation Usage

Abstract EN

This paper describes AnnaBot, one of the first tools to verify correct use of Annotation-based metadata in the Java programming language.

These Annotations are a standard Java 5 mechanism used to attach metadata to types, methods, or fields without using an external configuration file.

A binary representation of the Annotation becomes part of the compiled “.class” file, for inspection by another component or library at runtime.

Java Annotations were introduced into the Java language in 2004 and have become widely used in recent years due to their introduction in the Java Enterprise Edition 5, the Hibernate object-relational mapping API, the Spring Framework, and elsewhere.

Despite that, mainstream development tools have not yet produced a widely-used verification tool to confirm correct configuration and placement of annotations external to the particular runtime component.

While most of the examples in this paper use the Java Persistence API, AnnaBot is capable of verifying anyannotation-based API for which “claims”—description of annotation usage—are available.

These claims can be written in Java or using a proposed Domain-Specific Language, which has been designed and a parser (but not the code generator) have been written.