Java annotation

In the Java computer programming language, an annotation is a form of syntactic metadata that can be added to Java source code. ^[1] Classes, methods, variables, parameters and Java packages may be annotated. Like Javadoc tags, Java annotations can be read from source files. Unlike Javadoc tags, Java annotations can also be embedded in and read from Java class files generated by the Java compiler. This allows annotations to be retained by the Java virtual machine at run-time and read via reflection. ^[2] It is possible to create meta-annotations out of the existing ones in Java. ^[3]

History

The Java platform has various ad-hoc annotation mechanisms—for example, the transient modifier, or the @Deprecated javadoc tag. The Java Specification Request JSR-175 introduced the general-purpose annotation (also known as metadata) facility to the Java Community Process in 2002; it gained approval in September 2004. ^[4] Annotations became available in the language itself beginning with version 1.5 of the Java Development Kit (JDK). The apt tool provided a provisional interface for compile-time annotation processing in JDK version 1.5; JSR-269 formalized this, and it became integrated into the javac compiler in version 1.6.

Built-in annotations

Java defines a set of annotations that are built into the language. Of the seven standard annotations, three are part of java.lang, and the remaining four are imported from java.lang.annotation. ^{[5] [6]}

Annotations applied to Java code:

• @Override - Checks that the method is an override. Causes a compilation error if the method is not found in one of the parent classes or implemented interfaces.
• @Deprecated - Marks the method as obsolete. Causes a compile warning if the method is used.
• @SuppressWarnings - Instructs the compiler to suppress the compile time warnings specified in the annotation parameters.

Annotations applied to other annotations (also known as "Meta Annotations"):

• @Retention - Specifies how the marked annotation is stored, whether in code only, compiled into the class, or available at runtime through reflection.
• @Documented - Marks another annotation for inclusion in the documentation.
• @Target - Marks another annotation to restrict what kind of Java elements the annotation may be applied to.
• @Inherited - Marks another annotation to be inherited to subclasses of annotated class (by default annotations are not inherited by subclasses).

Since Java 7, three additional annotations have been added to the language.

• @SafeVarargs - Suppress warnings for all callers of a method or constructor with a generics varargs parameter, since Java 7.
• @FunctionalInterface - Specifies that the type declaration is intended to be a functional interface, since Java 8.
• @Repeatable - Specifies that the annotation can be applied more than once to the same declaration, since Java 8.

Example

Built-in annotations

This example demonstrates the use of the @Override annotation. It instructs the compiler to check parent classes for matching methods. In this case, an error is generated because the gettype() method of class Cat doesn't in fact override getType() of class Animal like is desired, because of the mismatching case. If the @Override annotation were absent, a new method of name gettype() would be created in class Cat.

publicclassAnimal{publicvoidspeak(){}publicStringgetType(){return"Generic animal";}}publicclassCatextendsAnimal{@Overridepublicvoidspeak(){// This is a good override.System.out.println("Meow.");}@OverridepublicStringgettype(){// Compile-time error due to typo: should be getType() not gettype().return"Cat";}}

Custom annotations

Annotation type declarations are similar to normal interface declarations. An at-sign (@) precedes the keyword "interface".

// @Twizzle is an annotation to method toggle().@Twizzlepublicvoidtoggle(){}// Declares the annotation Twizzle.public@interfaceTwizzle{}

Annotations may include a set of key-value pairs, which are modeled as methods of the annotation type. Each method declaration defines an element of the annotation type. Method declarations must not have any parameters or a throws clause. Return types are restricted to primitives, String, Class, enums, annotations, and arrays of the preceding types. Methods can have default values.

// Same as: @Edible(value = true)@Edible(true)Itemitem=newCarrot();public@interfaceEdible{booleanvalue()defaultfalse;}@Author(first="Oompah",last="Loompah")Bookbook=newBook();public@interfaceAuthor{Stringfirst();Stringlast();}

Annotations themselves may be annotated to indicate where and when they can be used:

@Retention(RetentionPolicy.RUNTIME)// Make this annotation accessible at runtime via reflection.@Target({ElementType.METHOD})// This annotation can only be applied to class methods.public@interfaceTweezable{}

The compiler reserves a set of special annotations (including @Deprecated, @Override and @SuppressWarnings) for syntactic purposes.

Annotations are often used by frameworks as a way of conveniently applying behaviours to user-defined classes and methods that must otherwise be declared in an external source (such as an XML configuration file) or programmatically (with API calls). The following, for example, is an annotated JPA data class:

@Entity// Declares this an entity bean@Table(name="people")// Maps the bean to SQL table "people"publicclassPersonimplementsSerializable{@Id// Map this to the primary key column.@GeneratedValue(strategy=GenerationType.AUTO)// Database will generate new primary keys, not us.privateIntegerid;@Column(length=32)// Truncate column values to 32 characters.privateStringname;publicIntegergetId(){returnid;}publicvoidsetId(Integerid){this.id=id;}publicStringgetName(){returnname;}publicvoidsetName(Stringname){this.name=name;}}

The annotations are not method calls and will not, by themselves, do anything. Rather, the class object is passed to the JPA implementation at run-time, which then extracts the annotations to generate an object–relational mapping.

A complete example is given below:

packagecom.annotation;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Inherited;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD,ElementType.CONSTRUCTOR,ElementType.ANNOTATION_TYPE,ElementType.PACKAGE,ElementType.FIELD,ElementType.LOCAL_VARIABLE})@Inheritedpublic@interfaceUnfinished{publicenumPriority{LOW,MEDIUM,HIGH}Stringvalue();String[]changedBy()default"";String[]lastChangedBy()default"";Prioritypriority()defaultPriority.MEDIUM;StringcreatedBy()default"James Gosling";StringlastChanged()default"2011-07-08";}

