Javadoc

Author: garydgregory

src/main/java/org/apache/commons/codec/net/PercentCodec.java

@@ -45,12 +45,12 @@ public class PercentCodec implements BinaryEncoder, BinaryDecoder {
     private static final byte ESCAPE_CHAR = '%';
 
     /**
-     * The bit set used to store the character that should be always encoded
+     * The bit set used to store the character that should be always encoded.
      */
     private final BitSet alwaysEncodeChars = new BitSet();
 
     /**
-     * The flag defining if the space character should be encoded as '+'
+     * The flag defining if the space character should be encoded as '+'.
      */
     private final boolean plusForSpace;
 
@@ -74,8 +74,8 @@ public PercentCodec() {
      * always be encoded. The rest US-ASCII characters will not be encoded, except for character '%' that
      * is used as escape character for Percent-Encoding.
      *
-     * @param alwaysEncodeChars the unsafe characters that should always be encoded
-     * @param plusForSpace      the flag defining if the space character should be encoded as '+'
+     * @param alwaysEncodeChars the unsafe characters that should always be encoded.
+     * @param plusForSpace      the flag defining if the space character should be encoded as '+'.
      */
     public PercentCodec(final byte[] alwaysEncodeChars, final boolean plusForSpace) {
         this.plusForSpace = plusForSpace;
@@ -127,9 +127,9 @@ public byte[] decode(final byte[] bytes) throws DecoderException {
     /**
      * Decodes a byte[] Object, whose bytes are encoded with Percent-Encoding.
      *
-     * @param obj the object to decode
-     * @return the decoding result byte[] as Object
-     * @throws DecoderException if the object is not a byte array
+     * @param obj the object to decode.
+     * @return the decoding result byte[] as Object.
+     * @throws DecoderException if the object is not a byte array.
      */
     @Override
     public Object decode(final Object obj) throws DecoderException {
@@ -184,9 +184,9 @@ public byte[] encode(final byte[] bytes) throws EncoderException {
     /**
      * Encodes an object into using the Percent-Encoding. Only byte[] objects are accepted.
      *
-     * @param obj the object to encode
-     * @return the encoding result byte[] as Object
-     * @throws EncoderException if the object is not a byte array
+     * @param obj the object to encode.
+     * @return the encoding result byte[] as Object.
+     * @throws EncoderException if the object is not a byte array.
      */
     @Override
     public Object encode(final Object obj) throws EncoderException {
@@ -225,7 +225,7 @@ private boolean inAlwaysEncodeCharsRange(final byte c) {
      * Inserts a single character into a BitSet and maintains the min and max of the characters of the
      * {@code BitSet alwaysEncodeChars} in order to avoid look-ups when a byte is out of this range.
      *
-     * @param b the byte that is candidate for min and max limit
+     * @param b the byte that is candidate for min and max limit.
      */
     private void insertAlwaysEncodeChar(final byte b) {
         if (b < 0) {
@@ -243,7 +243,7 @@ private void insertAlwaysEncodeChar(final byte b) {
     /**
      * Inserts the byte array into a BitSet for faster lookup.
      *
-     * @param alwaysEncodeCharsArray
+     * @param alwaysEncodeCharsArray the byte array into a BitSet for faster lookup.
      */
     private void insertAlwaysEncodeChars(final byte[] alwaysEncodeCharsArray) {
         if (alwaysEncodeCharsArray != null) {