[jboss-cvs] JBossAS SVN: r63216 - projects/aop/trunk/aop/docs/reference/reference/en/modules.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Fri May 25 17:22:36 EDT 2007


Author: kabir.khan at jboss.com
Date: 2007-05-25 17:22:36 -0400 (Fri, 25 May 2007)
New Revision: 63216

Modified:
   projects/aop/trunk/aop/docs/reference/reference/en/modules/jdk14compatibility.xml
Log:
Fix language a bit.
JDK1.5 => JDK 5
JDK1.4 => JDK 1.4

Modified: projects/aop/trunk/aop/docs/reference/reference/en/modules/jdk14compatibility.xml
===================================================================
--- projects/aop/trunk/aop/docs/reference/reference/en/modules/jdk14compatibility.xml	2007-05-25 20:37:48 UTC (rev 63215)
+++ projects/aop/trunk/aop/docs/reference/reference/en/modules/jdk14compatibility.xml	2007-05-25 21:22:36 UTC (rev 63216)
@@ -1,8 +1,8 @@
 <chapter id="jdk14compatibility">
    <title>JDK 1.4 Backwards Compatibility</title>
    <para>
-      Despite the fact that it has been a while since the release of JDK1.5, there are projects
-      that still require backwards compatibility with JDK1.4. This is relatively common, and
+      Despite the fact that it has been a while since the release of JDK 5, there are projects
+      that still require backwards compatibility with JDK 1.4. This is relatively common, and
       the reasons for it are diverse.
       To deal with this type of requirement, JBoss AOP provides two different solutions. By using
       one of them, you can use all features JBoss AOP provides, including annotation-related
@@ -11,17 +11,17 @@
    <sect1 id="jdk14-jbossretro" revision="1">
       <title>JBoss Retro</title>
       <para>
-         The first solution to achieve JDK1.4 backwards compatibility is to use the JBoss Retro
-         tool. JBoss Retro converts JDK1.5 compiled bytecodes into bytecodes that can be
-         run using a JDK1.4 virtual machine.
+         The first solution to achieve JDK 1.4 backwards compatibility is to use the JBoss Retro
+         tool. JBoss Retro converts JDK 5 compiled bytecodes into bytecodes that can be
+         run using a JDK 1.4 virtual machine.
       </para>
       <para>
          This tool acts as a bytecode processor, and using it is very simple. You just need to
-         write your code using JDK1.5 constructs and features, and then compile it,
-         using a JDK1.5 virtual machine. Next, process the generated bytecodes using
+         write your code using JDK 5 constructs and features, and then compile it,
+         using JDK 5. Next, process the generated bytecodes using
          JBoss Retro tool (just like you do when you use aopc compiler), and now your
-         bytecodes are ready to run using a JDK1.4 virtual machine. Notice this solution
-         allows not only the use of JBoss AOP annotations, but of all JDK1.5 features and
+         bytecodes are ready to run using a JDK 1.4 virtual machine. Notice this solution
+         allows not only the use of JBoss AOP annotations, but of most JDK 5 features and
          new API operations.
       </para>
       <para>
@@ -84,24 +84,24 @@
          [-bytecode]&lt;files&gt;+
             </programlisting>
       <para>
-         JBoss Retro is the de facto standard solution JBoss Group provides to achieve JDK1.4 backward compatibility.
-         However, if you are impossibilitated of compiling your code using a JDK1.5 virtual machine, you should go with the next solution,
+         JBoss Retro is the de facto standard solution JBoss Group provides to achieve JDK 1.4 backward compatibility.
+         However, if you do not have the option to compile your code using JDK 5, you should go with the next solution,
          the annotation compiler.
       </para>
    </sect1>
    <sect1 id="jdk14-anncompiler" revision="1">
       <title>JDK1.4 Annotation Compiler</title>
       <para>
-         Differently from JBoss Retro, the annotation compiler does not support all JDK1.5 constructs and new APIs.
+         Unlike JBoss Retro, the annotation compiler does not support all JDK 5 constructs and new APIs.
          Its functionality consists in supporting only annotations, that must be written in the form of doclets.
-         Nevertheless, this is enough to allow the use of all JBoss AOP features, and doesn't require a JDK1.5
+         Nevertheless, this is enough to allow the use of all JBoss AOP features, and doesn't require a JDK 5
          compiler.
       </para>
       <para>
-         This way, if you can't use a JDK1.5 compiler to compile your code, you should stick with the annotation
+         This way, if you can't use a JDK 5 compiler to compile your code, you should stick with the annotation
          compiler. It will process your application's bytecodes, transforming doclets into annotations.
          The result of this transformation is that your doclets will become viewable by JBoss AOP as
-         if they were regular JDK1.5 annotations.
+         if they were regular JDK 5 annotations.
       </para>
       <para>
          In the next sections, we will see what is the format your doclets need to follow in order to be
@@ -112,8 +112,8 @@
          <title>Annotations with JDK 1.4.2</title>
 
          <para>
-            In JDK 1.5, annotations must map to an annotation type, which is defined using the following sintax:
-   
+            In JDK 5, annotations must map to an annotation type, which is defined using the following syntax:
+
          <programlisting>
    package com.mypackage;
 
@@ -131,7 +131,7 @@
             <programlisting>
    package com.mypackage;
 
-   public interface MyAnnotation
+   public interface MyAnnotation extends org.jboss.lang.Annotation
    {
       String myString();
       int myInteger();
@@ -140,6 +140,12 @@
          </para>
 
          <para>
+            One difference from AOP 1.x is that the interfaces defining the annotations must now extend
+            <literal>org.jboss.lang.Annotation</literal>, this is because JBoss Retro is now the primary
+            mechanism for using annotations in JDK 1.4.
+         </para>
+
+         <para>
             The syntax for using annotations in JDK 1.4.2 is almost exactly the same as
             JDK 5 annotations except for these subtle differences:
             <itemizedlist>
@@ -193,7 +199,7 @@
    }
             </programlisting>
          </para>
-         
+
          <para>
             The next aspect is the JDK1.4.2 version of the <link linkend="introductionEx">@Introduction
             exammple</link> (<xref linkend="annotated"/>). Notice the slight difference in the JDK 1.4.2 annotation: class




More information about the jboss-cvs-commits mailing list