Javadoc

Author: garydgregory

src/main/java/org/apache/commons/text/AlphabetConverter.java

@@ -82,8 +82,8 @@ public final class AlphabetConverter {
     /**
      * Creates new String that contains just the given code point.
      *
-     * @param i code point
-     * @return a new string with the new code point
+     * @param i code point.
+     * @return a new string with the new code point.
      * @see "http://www.oracle.com/us/technologies/java/supplementary-142654.html"
      */
     private static String codePointToString(final int i) {
@@ -96,8 +96,8 @@ private static String codePointToString(final int i) {
     /**
      * Converts characters to integers.
      *
-     * @param chars array of characters
-     * @return an equivalent array of integers
+     * @param chars array of characters.
+     * @return an equivalent array of integers.
      */
     private static Integer[] convertCharsToIntegers(final Character[] chars) {
         if (ArrayUtils.isEmpty(chars)) {
@@ -109,22 +109,19 @@ private static Integer[] convertCharsToIntegers(final Character[] chars) {
     }
 
     /**
-     * Creates an alphabet converter, for converting from the original alphabet,
-     * to the encoded alphabet, while leaving
-     * the characters in <em>doNotEncode</em> as they are (if possible).
+     * Creates an alphabet converter, for converting from the original alphabet, to the encoded alphabet, while leaving the characters in <em>doNotEncode</em>
+     * as they are (if possible).
      *
-     * <p>Duplicate letters in either original or encoding will be ignored.</p>
+     * <p>
+     * Duplicate letters in either original or encoding will be ignored.
+     * </p>
      *
-     * @param original an array of ints representing the original alphabet in
-     *                 code points
-     * @param encoding an array of ints representing the alphabet to be used for
-     *                 encoding, in code points
-     * @param doNotEncode an array of ints representing the chars to be encoded
-     *                    using the original alphabet - every char
-     *                    here must appear in both the previous params
-     * @return The AlphabetConverter
-     * @throws IllegalArgumentException if an AlphabetConverter cannot be
-     *                                   constructed
+     * @param original    an array of ints representing the original alphabet in code points.
+     * @param encoding    an array of ints representing the alphabet to be used for encoding, in code points.
+     * @param doNotEncode an array of ints representing the chars to be encoded using the original alphabet - every char here must appear in both the previous
+     *                    params.
+     * @return The AlphabetConverter.
+     * @throws IllegalArgumentException if an AlphabetConverter cannot be constructed.
      */
     public static AlphabetConverter createConverter(
             final Integer[] original,
@@ -251,8 +248,8 @@ public static AlphabetConverter createConverterFromChars(
     /**
      * Creates a new converter from a map.
      *
-     * @param originalToEncoded a map returned from getOriginalToEncoded()
-     * @return The reconstructed AlphabetConverter
+     * @param originalToEncoded a map returned from getOriginalToEncoded().
+     * @return The reconstructed AlphabetConverter.
      * @see AlphabetConverter#getOriginalToEncoded()
      */
     public static AlphabetConverter createConverterFromMap(final Map<Integer, String> originalToEncoded) {
@@ -290,9 +287,9 @@ public static AlphabetConverter createConverterFromMap(final Map<Integer, String
     /**
      * Hidden constructor for alphabet converter. Used by static helper methods.
      *
-     * @param originalToEncoded original string to be encoded
-     * @param encodedToOriginal encoding alphabet
-     * @param encodedLetterLength length of the encoded letter
+     * @param originalToEncoded original string to be encoded.
+     * @param encodedToOriginal encoding alphabet.
+     * @param encodedLetterLength length of the encoded letter.
      */
     private AlphabetConverter(final Map<Integer, String> originalToEncoded,
                               final Map<String, String> encodedToOriginal,
@@ -306,11 +303,11 @@ private AlphabetConverter(final Map<Integer, String> originalToEncoded,
     /**
      * Recursive method used when creating encoder/decoder.
      *
-     * @param level at which point it should add a single encoding
-     * @param currentEncoding current encoding
-     * @param encoding letters encoding
-     * @param originals original values
-     * @param doNotEncodeMap map of values that should not be encoded
+     * @param level at which point it should add a single encoding.
+     * @param currentEncoding current encoding.
+     * @param encoding letters encoding.
+     * @param originals original values.
+     * @param doNotEncodeMap map of values that should not be encoded.
      */
     private void addSingleEncoding(final int level,
                                    final String currentEncoding,
@@ -363,11 +360,9 @@ private void addSingleEncoding(final int level,
     /**
      * Decodes a given string.
      *
-     * @param encoded a string that has been encoded using this
-     *                AlphabetConverter
-     * @return The decoded string, {@code null} if the given string is null
-     * @throws UnsupportedEncodingException if unexpected characters that
-     *                                      cannot be handled are encountered
+     * @param encoded a string that has been encoded using this AlphabetConverter.
+     * @return The decoded string, {@code null} if the given string is null.
+     * @throws UnsupportedEncodingException if unexpected characters that cannot be handled are encountered.
      */
     public String decode(final String encoded)
             throws UnsupportedEncodingException {
@@ -409,10 +404,9 @@ public String decode(final String encoded)
     /**
      * Encodes a given string.
      *
-     * @param original the string to be encoded
-     * @return The encoded string, {@code null} if the given string is null
-     * @throws UnsupportedEncodingException if chars that are not supported are
-     *                                      encountered
+     * @param original the string to be encoded.
+     * @return The encoded string, {@code null} if the given string is null.
+     * @throws UnsupportedEncodingException if chars that are not supported are encountered.
      */
     public String encode(final String original)
             throws UnsupportedEncodingException {
@@ -462,22 +456,18 @@ public boolean equals(final Object obj) {
     }
 
     /**
-     * Gets the length of characters in the encoded alphabet that are necessary
-     * for each character in the original
-     * alphabet.
+     * Gets the length of characters in the encoded alphabet that are necessary for each character in the original alphabet.
      *
-     * @return The length of the encoded char
+     * @return The length of the encoded char.
      */
     public int getEncodedCharLength() {
         return encodedLetterLength;
     }
 
     /**
-     * Gets the mapping from integer code point of source language to encoded
-     * string. Use to reconstruct converter from
-     * serialized map.
+     * Gets the mapping from integer code point of source language to encoded string. Use to reconstruct converter from serialized map.
      *
-     * @return The original map
+     * @return The original map.
      */
     public Map<Integer, String> getOriginalToEncoded() {
         return Collections.unmodifiableMap(originalToEncoded);

src/main/java/org/apache/commons/text/CharacterPredicate.java

@@ -14,11 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.apache.commons.text;
 
 /**
- * A predicate for selecting code points. Implementations of this interface must
- * be thread safe.
+ * A predicate for selecting code points. Implementations of this interface must be thread safe.
  *
  * @since 1.0
  */
@@ -27,10 +27,8 @@ public interface CharacterPredicate {
     /**
      * Tests the code point with this predicate.
      *
-     * @param codePoint
-     *            the code point to test
-     * @return {@code true} if the code point matches the predicate,
-     *         {@code false} otherwise
+     * @param codePoint the code point to test.
+     * @return {@code true} if the code point matches the predicate, {@code false} otherwise.
      * @since 1.0
      */
     boolean test(int codePoint);

src/main/java/org/apache/commons/text/CompositeFormat.java

@@ -47,8 +47,8 @@ public class CompositeFormat extends Format {
      * Constructs a format that points its parseObject method to one implementation
      * and its format method to another.
      *
-     * @param parser implementation
-     * @param formatter implementation
+     * @param parser implementation.
+     * @param formatter implementation.
      */
     public CompositeFormat(final Format parser, final Format formatter) {
         this.parser = parser;
@@ -58,10 +58,10 @@ public CompositeFormat(final Format parser, final Format formatter) {
     /**
      * Formats the input.
      *
-     * @param obj the object to format
-     * @param toAppendTo the {@link StringBuffer} to append to
-     * @param pos the FieldPosition to use (or ignore).
-     * @return {@code toAppendTo}
+     * @param obj        the object to format.
+     * @param toAppendTo the {@link StringBuffer} to append to.
+     * @param pos        the FieldPosition to use (or ignore).
+     * @return {@code toAppendTo}.
      * @see Format#format(Object, StringBuffer, FieldPosition)
      */
     @Override // Therefore has to use StringBuffer
@@ -91,11 +91,9 @@ public Format getParser() {
     /**
      * Parses the input.
      *
-     * @param source the String source
-     * @param pos the ParsePosition containing the position to parse from, will
-     *            be updated according to parsing success (index) or failure
-     *            (error index)
-     * @return The parsed Object
+     * @param source the String source.
+     * @param pos    the ParsePosition containing the position to parse from, will be updated according to parsing success (index) or failure (error index).
+     * @return The parsed Object.
      * @see Format#parseObject(String, ParsePosition)
      */
     @Override
@@ -106,9 +104,9 @@ public Object parseObject(final String source, final ParsePosition pos) {
     /**
      * Parses and then reformats a String.
      *
-     * @param input String to reformat
-     * @return A reformatted String
-     * @throws ParseException thrown by parseObject(String) call
+     * @param input String to reformat.
+     * @return A reformatted String.
+     * @throws ParseException thrown by parseObject(String) call.
      */
     public String reformat(final String input) throws ParseException {
         return format(parseObject(input));