Skip to main content

Java Annotations

A few days ago in our project we needed that the field which we are using should not be displayed to the user but relevant title should be displayed. This title will never change as this property is one of the important properties of that class.
There I thought that Java Annotations might be useful for me in this case, now for those who don't know about annotations I will explain a little about them.


Java Annotations is the feature provided by Java with the help of which we can add data to our class, method or fields.
Now there are three different ways of annotations that we can use.

Types
Source  - These types of annotations are not present in class file, they are only present in the source file and they are discarded by the compiler.
Class     - These types of annotations are present in class file and source file, they are not loaded by JVM.
Runtime - These types of annotations are present in class file and source file and they are also loaded by JVM which we can use at runtime.

How to create Annotations


Writing Java Annotations is very easy. Its the same way we create an interface but just with @ sign preceding to interface.
Here is an example.

// We want that our annotation should be compiled and should be loaded by JVM.
@Retention(RetentionPolicy.RUNTIME)
public @interface DisplayName{
     String value();
}

Note the declaration of the variable value, we don't need to write getter or setter method for the variables in the annotation, that is managed by Java.

How to use Annotations
Now as we have our annotation ready, we can use it.
Following example shows how can we apply annotations.

@DisplayName("Center")
public class Centers{
     private Integer center_id;
  
     @DisplayName("Center Name")
     private String centerName;

     // other code
}

This is how we can use our annotations, now we can access them in our Java code. Following is an example how we can use annotations.

public class AnTest{
     public static void main(String args[]){
          Center c= new Center();
          System.out.println(c.getClass().getAnnotation(DisplayName.class).value());
     }
}

This will print the value for DisplayName annotation assigned to Centers class.
Annotations are really useful, with which we can add metadata to our fields, classes and methods.
More information about annotations
Annotations
http://download.oracle.com/javase/tutorial/java/javaOO/annotations.html
http://en.wikipedia.org/wiki/Java_annotation

Comments

Post a Comment

Popular posts from this blog

Spring AOP : JDK Proxy vs CGLib Proxy

Spring framework is one of the most widely used framework in Enterprise application development. It has so many features such as Dependency injection, Data access integration, MVC, AOP which takes care of most of the boilerplate part of project, and developers can then focus on business logic only.

One of the important feature in Spring is AOP. It is used by almost every enterprise application which is being developed using Spring.

AOP So what is AOP? Definition of AOP -
Aspect oriented programming is a programming paradigm which aims to increase modularity by allowing the separation of cross cutting concerns. Well, my understanding of AOP is - AOP allows us to introduce/join new modules in your project at pre-specified dynamic locations without having to code for it. Traditional examples of AOP is Transaction management, logging etc. You can read more about AOP at here.

This article is for those who know AOP, have used AOP in their projects but do not know how Spring or other DI fra…

Java Tools Plugin for Notepad++

This post and the plugin is outdated. Please use plugin from this link which is updated and allows customization of shortcut key mappings and much more.
Notepad++ is a great free editor. I like notepad++ because its a light weight editor and loads instantly. I use notepad++ for editing many files everyday. One plugin I always wanted was a plugin which lets me compile my java files and execute them from editor itself, but I couldn't find it so I wrote a myself. This plugin can be downloaded from this link.
I am working on this plugin to make it more effective, so that if user have more than one installations of JDK or JRE then user should be able to choose which one to use etc.
This is a simple plugin which has two commands-
Compile - compiles a java file.
Run - executes a java file.
For using this plugin Java must be installed on the system.

Notepad++ Compile and Run Java Programs

Notepad++ is a great file editor. It has many features. The most important feature which I like about Notepad++ is its light weight. It loads up so quickly, that's great. It also provides syntax highlighting for many languages. I use notepad++ to edit general files as well as my simple Java programs.
Although notepad++ provides functionality to run external programs, I prefer NppJavaTools plugin to compile and run Java programs using notepad++.
You can download NppJavaTools plugin from this page - NppJavaTools.

Installation
Installation of plugins in notepad++ is very simple process. All you have to do is copy plugin dll into plugins folder of notepad++ installation directory and restart the notepad++.

Features
This plugin provides following features,


Compile and run your Java files within Notepad++Set custom hotkeys for compiling and running Java CodeLibrary support Compile and RunThis function allows you to run your Java programs to compile and run from Notepad++. Set Custom hotkeysThi…