Javadoc

Author: garydgregory

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

@@ -415,7 +415,7 @@ protected static boolean isWhiteSpace(final byte byteToCheck) {
      * Increases our buffer by the {@link #DEFAULT_BUFFER_RESIZE_FACTOR}.
      *
      * @param context     the context to be used.
-     * @param minCapacity the minimum required capacity
+     * @param minCapacity the minimum required capacity.
      * @return the resized byte[] buffer.
      * @throws OutOfMemoryError if the {@code minCapacity} is negative.
      */

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

@@ -64,7 +64,7 @@ public static String crypt(final byte[] keyBytes) {
      * @param salt
      *            the salt, which is used to select the algorithm, see {@link #crypt(String, String)}
      *            The salt may be null,
-     *            in which case the method delegates to {@link Sha2Crypt#sha512Crypt(byte[])}
+     *            in which case the method delegates to {@link Sha2Crypt#sha512Crypt(byte[])}.
      *
      * @return hash value.
      * @throws IllegalArgumentException
@@ -162,12 +162,12 @@ public static String crypt(final String key) {
      *            plaintext password as entered by the used.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a
-     *            salt is generated for you using {@link SecureRandom}
-     * @return hash value, i.e. encrypted password including the salt string
+     *            salt is generated for you using {@link SecureRandom}.
+     * @return hash value, i.e. encrypted password including the salt string.
      * @throws IllegalArgumentException
      *             if the salt does not match the allowed pattern.
      * @throws IllegalArgumentException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught. *
+     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
      */
     public static String crypt(final String key, final String salt) {
         return crypt(key.getBytes(StandardCharsets.UTF_8), salt);

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

@@ -1414,7 +1414,7 @@ public static String shake256_512Hex(final String data) {
      * Updates the given {@link MessageDigest}.
      *
      * @param messageDigest the {@link MessageDigest} to update.
-     * @param valueToDigest the value to update the {@link MessageDigest} with
+     * @param valueToDigest the value to update the {@link MessageDigest} with.
      * @return the updated {@link MessageDigest}.
      * @since 1.7
      */
@@ -1427,7 +1427,7 @@ public static MessageDigest updateDigest(final MessageDigest messageDigest, fina
      * Updates the given {@link MessageDigest}.
      *
      * @param messageDigest the {@link MessageDigest} to update.
-     * @param valueToDigest the value to update the {@link MessageDigest} with
+     * @param valueToDigest the value to update the {@link MessageDigest} with.
      * @return the updated {@link MessageDigest}.
      * @since 1.11
      */
@@ -1440,7 +1440,7 @@ public static MessageDigest updateDigest(final MessageDigest messageDigest, fina
      * Reads through a File and updates the digest for the data
      *
      * @param digest The MessageDigest to use (for example MD5).
-     * @param data   Data to digest
+     * @param data   Data to digest.
      * @return the digest.
      * @throws IOException On error reading from the stream.
      * @since 1.11
@@ -1455,7 +1455,7 @@ public static MessageDigest updateDigest(final MessageDigest digest, final File
      * TODO Decide if this should be public.
      *
      * @param digest The MessageDigest to use (for example MD5).
-     * @param data   Data to digest
+     * @param data   Data to digest.
      * @return the digest.
      * @throws IOException On error reading from the stream.
      * @since 1.14
@@ -1474,7 +1474,7 @@ private static MessageDigest updateDigest(final MessageDigest digest, final File
      * Reads through an InputStream and updates the digest for the data
      *
      * @param digest      The MessageDigest to use (for example MD5).
-     * @param inputStream Data to digest
+     * @param inputStream Data to digest.
      * @return the digest.
      * @throws IOException On error reading from the stream.
      * @since 1.8
@@ -1493,7 +1493,7 @@ public static MessageDigest updateDigest(final MessageDigest digest, final Input
      * Reads through a Path and updates the digest for the data
      *
      * @param digest  The MessageDigest to use (for example MD5).
-     * @param path    Data to digest
+     * @param path    Data to digest.
      * @param options options How to open the file.
      * @return the digest.
      * @throws IOException On error reading from the stream.
@@ -1509,7 +1509,7 @@ public static MessageDigest updateDigest(final MessageDigest digest, final Path
      * Reads through a RandomAccessFile and updates the digest for the data using non-blocking-io (NIO)
      *
      * @param digest The MessageDigest to use (for example MD5).
-     * @param data   Data to digest
+     * @param data   Data to digest.
      * @return the digest.
      * @throws IOException On error reading from the stream.
      * @since 1.14
@@ -1526,7 +1526,7 @@ public static MessageDigest updateDigest(final MessageDigest digest, final Rando
      * {@link String#getBytes(java.nio.charset.Charset)} and pass that to the {@link DigestUtils#updateDigest(MessageDigest, byte[])} method
      *
      * @param messageDigest the {@link MessageDigest} to update.
-     * @param valueToDigest the value to update the {@link MessageDigest} with; converted to bytes using {@link StringUtils#getBytesUtf8(String)}
+     * @param valueToDigest the value to update the {@link MessageDigest} with; converted to bytes using {@link StringUtils#getBytesUtf8(String)}.
      * @return the updated {@link MessageDigest}.
      * @since 1.7
      */
@@ -1623,7 +1623,7 @@ public byte[] digest(final InputStream data) throws IOException {
      * Reads through a File and returns the digest for the data
      *
      * @param data    Data to digest.
-     * @param options options How to open the file
+     * @param options options How to open the file.
      * @return the digest.
      * @throws IOException On error reading from the stream.
      * @since 1.14
@@ -1693,7 +1693,7 @@ public String digestAsHex(final InputStream data) throws IOException {
      * Reads through a File and returns the digest for the data
      *
      * @param data    Data to digest.
-     * @param options options How to open the file
+     * @param options options How to open the file.
      * @return the digest as a hexadecimal string.
      * @throws IOException On error reading from the stream.
      * @since 1.11

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

@@ -304,7 +304,7 @@ public static byte[] hmacSha1(final byte[] key, final byte[] valueToDigest) {
      * @param key           The key for the keyed digest (must not be null).
      * @param valueToDigest The value (data) which should to digest
      *                      <p>
-     *                      The InputStream must not be null and will not be closed
+     *                      The InputStream must not be null and will not be closed.
      *                      </p>
      * @return HmacSHA1 MAC for the given key and value.
      * @throws IOException              If an I/O error occurs.

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

@@ -73,7 +73,7 @@ public class Md5Crypt {
      *
      * @param keyBytes plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @return the hash value.
-     * @throws IllegalArgumentException when a {@link java.security.NoSuchAlgorithmException} is caught. *
+     * @throws IllegalArgumentException when a {@link java.security.NoSuchAlgorithmException} is caught.
      * @see #apr1Crypt(byte[], String)
      */
     public static String apr1Crypt(final byte[] keyBytes) {
@@ -90,7 +90,7 @@ public static String apr1Crypt(final byte[] keyBytes) {
      * @param random the instance of {@link Random} to use for generating the salt.
      *              Consider using {@link SecureRandom} for more secure salts.
      * @return the hash value.
-     * @throws IllegalArgumentException when a {@link java.security.NoSuchAlgorithmException} is caught. *
+     * @throws IllegalArgumentException when a {@link java.security.NoSuchAlgorithmException} is caught.
      * @see #apr1Crypt(byte[], String)
      * @since 1.12
      */
@@ -108,7 +108,7 @@ public static String apr1Crypt(final byte[] keyBytes, final Random random) {
      *            plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            An APR1 salt. The salt may be null, in which case a salt is generated for you using
-     *            {@link SecureRandom}
+     *            {@link SecureRandom}.
      * @return the hash value.
      * @throws IllegalArgumentException
      *             if the salt does not match the allowed pattern.

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

@@ -26,7 +26,7 @@ final class MurmurHash {
      * Gets the little-endian int from 4 bytes starting at the specified index.
      *
      * @param data  The data.
-     * @param index The index
+     * @param index The index.
      * @return The little-endian int.
      */
     static int getLittleEndianInt(final byte[] data, final int index) {
@@ -42,7 +42,7 @@ static int getLittleEndianInt(final byte[] data, final int index) {
      * Gets the little-endian long from 8 bytes starting at the specified index.
      *
      * @param data  The data.
-     * @param index The index
+     * @param index The index.
      * @return The little-endian long.
      */
     static long getLittleEndianLong(final byte[] data, final int index) {

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

@@ -68,7 +68,7 @@ public final class MurmurHash2 {
      * </pre>
      *
      * @param data The input byte array.
-     * @param length The length of the array
+     * @param length The length of the array.
      * @return The 32-bit hash.
      * @see #hash32(byte[], int, int)
      */
@@ -80,7 +80,7 @@ public static int hash32(final byte[] data, final int length) {
      * Generates a 32-bit hash from byte array with the given length and seed.
      *
      * @param data The input byte array.
-     * @param length The length of the array
+     * @param length The length of the array.
      * @param seed The initial seed value.
      * @return The 32-bit hash.
      */
@@ -155,7 +155,7 @@ public static int hash32(final String text) {
      * </pre>
      *
      * @param text The input string.
-     * @param from The starting index
+     * @param from The starting index.
      * @param length The length of the substring.
      * @return The 32-bit hash.
      * @see #hash32(byte[], int, int)
@@ -186,7 +186,7 @@ public static long hash64(final byte[] data, final int length) {
      * Generates a 64-bit hash from byte array of the given length and seed.
      *
      * @param data The input byte array.
-     * @param length The length of the array
+     * @param length The length of the array.
      * @param seed The initial seed value.
      * @return The 64-bit hash of the given array.
      */
@@ -272,7 +272,7 @@ public static long hash64(final String text) {
      * </pre>
      *
      * @param text The input string.
-     * @param from The starting index
+     * @param from The starting index.
      * @param length The length of the substring.
      * @return The 64-bit hash.
      * @see #hash64(byte[], int, int)

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

@@ -144,7 +144,7 @@ public static String sha256Crypt(final byte[] keyBytes, String salt, final Rando
      * @param salt       real salt value without prefix or {@code "rounds="}; may not be null.
      * @param saltPrefix either {@code $5$} or {@code $6$}.
      * @param blocksize  a value that differs between {@code $5${@code  and {@code $6$}.
-     * @param algorithm  {@link MessageDigest} algorithm identifier string
+     * @param algorithm  {@link MessageDigest} algorithm identifier string.
      * @return The Complete hash value including prefix and salt.
      * @throws IllegalArgumentException Thrown if the given salt is {@code null} or does not match the allowed pattern.
      * @throws IllegalArgumentException Thrown if a {@link NoSuchAlgorithmException} is caught.

src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java

@@ -142,7 +142,7 @@ public boolean isConcat() {
      *
      * @param concat
      *            true if multiple encodings are to be combined with a '|', false if just the first one is
-     *            to be considered
+     *            to be considered.
      */
     public void setConcat(final boolean concat) {
         this.engine = new PhoneticEngine(this.engine.getNameType(),

src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java

@@ -248,7 +248,7 @@ public boolean isFound() {
      * Joins some strings with an internal separator.
      *
      * @param strings   Strings to join.
-     * @param sep       String to separate them with
+     * @param sep       String to separate them with.
      * @return a single String consisting of each element of {@code strings} interleaved by {@code sep}.
      */
     private static String join(final List<String> strings, final String sep) {
@@ -271,7 +271,7 @@ private static String join(final List<String> strings, final String sep) {
      * @param nameType
      *            the type of names it will use.
      * @param ruleType
-     *            the type of rules it will apply
+     *            the type of rules it will apply.
      * @param concatenate
      *            if it will concatenate multiple encodings.
      */
@@ -285,11 +285,11 @@ public PhoneticEngine(final NameType nameType, final RuleType ruleType, final bo
      * @param nameType
      *            the type of names it will use.
      * @param ruleType
-     *            the type of rules it will apply
+     *            the type of rules it will apply.
      * @param concatenate
      *            if it will concatenate multiple encodings.
      * @param maxPhonemes
-     *            the maximum number of phonemes that will be handled
+     *            the maximum number of phonemes that will be handled.
      * @since 1.7
      */
     public PhoneticEngine(final NameType nameType, final RuleType ruleType, final boolean concatenate, final int maxPhonemes) {
@@ -308,7 +308,7 @@ public PhoneticEngine(final NameType nameType, final RuleType ruleType, final bo
      * language-independent representation.
      *
      * @param phonemeBuilder the current phonemes.
-     * @param finalRules the final rules to apply
+     * @param finalRules the final rules to apply.
      * @return the resulting phonemes.
      */
     private PhonemeBuilder applyFinalRules(final PhonemeBuilder phonemeBuilder,
@@ -372,9 +372,9 @@ public String encode(final String input) {
      * @param input
      *            String to phoneticise; a String with dashes or spaces separating each word.
      * @param languageSet
-     *            set of possible origin languages
+     *            set of possible origin languages.
      * @return a phonetic representation of the input; a String containing '-'-separated phonetic representations of the
-     *         input
+     *         input.
      */
     public String encode(String input, final Languages.LanguageSet languageSet) {
         final Map<String, List<Rule>> rules = Rule.getInstanceMap(this.nameType, RuleType.RULES, languageSet);