Javadoc 8.

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

Author: garydgregory

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -175,7 +175,7 @@ public Base32(final byte pad) {
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
-     * @param useHex if <code>true</code> then use Base32 Hex alphabet
+     * @param useHex if {@code true} then use Base32 Hex alphabet
      */
     public Base32(final boolean useHex) {
         this(0, null, useHex, PAD_DEFAULT);
@@ -186,7 +186,7 @@ public Base32(final boolean useHex) {
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
-     * @param useHex if <code>true</code> then use Base32 Hex alphabet
+     * @param useHex if {@code true} then use Base32 Hex alphabet
      * @param pad byte used as padding byte.
      */
     public Base32(final boolean useHex, final byte pad) {
@@ -246,7 +246,7 @@ public Base32(final int lineLength, final byte[] lineSeparator) {
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @param useHex
-     *            if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet
+     *            if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
      * @throws IllegalArgumentException
      *             The provided lineSeparator included some Base32 characters. That's not going to work! Or the
      *             lineLength &gt; 0 and lineSeparator is null.
@@ -271,7 +271,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @param useHex
-     *            if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet
+     *            if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
      * @param pad byte used as padding byte.
      * @throws IllegalArgumentException
      *             The provided lineSeparator included some Base32 characters. That's not going to work! Or the
@@ -526,11 +526,11 @@ void encode(final byte[] in, int inPos, final int inAvail, final Context context
     }
 
     /**
-     * Returns whether or not the <code>octet</code> is in the Base32 alphabet.
+     * Returns whether or not the {@code octet} is in the Base32 alphabet.
      *
      * @param octet
      *            The value to test
-     * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
+     * @return {@code true} if the value is defined in the the Base32 alphabet {@code false} otherwise.
      */
     @Override
     public boolean isInAlphabet(final byte octet) {

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

@@ -0,0 +1,94 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.codec.digest;
+
+/**
+ * Standard {@link HmacSHA512} algorithm names from the <cite>Java Cryptography Architecture Standard Algorithm Name
+ * Documentation</cite>.
+ *
+ * <p>
+ * <strong>Note: Not all JCE implementations supports all algorithms in this enum.</strong>
+ * </p>
+ *
+ * @see <a href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html">Java Cryptography
+ *      Architecture Standard Algorithm Name Documentation</a>
+ * @since 1.10
+ * @version $Id$
+ */
+public enum HmacAlgorithms {
+
+    /**
+     * The HmacMD5 Message Authentication Code (MAC) algorithm specified in RFC 2104 and RFC 1321.
+     * <p>
+     * Every implementation of the Java platform is required to support this standard Mac algorithm.
+     * </p>
+     */
+    HMAC_MD5("HmacMD5"),
+
+    /**
+     * The HmacSHA1 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
+     * <p>
+     * Every implementation of the Java platform is required to support this standard Mac algorithm.
+     * </p>
+     */
+    HMAC_SHA_1("HmacSHA1"),
+
+    /**
+     * The HmacSHA256 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
+     * <p>
+     * Every implementation of the Java platform is required to support this standard Mac algorithm.
+     * </p>
+     */
+    HMAC_SHA_256("HmacSHA256"),
+
+    /**
+     * The HmacSHA384 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
+     * <p>
+     * Every implementation of the Java platform is <em>not</em> required to support this Mac algorithm.
+     * </p>
+     */
+    HMAC_SHA_384("HmacSHA384"),
+
+    /**
+     * The HmacSHA512 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
+     * <p>
+     * Every implementation of the Java platform is <em>not</em> required to support this Mac algorithm.
+     * </p>
+     */
+    HMAC_SHA_512("HmacSHA512");
+
+    private final String algorithm;
+
+    private HmacAlgorithms(final String algorithm) {
+        this.algorithm = algorithm;
+    }
+
+    /**
+     * The algorithm name
+     *
+     * @see <a
+     *      href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/SunProviders.html#SunJCEProvider">Java
+     *      Cryptography Architecture Sun Providers Documentation</a>
+     * @return The algorithm name ("HmacSHA512" for example)
+     */
+    @Override
+    public String toString() {
+        return algorithm;
+    }
+
+}