packagecom.annotation;public@interfaceUnderConstruction{Stringowner()default"Patrick Naughton";Stringvalue()default"Object is Under Construction.";StringcreatedBy()default"Mike Sheridan";StringlastChanged()default"2011-07-08";}

packagecom.validators;importjavax.faces.application.FacesMessage;importjavax.faces.component.UIComponent;importjavax.faces.context.FacesContext;importjavax.faces.validator.Validator;importjavax.faces.validator.ValidatorException;importcom.annotation.UnderConstruction;importcom.annotation.Unfinished;importcom.annotation.Unfinished.Priority;importcom.util.Util;@UnderConstruction(owner="Jon Doe")publicclassDateValidatorimplementsValidator{publicvoidvalidate(FacesContextcontext,UIComponentcomponent,Objectvalue)throwsValidatorException{Stringdate=(String)value;StringerrorLabel="Please enter a valid date.";if(!component.getAttributes().isEmpty()){errorLabel=(String)component.getAttributes().get("errordisplayval");}if(!Util.validateAGivenDate(date)){@Unfinished(changedBy="Steve",value="whether to add message to context or not, confirm",priority=Priority.HIGH)FacesMessagemessage=newFacesMessage();message.setSeverity(FacesMessage.SEVERITY_ERROR);message.setSummary(errorLabel);message.setDetail(errorLabel);thrownewValidatorException(message);}}}

Processing

When Java source code is compiled, annotations can be processed by compiler plug-ins called annotation processors. Processors can produce informational messages or create additional Java source files or resources, which in turn may be compiled and processed. However, annotation processors cannot modify the annotated code itself. (Code modifications may be implemented using methods beyond the Java Language Specification.) The Java compiler conditionally stores annotation metadata in the class files, if the annotation has a RetentionPolicy of CLASS or RUNTIME. Later, the JVM or other programs can look for the metadata to determine how to interact with the program elements or change their behavior.

In addition to processing an annotation using an annotation processor, a Java programmer can write their own code that uses reflection to process the annotation. Java SE 5 supports a new interface that is defined in the java.lang.reflect package. This package contains the interface called AnnotatedElement that is implemented by the Java reflection classes including Class, Constructor, Field, Method, and Package. The implementations of this interface are used to represent an annotated element of the program currently running in the Java Virtual Machine. This interface allows annotations to be read reflectively.

The AnnotatedElement interface provides access to annotations having RUNTIME retention. This access is provided by the getAnnotation, getAnnotations, and isAnnotationPresent methods. Because annotation types are compiled and stored in byte code files just like classes, the annotations returned by these methods can be queried just like any regular Java object. A complete example of processing an annotation is provided below:

importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;// This is the annotation to be processed// Default for Target is all Java Elements// Change retention policy to RUNTIME (default is CLASS)@Retention(RetentionPolicy.RUNTIME)public@interfaceTypeHeader{// Default value specified for developer attributeStringdeveloper()default"Unknown";StringlastModified();String[]teamMembers();intmeaningOfLife();}

// This is the annotation being applied to a class@TypeHeader(developer="Bob Bee",lastModified="2013-02-12",teamMembers={"Ann","Dan","Fran"},meaningOfLife=42)publicclassSetCustomAnnotation{// Class contents go here}

// This is the example code that processes the annotationimportjava.lang.annotation.Annotation;importjava.lang.reflect.AnnotatedElement;publicclassUseCustomAnnotation{publicstaticvoidmain(String[]args){Class<SetCustomAnnotation>classObject=SetCustomAnnotation.class;readAnnotation(classObject);}staticvoidreadAnnotation(AnnotatedElementelement){try{System.out.println("Annotation element values: \n");if(element.isAnnotationPresent(TypeHeader.class)){// getAnnotation returns Annotation typeAnnotationsingleAnnotation=element.getAnnotation(TypeHeader.class);TypeHeaderheader=(TypeHeader)singleAnnotation;System.out.println("Developer: "+header.developer());System.out.println("Last Modified: "+header.lastModified());// teamMembers returned as String []System.out.print("Team members: ");for(Stringmember:header.teamMembers())System.out.print(member+", ");System.out.print("\n");System.out.println("Meaning of Life: "+header.meaningOfLife());}}catch(Exceptionexception){exception.printStackTrace();}}}

See also

• Jakarta Annotations
• CLI Attributes
• Java
• Java virtual machine
• Model-driven architecture
• Python decorators, inspired by Java annotations, which have a similar syntax.

References

1. "Annotations". Sun Microsystems. Archived from the original on 2011-09-25. Retrieved 2011-09-30..
2. Sun Microsystems (2005). Java(TM) Language Specification (3rd ed.). Prentice Hall. ISBN   0-321-24678-0..
3. Dare Obasanjo (2007). "A COMPARISON OF MICROSOFT'S C# PROGRAMMING LANGUAGE TO SUN MICROSYSTEMS' JAVA PROGRAMMING LANGUAGE: Metadata Annotations". Dare Obasanjo. Archived from the original on 2012-09-19. Retrieved 2012-09-20.
4. Coward, Danny (2006-11-02). "JSR 175: A Metadata Facility for the JavaTM Programming Language". Java Community Process . Retrieved 2008-03-05.
5. "Predefined Annotation Types". Oracle Corporation . Retrieved 2016-12-17.
6. "The Built-In Annotations : Standard Annotations" . Retrieved 2016-12-17.

External links

• Introduction to Java 6 Annotations at Sun Developer Network Site
• An Introduction to Java Annotations by M. M. Islam Chisty
• Introduction to Java 5.0 Annotations by Joy Christy
• Of Java Annotations by John Hunt
• Custom Annotations in Java
• Java Annotations Explained
• Understanding Annotations in Java