[CODEC-211] Create enum MessageDigestAlgorithm and deprecate class MessageDigestAlgorithms. Rename MessageDigestAlgorithm.getAlgorithm() to getName().

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

Author: garydgregory

src/main/java/org/apache/commons/codec/digest/Digest.java

@@ -87,7 +87,7 @@ private void run(MessageDigestAlgorithm[] digestAlgorithms) throws IOException {
         for (int i = 0; i < digestAlgorithms.length; i++) {
             final MessageDigestAlgorithm messageDigestAlgorithm = digestAlgorithms[i];
             if (messageDigestAlgorithm.isAvailable()) {
-                run(messageDigestAlgorithm.getAlgorithm() + " ", messageDigestAlgorithm);
+                run(messageDigestAlgorithm.getName() + " ", messageDigestAlgorithm);
             }
         }
     }

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

@@ -157,7 +157,7 @@ public static MessageDigest getDigest(final String algorithm, MessageDigest defa
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because MD2 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#MD2
+     * @see MessageDigestAlgorithm#MD2
      * @since 1.7
      */
     public static MessageDigest getMd2Digest() {
@@ -171,7 +171,7 @@ public static MessageDigest getMd2Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because MD5 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#MD5
+     * @see MessageDigestAlgorithm#MD5
      */
     public static MessageDigest getMd5Digest() {
         return MessageDigestAlgorithm.MD5.getMessageDigest();
@@ -184,7 +184,7 @@ public static MessageDigest getMd5Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-1 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#SHA_1
+     * @see MessageDigestAlgorithm#SHA_1
      * @since 1.7
      */
     public static MessageDigest getSha1Digest() {
@@ -201,7 +201,7 @@ public static MessageDigest getSha1Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught on Java 7 and older, SHA-224 is a built-in
      *             algorithm on Java 8
-     * @see MessageDigestAlgorithms#SHA_224
+     * @see MessageDigestAlgorithm#SHA_224
      */
     public static MessageDigest getSha224Digest() {
         return MessageDigestAlgorithm.SHA_224.getMessageDigest();
@@ -217,7 +217,7 @@ public static MessageDigest getSha224Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-256 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#SHA_256
+     * @see MessageDigestAlgorithm#SHA_256
      */
     public static MessageDigest getSha256Digest() {
         return MessageDigestAlgorithm.SHA_256.getMessageDigest();
@@ -233,7 +233,7 @@ public static MessageDigest getSha256Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-384 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#SHA_384
+     * @see MessageDigestAlgorithm#SHA_384
      */
     public static MessageDigest getSha384Digest() {
         return MessageDigestAlgorithm.SHA_384.getMessageDigest();
@@ -249,7 +249,7 @@ public static MessageDigest getSha384Digest() {
      * @throws IllegalArgumentException
      *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-512 is a
      *             built-in algorithm
-     * @see MessageDigestAlgorithms#SHA_512
+     * @see MessageDigestAlgorithm#SHA_512
      */
     public static MessageDigest getSha512Digest() {
         return MessageDigestAlgorithm.SHA_512.getMessageDigest();

src/main/java/org/apache/commons/codec/digest/MessageDigestAlgorithm.java

@@ -171,7 +171,7 @@ public byte[] digest(InputStream data) throws IOException {
      *
      * @return the algorithm name.
      */
-    public String getAlgorithm() {
+    public String getName() {
         return algorithm;
     }
 

src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java

@@ -102,7 +102,7 @@ public static String sha256Crypt(final byte[] keyBytes, String salt) {
         if (salt == null) {
             salt = SHA256_PREFIX + B64.getRandomSalt(8);
         }
-        return sha2Crypt(keyBytes, salt, SHA256_PREFIX, SHA256_BLOCKSIZE, MessageDigestAlgorithm.SHA_256.getAlgorithm());
+        return sha2Crypt(keyBytes, salt, SHA256_PREFIX, SHA256_BLOCKSIZE, MessageDigestAlgorithm.SHA_256.getName());
     }
 
     /**
@@ -540,6 +540,6 @@ public static String sha512Crypt(final byte[] keyBytes, String salt) {
         if (salt == null) {
             salt = SHA512_PREFIX + B64.getRandomSalt(8);
         }
-        return sha2Crypt(keyBytes, salt, SHA512_PREFIX, SHA512_BLOCKSIZE, MessageDigestAlgorithm.SHA_512.getAlgorithm());
+        return sha2Crypt(keyBytes, salt, SHA512_PREFIX, SHA512_BLOCKSIZE, MessageDigestAlgorithm.SHA_512.getName());
     }
 }

src/test/java/org/apache/commons/codec/digest/MessageDigestAlgorithmTest.java

@@ -79,7 +79,7 @@ public void tearDown() throws Exception {
 
     @Test
     public void testAlgorithm() throws IOException, NoSuchAlgorithmException {
-        final String algorithm = messageDigestAlgorithm.getAlgorithm();
+        final String algorithm = messageDigestAlgorithm.getName();
         Assert.assertNotNull(algorithm);
         Assert.assertFalse(algorithm.isEmpty());
         Assume.assumeTrue(messageDigestAlgorithm.isAvailable());
@@ -122,7 +122,7 @@ public void testDigestInputStream() throws IOException {
     public void testGetMessageDigest() throws IOException, NoSuchAlgorithmException {
         Assume.assumeTrue(messageDigestAlgorithm.isAvailable());
         final MessageDigest messageDigest = messageDigestAlgorithm.getMessageDigest();
-        Assert.assertEquals(messageDigestAlgorithm.getAlgorithm(), messageDigest.getAlgorithm());
+        Assert.assertEquals(messageDigestAlgorithm.getName(), messageDigest.getAlgorithm());
     }
 
 }