Bugzilla Bug 30864

[codec] Document how to print a QPDecoderStream with QCodec?
Added Javadoc noting that arguments are expected to be String (and byte[] sometimes).
Codec does not do Stream (yet).


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

Author: garydgregory

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

@@ -41,7 +41,7 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: BCodec.java,v 1.7 2004/08/05 20:39:39 ggregory Exp $
+ * @version $Id: BCodec.java,v 1.8 2004/08/27 17:10:48 ggregory Exp $
  */
 public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
@@ -177,6 +177,11 @@ public Object encode(Object value) throws EncoderException {
      * Decodes a Base64 object into its original form. Escaped characters are converted back to their original
      * representation.
      * 
+     * <p>
+     * <em>Currently, this method only works with <code>String</code> arguments. 
+     * A <code>DecoderException</code> is thrown if the argument is not a <code>String</code>.</em>
+     * </p>
+     * 
      * @param value
      *                  Base64 object to convert into its original form
      * 

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

@@ -42,7 +42,7 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: QCodec.java,v 1.7 2004/07/26 22:55:40 ggregory Exp $
+ * @version $Id: QCodec.java,v 1.8 2004/08/27 17:10:48 ggregory Exp $
  */
 public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
@@ -259,6 +259,12 @@ public Object encode(Object pObject) throws EncoderException {
      * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original
      * representation.
      * 
+     * <p>
+     * <em>Currently, this method only works with <code>String</code> arguments. 
+     * A <code>DecoderException</code> is thrown if the argument is not a <code>String</code>.</em>
+     * </p>
+     * 
+     * 
      * @param pObject
      *                  quoted-printable object to convert into its original form
      * 

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

@@ -55,7 +55,7 @@
  * 
  * @author Apache Software Foundation
  * @since 1.3
- * @version $Id: QuotedPrintableCodec.java,v 1.9 2004/08/05 20:39:39 ggregory Exp $
+ * @version $Id: QuotedPrintableCodec.java,v 1.10 2004/08/27 17:10:48 ggregory Exp $
  */
 public class QuotedPrintableCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
     /**
@@ -332,6 +332,11 @@ public Object encode(Object pObject) throws EncoderException {
      * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original
      * representation.
      * 
+     * <p>
+     * <em>Currently, this method only works with <code>String</code> and <code>byte[]</code> arguments. 
+     * A <code>DecoderException</code> is thrown if the argument is not a <code>String</code> or <code>byte[].</code></em>.
+     * </p>
+     * 
      * @param pObject
      *                  quoted-printable object to convert into its original form
      * @return original object

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

@@ -45,7 +45,7 @@
  * 
  * @author Apache Software Foundation
  * @since 1.2
- * @version $Id: URLCodec.java,v 1.20 2004/07/26 22:55:39 ggregory Exp $
+ * @version $Id: URLCodec.java,v 1.21 2004/08/27 17:10:48 ggregory Exp $
  */
 public class URLCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
 
@@ -318,32 +318,36 @@ public Object encode(Object pObject) throws EncoderException {
     }
 
     /**
-     * Decodes a URL safe object into its original form. Escaped 
-     * characters are converted back to their original representation.
-     *
-     * @param pObject URL safe object to convert into its original form
-     * @return original object 
-     * @throws DecoderException Thrown if URL decoding is not 
-     *                          applicable to objects of this type
-     *                          if decoding is unsuccessful
+     * Decodes a URL safe object into its original form. Escaped characters are converted back to their original
+     * representation.
+     * 
+     * <p>
+     * <em>Currently, this method only works with <code>String</code> and <code>byte[]</code> arguments. 
+     * A <code>DecoderException</code> is thrown if the argument is not a <code>String</code> or <code>byte[].</code></em>.
+     * </p>
+     * 
+     * @param pObject
+     *                  URL safe object to convert into its original form
+     * @return original object
+     * @throws DecoderException
+     *                  Thrown if URL decoding is not applicable to objects of this type if decoding is unsuccessful
      */
     public Object decode(Object pObject) throws DecoderException {
         if (pObject == null) {
             return null;
         } else if (pObject instanceof byte[]) {
-            return decode((byte[])pObject);
+            return decode((byte[]) pObject);
         } else if (pObject instanceof String) {
-            return decode((String)pObject);
+            return decode((String) pObject);
         } else {
-            throw new DecoderException("Objects of type " +
-                pObject.getClass().getName() + " cannot be URL decoded"); 
-              
+            throw new DecoderException("Objects of type " + pObject.getClass().getName() + " cannot be URL decoded");
+
         }
     }
 
     /**
      * The <code>String</code> encoding used for decoding and encoding.
-     *
+     * 
      * @return Returns the encoding.
      * 
      * @deprecated use #getDefaultCharset()