Added @SInCE 1.4 tags.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@793772 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/java/org/apache/commons/codec/binary/Hex.java

@@ -121,6 +121,7 @@ public static char[] encodeHex(byte[] data) {
      * @param toLowerCase
      *            <code>true</code> converts to lowercase, <code>false</code> to uppercase
      * @return A char[] containing hexadecimal characters
+     * @since 1.4
      */
     public static char[] encodeHex(byte[] data, boolean toLowerCase) {
         return encodeHex(data, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER);
@@ -136,19 +137,16 @@ public static char[] encodeHex(byte[] data, boolean toLowerCase) {
      * @param toDigits
      *            the output alphabet
      * @return A char[] containing hexadecimal characters
+     * @since 1.4
      */
     protected static char[] encodeHex(byte[] data, char[] toDigits) {
-
         int l = data.length;
-
         char[] out = new char[l << 1];
-
         // two characters form the hex value.
         for (int i = 0, j = 0; i < l; i++) {
             out[j++] = toDigits[(0xF0 & data[i]) >>> 4];
             out[j++] = toDigits[0x0F & data[i]];
         }
-
         return out;
     }
 

src/java/org/apache/commons/codec/digest/DigestUtils.java

@@ -34,6 +34,26 @@ public class DigestUtils {
 
     private static final int STREAM_BUFFER_LENGTH = 1024;
 
+    /**
+     * Read through an InputStream and returns the digest for the data
+     * 
+     * @param digest The MessageDigest to use (e.g. MD5)
+     * @param data Data to digest
+     * @return MD5 digest
+     * @throws IOException On error reading from the stream
+     */
+    private static byte[] digest(MessageDigest digest, InputStream data) throws IOException {
+        byte[] buffer = new byte[STREAM_BUFFER_LENGTH];
+        int read = data.read(buffer, 0, STREAM_BUFFER_LENGTH);
+        
+        while(read > -1) {
+            digest.update(buffer, 0, read);
+            read = data.read(buffer, 0, STREAM_BUFFER_LENGTH);
+        }
+        
+        return digest.digest();
+    }
+
     /**
      * Returns a <code>MessageDigest</code> for the given <code>algorithm</code>.
      * 
@@ -118,26 +138,6 @@ private static MessageDigest getSha512Digest() {
     private static MessageDigest getShaDigest() {
         return getDigest("SHA");
     }
-
-    /**
-     * Read through an InputStream and returns the digest for the data
-     * 
-     * @param digest The MessageDigest to use (e.g. MD5)
-     * @param data Data to digest
-     * @return MD5 digest
-     * @throws IOException On error reading from the stream
-     */
-    private static byte[] digest(MessageDigest digest, InputStream data) throws IOException {
-        byte[] buffer = new byte[STREAM_BUFFER_LENGTH];
-        int read = data.read(buffer, 0, STREAM_BUFFER_LENGTH);
-        
-        while(read > -1) {
-            digest.update(buffer, 0, read);
-            read = data.read(buffer, 0, STREAM_BUFFER_LENGTH);
-        }
-        
-        return digest.digest();
-    }
 
     /**
      * Calculates the MD5 digest and returns the value as a 16 element <code>byte[]</code>.
@@ -157,6 +157,7 @@ public static byte[] md5(byte[] data) {
      *            Data to digest
      * @return MD5 digest
      * @throws IOException On error reading from the stream
+     * @since 1.4
      */
     public static byte[] md5(InputStream data) throws IOException {
         return digest(getMd5Digest(), data);
@@ -190,8 +191,10 @@ public static String md5Hex(byte[] data) {
      * @param data
      *            Data to digest
      * @return MD5 digest as a hex string
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String md5Hex(String data) {
+    public static String md5Hex(InputStream data) throws IOException {
         return new String(Hex.encodeHex(md5(data)));
     }
 
@@ -201,9 +204,8 @@ public static String md5Hex(String data) {
      * @param data
      *            Data to digest
      * @return MD5 digest as a hex string
-     * @throws IOException On error reading from the stream
      */
-    public static String md5Hex(InputStream data) throws IOException {
+    public static String md5Hex(String data) {
         return new String(Hex.encodeHex(md5(data)));
     }
 
@@ -224,9 +226,10 @@ public static byte[] sha(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-1 digest
+     * @throws IOException On error reading from the stream
      */
-    public static byte[] sha(String data) {
-        return sha(data.getBytes());
+    public static byte[] sha(InputStream data) throws IOException {
+        return digest(getShaDigest(), data);
     }
 
     /**
@@ -235,10 +238,9 @@ public static byte[] sha(String data) {
      * @param data
      *            Data to digest
      * @return SHA-1 digest
-     * @throws IOException On error reading from the stream
      */
-    public static byte[] sha(InputStream data) throws IOException {
-        return digest(getShaDigest(), data);
+    public static byte[] sha(String data) {
+        return sha(data.getBytes());
     }
 
     /**
@@ -250,6 +252,7 @@ public static byte[] sha(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-256 digest
+     * @since 1.4
      */
     public static byte[] sha256(byte[] data) {
         return getSha256Digest().digest(data);
@@ -264,9 +267,11 @@ public static byte[] sha256(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-256 digest
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha256(String data) {
-        return sha256(data.getBytes());
+    public static byte[] sha256(InputStream data) throws IOException {
+        return digest(getSha256Digest(), data);
     }
 
     /**
@@ -278,10 +283,10 @@ public static byte[] sha256(String data) {
      * @param data
      *            Data to digest
      * @return SHA-256 digest
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha256(InputStream data) throws IOException {
-        return digest(getSha256Digest(), data);
+    public static byte[] sha256(String data) {
+        return sha256(data.getBytes());
     }
 
     /**
@@ -293,6 +298,7 @@ public static byte[] sha256(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-256 digest as a hex string
+     * @since 1.4
      */
     public static String sha256Hex(byte[] data) {
         return new String(Hex.encodeHex(sha256(data)));
@@ -307,8 +313,10 @@ public static String sha256Hex(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-256 digest as a hex string
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha256Hex(String data) {
+    public static String sha256Hex(InputStream data) throws IOException {
         return new String(Hex.encodeHex(sha256(data)));
     }
 
@@ -321,9 +329,9 @@ public static String sha256Hex(String data) {
      * @param data
      *            Data to digest
      * @return SHA-256 digest as a hex string
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha256Hex(InputStream data) throws IOException {
+    public static String sha256Hex(String data) {
         return new String(Hex.encodeHex(sha256(data)));
     }
 
@@ -336,9 +344,9 @@ public static String sha256Hex(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-384 digest
+     * @since 1.4
      */
     public static byte[] sha384(byte[] data) {
-        // FIXME: check Sun docs for how to get a sha 384 digest
         return getSha384Digest().digest(data);
     }
 
@@ -351,9 +359,11 @@ public static byte[] sha384(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-384 digest
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha384(String data) {
-        return sha384(data.getBytes());
+    public static byte[] sha384(InputStream data) throws IOException {
+        return digest(getSha384Digest(), data);
     }
 
     /**
@@ -365,10 +375,10 @@ public static byte[] sha384(String data) {
      * @param data
      *            Data to digest
      * @return SHA-384 digest
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha384(InputStream data) throws IOException {
-        return digest(getSha384Digest(), data);
+    public static byte[] sha384(String data) {
+        return sha384(data.getBytes());
     }
 
     /**
@@ -380,6 +390,7 @@ public static byte[] sha384(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-384 digest as a hex string
+     * @since 1.4
      */
     public static String sha384Hex(byte[] data) {
         return new String(Hex.encodeHex(sha384(data)));
@@ -394,8 +405,10 @@ public static String sha384Hex(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-384 digest as a hex string
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha384Hex(String data) {
+    public static String sha384Hex(InputStream data) throws IOException {
         return new String(Hex.encodeHex(sha384(data)));
     }
 
@@ -408,9 +421,9 @@ public static String sha384Hex(String data) {
      * @param data
      *            Data to digest
      * @return SHA-384 digest as a hex string
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha384Hex(InputStream data) throws IOException {
+    public static String sha384Hex(String data) {
         return new String(Hex.encodeHex(sha384(data)));
     }
 
@@ -423,6 +436,7 @@ public static String sha384Hex(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-512 digest
+     * @since 1.4
      */
     public static byte[] sha512(byte[] data) {
         return getSha512Digest().digest(data);
@@ -437,9 +451,11 @@ public static byte[] sha512(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-512 digest
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha512(String data) {
-        return sha512(data.getBytes());
+    public static byte[] sha512(InputStream data) throws IOException {
+        return digest(getSha512Digest(), data);
     }
 
     /**
@@ -451,10 +467,10 @@ public static byte[] sha512(String data) {
      * @param data
      *            Data to digest
      * @return SHA-512 digest
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static byte[] sha512(InputStream data) throws IOException {
-        return digest(getSha512Digest(), data);
+    public static byte[] sha512(String data) {
+        return sha512(data.getBytes());
     }
 
     /**
@@ -466,6 +482,7 @@ public static byte[] sha512(InputStream data) throws IOException {
      * @param data
      *            Data to digest
      * @return SHA-512 digest as a hex string
+     * @since 1.4
      */
     public static String sha512Hex(byte[] data) {
         return new String(Hex.encodeHex(sha512(data)));
@@ -480,8 +497,10 @@ public static String sha512Hex(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-512 digest as a hex string
+     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha512Hex(String data) {
+    public static String sha512Hex(InputStream data) throws IOException {
         return new String(Hex.encodeHex(sha512(data)));
     }
 
@@ -494,9 +513,9 @@ public static String sha512Hex(String data) {
      * @param data
      *            Data to digest
      * @return SHA-512 digest as a hex string
-     * @throws IOException On error reading from the stream
+     * @since 1.4
      */
-    public static String sha512Hex(InputStream data) throws IOException {
+    public static String sha512Hex(String data) {
         return new String(Hex.encodeHex(sha512(data)));
     }
 
@@ -517,8 +536,9 @@ public static String shaHex(byte[] data) {
      * @param data
      *            Data to digest
      * @return SHA-1 digest as a hex string
+     * @throws IOException On error reading from the stream
      */
-    public static String shaHex(String data) {
+    public static String shaHex(InputStream data) throws IOException {
         return new String(Hex.encodeHex(sha(data)));
     }
 
@@ -528,9 +548,8 @@ public static String shaHex(String data) {
      * @param data
      *            Data to digest
      * @return SHA-1 digest as a hex string
-     * @throws IOException On error reading from the stream
      */
-    public static String shaHex(InputStream data) throws IOException {
+    public static String shaHex(String data) {
         return new String(Hex.encodeHex(sha(data)));
     }
 }

src/java/org/apache/commons/codec/language/Caverphone.java

@@ -21,16 +21,16 @@
 import org.apache.commons.codec.StringEncoder;
 
 /**
- * Encodes a string into a caverphone value. 
- *
- * This is an algorithm created the Caversham Project at the University of Otago. 
- * It implements the Caverphone 2.0 algorithm:
- *
- *
+ * Encodes a string into a Caverphone value.
+ * 
+ * This is an algorithm created the Caversham Project at the University of Otago. It implements the Caverphone 2.0
+ * algorithm:
+ * 
  * @author Apache Software Foundation
  * @version $Id$
  * @see <a href="http://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
  * @see <a href="http://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a>
+ * @since 1.4
  */
 public class Caverphone implements StringEncoder {