svn commit: r1077967 - in /commons/proper/lang/trunk/src: main/java/org/apache/commons/lang3/JavaVersion.java test/java/org/apache/commons/lang3/JavaVersionTest.java

[scolebourne]

Author: scolebourne
Date: Fri Mar  4 14:34:05 2011
New Revision: 1077967

URL: http://svn.apache.org/viewvc?rev=1077967&view=rev
Log:
Javadoc and add toString()

Modified:
    
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
    
commons/proper/lang/trunk/src/test/java/org/apache/commons/lang3/JavaVersionTest.java

Modified: 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
URL: 
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java?rev=1077967&r1=1077966&r2=1077967&view=diff
==============================================================================
--- 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
 (original)
+++ 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
 Fri Mar  4 14:34:05 2011
@@ -36,24 +36,35 @@ public enum JavaVersion {
     JAVA_1_7(1.7f, "1.7"),
     JAVA_1_8(1.8f, "1.8");
 
+    /**
+     * The float value.
+     */
     private float value;
+    /**
+     * The standard name.
+     */
     private String name;
 
+    /**
+     * Constructor.
+     * 
+     * @param value  the float value
+     * @param name  the standard name, not null
+     */
     JavaVersion(final float value, final String name) {
         this.value = value;
         this.name = name;
     }
 
+    //-----------------------------------------------------------------------
     /**
-     * Whether this version of Java is at least the version 
-     * of Java passed in.
-     *
-     * For example:
-     *  myVersion.atLeast(JavaVersion.JAVA_1_4)
+     * <p>Whether this version of Java is at least the version of Java passed 
in.</p>
      *
-     * @param requiredVersion to check this version is at least equivalent to
+     * <p>For example:<br />
+     *  {@code myVersion.atLeast(JavaVersion.JAVA_1_4)}<p>
      *
-     * @return Whether this version is at least the passed in version
+     * @param requiredVersion  the version to check against, not null
+     * @return true if this version is equal to or greater than the specified 
version
      */
     public boolean atLeast(JavaVersion requiredVersion) {
         return this.value >= requiredVersion.value;
@@ -63,35 +74,42 @@ public enum JavaVersion {
     static JavaVersion getJavaVersion(final String nom) {
         return get(nom);
     }
+
     static JavaVersion get(final String nom) {
-        if("0.9".equals(nom)) {
+        if ("0.9".equals(nom)) {
             return JAVA_0_9;
-        } else
-        if("1.1".equals(nom)) {
+        } else if ("1.1".equals(nom)) {
             return JAVA_1_1;
-        } else
-        if("1.2".equals(nom)) {
+        } else if ("1.2".equals(nom)) {
             return JAVA_1_2;
-        } else
-        if("1.3".equals(nom)) {
+        } else if ("1.3".equals(nom)) {
             return JAVA_1_3;
-        } else
-        if("1.4".equals(nom)) {
+        } else if ("1.4".equals(nom)) {
             return JAVA_1_4;
-        } else
-        if("1.5".equals(nom)) {
+        } else if ("1.5".equals(nom)) {
             return JAVA_1_5;
-        } else
-        if("1.6".equals(nom)) {
+        } else if ("1.6".equals(nom)) {
             return JAVA_1_6;
-        } else
-        if("1.7".equals(nom)) {
+        } else if ("1.7".equals(nom)) {
             return JAVA_1_7;
-        } else
-        if("1.8".equals(nom)) {
+        } else if ("1.8".equals(nom)) {
             return JAVA_1_8;
         } else {
             return null;
         }
     }
+
+    //-----------------------------------------------------------------------
+    /**
+     * <p>The string value is overridden to return the standard name.</p>
+     * 
+     * <p>For example, '1.5'.</p>
+     * 
+     * @return the name, not null
+     */
+    @Override
+    public String toString() {
+        return name;
+    }
+
 }

Modified: 
commons/proper/lang/trunk/src/test/java/org/apache/commons/lang3/JavaVersionTest.java
URL: 
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/test/java/org/apache/commons/lang3/JavaVersionTest.java?rev=1077967&r1=1077966&r2=1077967&view=diff
==============================================================================
--- 
commons/proper/lang/trunk/src/test/java/org/apache/commons/lang3/JavaVersionTest.java
 (original)
+++ 
commons/proper/lang/trunk/src/test/java/org/apache/commons/lang3/JavaVersionTest.java
 Fri Mar  4 14:34:05 2011
@@ -18,8 +18,17 @@
  */
 package org.apache.commons.lang3;
 
-import static org.apache.commons.lang3.JavaVersion.*;
-
+import static org.apache.commons.lang3.JavaVersion.JAVA_0_9;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_1;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_2;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_3;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_4;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_5;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_6;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_7;
+import static org.apache.commons.lang3.JavaVersion.JAVA_1_8;
+import static org.apache.commons.lang3.JavaVersion.get;
+import static org.apache.commons.lang3.JavaVersion.getJavaVersion;
 import junit.framework.TestCase;
 
 /**
@@ -53,4 +62,8 @@ public class JavaVersionTest extends Tes
         assertFalse("0.9 at least 1.6 passed", JAVA_0_9.atLeast(JAVA_1_6));
     }
 
+    public void testToString() {
+        assertEquals("1.2", JAVA_1_2.toString());
+    }
+
 }