Java Annotation Essentials, from Binary code point of view, with example of java.lang.Deprecated

Java Annotations provides a mechanism to document and extend the code in Java programming language. Like we can annotation an API as deprecated, mapping the Database table and field to Java class and fields, define the REST API access points, asking JVM to do injections, etc.

Binary Code is always the best document.

Let's take an example from OpenJDK of the very popular annotation java.lang.Deprecated over the Java method java.lang.Class.newInstance() method.

The Deprecated annotation is a widely used in Java source code, to a Java Object has been deprecated, and it could be removed in later release.

Here is the source code of the Deprecated annotation:
80  @Documented
81  @Retention(RetentionPolicy.RUNTIME)
82  @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})
83  public @interface Deprecated {
93      String since() default "";
102     boolean forRemoval() default false;
103 }

The Deprecated type has the following annotations:
  • since() adds a parameter to Deprecated annotation to indicate the Java version in which the annotation element became deprecated
  • forRemoval() adds a parameter to Deprecated annotation to indicate whether annotated element is subject to removal in a future version
The deprecated code was compiled as Deprecated.class, located at /usr/lib/jvm/default-java/jmods/java.base.jmod/classes/java/lang/Deprecated.class for Ubuntu Linux for example.

From the screen shot bellow, we can validate the source code defined elements are included in the Deprecated.class:


java.lang.Deprecated.class on OpenJDK, via Java Class Viewer


The java.lang.Class.newInstance() method is tagged with the Deprecated annotation. Here is the source code of the method:

569    @Deprecated(since="9")
570    public T newInstance()
571        throws InstantiationException, IllegalAccessException
572    {
573       ...
614    }

The @Deprecated(since="9") annotaion means the method Class.newInstance() method was deprecated since Java 9.

Here is the Class.class file, located at /usr/lib/jvm/default-java/jmods/java.base.jmod/classes/java/lang/Class.class for Ubuntu Linux for example. We can validate  the @Deprecated annoation did contained in this binary .class file for Java Virtual Machine to handle, as requried by @Retention(RetentionPolicy.RUNTIME) definiton.


The Java system property java.version contains the Java platform version:
  • When java compiler javac found the current java.version is higher than 9, it may show an warning saying this API has been deprecatedn and please do not call it; the same warning could be shown in Java IDE like Eclipse, IntelliJ IDEA, or Apache NetBeans.

So, this is how the Java annoation works in binary world.


Related Links
Location: Palo Alto, CA, USA

Comments

Post a Comment

Popular posts from this blog

What is Java Synthetic Class (ACC_SYNTHETIC)? with the example of BoundMethodHandle$1.class in Java package java.lang.invoke

Image
When a .class file marked with the ACC_SYNTHETIC flag, it indicates the .class file was generated by compiler and does not appear in the corresponding .java source code . Binary Code is always the best document, so let's check an example: the BoundMethodHandle$1.class class in java.base.jmod in JDK. The class file BoundMethodHandle$1.class has been marked as synthetic flag, as shown bellow: Basic Information of BoundMethodHandle$1.class  UML diagram of BoundMethodHandle$1.class And this class is used by the container class BoundMethodHandle : Dependency Network diagram of BoundMethodHandle$1.class This class does not exist in the original source code BoundMethodHandle.java , but generated by the java compiler, from the following two (2) methods in the Java class BoundMethodHandle : BoundMethodHandle.bindSingle() , at byte code offset 0 BoundMethodHandle.arg() , at byte code offset 17 Byte code of method BoundMethodHandle.bindSingle() ...
Read more

Java Native Methods Essentials, from Binary code point of view, with example of java.lang.Runtime

Image
Java Native method provides a mechanism for Java code to call OS native code, either due to functional or performance reasons. Binary Code is always the best document. Let's take the an example from OpenJDK of the class java.lang.Rutime to discover the details in binary code manner. Here is the source code of the Runtime class: master/src/java.base/share/classes/java/lang/Runtime.java In this class we have the following methods defined as native : 606 public native int availableProcessors(); 617 public native long freeMemory(); 630 public native long totalMemory(); 641 public native long maxMemory(); 664 public native void gc(); For the native Java methods, the corresponding generated methods in the class file will set the ACC_NATIVE ( 0x0100 ) flag, and the there is no bytecode generated in the .class file as other none-native Java methods. The access_flags field is a mask of flags used to denote access permission to and properties of an method: access...
Read more

What is Java Bridge Method (ACC_BRIDGE)?

Image
Java method could be tagged with bridge ( ACC_BRIDGE ) in the .class file, denotes this method is generated by Java Compiler for type erasure purpose of Java Generics . Code is the best document, so let's check the code of java.util.ArrayDeque as an example for the details. In the source code of ArrayDeque , there is only one (1) clone() method defined, as bellow: public ArrayDeque<E> clone() { try { @SuppressWarnings("unchecked") ArrayDeque<E> result = (ArrayDeque<E>) super.clone(); result.elements = Arrays.copyOf(elements, elements.length); return result; } catch (CloneNotSupportedException e) { throw new AssertionError(); } } Well in the generated the .class file for ArrayDeque , there are two (2) clone() methods, as the generated UML diagram from the ArrayDeque.class file shown: UML Diagram of ArrayDeque.class Here are the details of...
Read more