Renamed the package private interface StringEncodings to CharacterEncodingNames and added more Javadocs.

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

Author: garydgregory

src/java/org/apache/commons/codec/net/BCodec.java

@@ -40,13 +40,13 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: BCodec.java,v 1.5 2004/04/13 22:46:37 ggregory Exp $
+ * @version $Id: BCodec.java,v 1.6 2004/07/26 22:55:40 ggregory Exp $
  */
 public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
      * The default charset used for string decoding and encoding.
      */
-    private String charset = StringEncodings.UTF8;
+    private String charset = CharacterEncodingNames.UTF8;
 
     /**
      * Default constructor.

…e/commons/codec/net/StringEncodings.java …ns/codec/net/CharacterEncodingNames.javasrc/java/org/apache/commons/codec/net/StringEncodings.java renamed to src/java/org/apache/commons/codec/net/CharacterEncodingNames.java src/java/org/apache/commons/codec/net/StringEncodings.java renamed to src/java/org/apache/commons/codec/net/CharacterEncodingNames.java

@@ -12,18 +12,32 @@
  * 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.net;
 
 /**
- * String encodings used in this package.
+ * Character encoding names required of every implementation of the Java platform.
+ * 
+ * According to the Java documentation <a
+ * href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding names
+ * </a>:
+ * <p>
+ * <cite>Every implementation of the Java platform is required to support the following character encodings. Consult the
+ * release documentation for your implementation to see if any other encodings are supported. </cite>
+ * </p>
+ * 
+ * This interface is private to the package since it perhaps would best belong in the [lang] project with other required
+ * encoding names. As is, this interface only defines the names used in this package. Even if a similar interface is
+ * defined in [lang], it is not forseen that [codec] would be made to depend on [lang].
  * 
+ * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding
+ *          names </a>
  * @author Apache Software Foundation
- * @since 1.3
- * @version $Id: StringEncodings.java,v 1.2 2004/04/09 22:21:07 ggregory Exp $
+ * @since 1.4
+ * @version $Id: CharacterEncodingNames.java,v 1.1 2004/07/26 22:55:40 ggregory Exp $
  */
-interface StringEncodings {
+interface CharacterEncodingNames {
     /**
      * <p>
      * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
@@ -33,7 +47,7 @@ interface StringEncodings {
      * </p>
      * 
      * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
-     *          encoding names</a>
+     *          encoding names </a>
      */
     String US_ASCII = "US-ASCII";
 
@@ -46,7 +60,7 @@ interface StringEncodings {
      * </p>
      * 
      * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
-     *          encoding names</a>
+     *          encoding names </a>
      */
     String UTF8 = "UTF-8";
 }

src/java/org/apache/commons/codec/net/QCodec.java

@@ -42,13 +42,13 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: QCodec.java,v 1.6 2004/05/24 00:24:32 ggregory Exp $
+ * @version $Id: QCodec.java,v 1.7 2004/07/26 22:55:40 ggregory Exp $
  */
 public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
      * The default charset used for string decoding and encoding.
      */
-    private String charset = StringEncodings.UTF8;
+    private String charset = CharacterEncodingNames.UTF8;
 
     /**
      * BitSet of printable characters as defined in RFC 1522.

src/java/org/apache/commons/codec/net/QuotedPrintableCodec.java

@@ -54,13 +54,13 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: QuotedPrintableCodec.java,v 1.7 2004/04/09 22:21:07 ggregory Exp $
+ * @version $Id: QuotedPrintableCodec.java,v 1.8 2004/07/26 22:55:40 ggregory Exp $
  */
 public class QuotedPrintableCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
     /**
      * The default charset used for string decoding and encoding.
      */
-    private String charset = StringEncodings.UTF8;
+    private String charset = CharacterEncodingNames.UTF8;
 
     /**
      * BitSet of printable characters as defined in RFC 1521.
@@ -276,7 +276,7 @@ public String decode(String pString, String charset) throws DecoderException, Un
         if (pString == null) {
             return null;
         }
-        return new String(decode(pString.getBytes(StringEncodings.US_ASCII)), charset);
+        return new String(decode(pString.getBytes(CharacterEncodingNames.US_ASCII)), charset);
     }
 
     /**
@@ -382,6 +382,6 @@ public String encode(String pString, String charset) throws UnsupportedEncodingE
         if (pString == null) {
             return null;
         }
-        return new String(encode(pString.getBytes(charset)), StringEncodings.US_ASCII);
+        return new String(encode(pString.getBytes(charset)), CharacterEncodingNames.US_ASCII);
     }
 }

src/java/org/apache/commons/codec/net/RFC1522Codec.java

@@ -40,7 +40,7 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: RFC1522Codec.java,v 1.2 2004/04/09 22:21:43 ggregory Exp $
+ * @version $Id: RFC1522Codec.java,v 1.3 2004/07/26 22:55:40 ggregory Exp $
  */
 abstract class RFC1522Codec {
 
@@ -75,7 +75,7 @@ protected String encodeText(final String text, final String charset)
         buffer.append(getEncoding()); 
         buffer.append('?');
         byte [] rawdata = doEncoding(text.getBytes(charset)); 
-        buffer.append(new String(rawdata, StringEncodings.US_ASCII));
+        buffer.append(new String(rawdata, CharacterEncodingNames.US_ASCII));
         buffer.append("?="); 
         return buffer.toString();
     }
@@ -123,7 +123,7 @@ protected String decodeText(final String text)
         }
         from = to + 1;
         to = text.indexOf("?", from);
-        byte[] data = text.substring(from, to).getBytes(StringEncodings.US_ASCII);
+        byte[] data = text.substring(from, to).getBytes(CharacterEncodingNames.US_ASCII);
         data = doDecoding(data); 
         return new String(data, charset);
     }

src/java/org/apache/commons/codec/net/URLCodec.java

@@ -45,14 +45,14 @@
  * 
  * @author Apache Software Foundation
  * @since 1.2
- * @version $Id: URLCodec.java,v 1.19 2004/03/29 07:59:00 ggregory Exp $
+ * @version $Id: URLCodec.java,v 1.20 2004/07/26 22:55:39 ggregory Exp $
  */
 public class URLCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
 
     /**
      * The default charset used for string decoding and encoding.
      */
-    protected String charset = StringEncodings.UTF8;
+    protected String charset = CharacterEncodingNames.UTF8;
 
     protected static byte ESCAPE_CHAR = '%';
     /**
@@ -223,7 +223,7 @@ public String encode(String pString, String charset)
         if (pString == null) {
             return null;
         }
-        return new String(encode(pString.getBytes(charset)), StringEncodings.US_ASCII);
+        return new String(encode(pString.getBytes(charset)), CharacterEncodingNames.US_ASCII);
     }
 
 
@@ -267,7 +267,7 @@ public String decode(String pString, String charset)
         if (pString == null) {
             return null;
         }
-        return new String(decode(pString.getBytes(StringEncodings.US_ASCII)), charset);
+        return new String(decode(pString.getBytes(CharacterEncodingNames.US_ASCII)), charset);
     }