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@130413 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.8 2004/08/27 17:10:48 ggregory Exp $
+ * @version $Id: BCodec.java,v 1.9 2004/08/27 17:18:17 ggregory Exp $
  */
 public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
@@ -177,18 +177,14 @@ 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
      * 
      * @return original object
      * 
      * @throws DecoderException
-     *                  A decoder exception is thrown if a failure condition is encountered during the decode process.
+     *                  Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is
+     *                  encountered during the decode process.
      */
     public Object decode(Object value) throws DecoderException {
         if (value == null) {

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.8 2004/08/27 17:10:48 ggregory Exp $
+ * @version $Id: QCodec.java,v 1.9 2004/08/27 17:18:17 ggregory Exp $
  */
 public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder {
     /**
@@ -259,19 +259,14 @@ 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
      * 
      * @return original object
      * 
      * @throws DecoderException
-     *                  A decoder exception is thrown if a failure condition is encountered during the decode process.
+     *                  Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is
+     *                  encountered during the decode process.
      */
     public Object decode(Object pObject) throws DecoderException {
         if (pObject == null) {

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.10 2004/08/27 17:10:48 ggregory Exp $
+ * @version $Id: QuotedPrintableCodec.java,v 1.11 2004/08/27 17:18:17 ggregory Exp $
  */
 public class QuotedPrintableCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
     /**
@@ -332,17 +332,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> 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
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is not applicable to objects of this type if decoding is
-     *                  unsuccessful
+     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>. Thrown if a failure condition is
+     *                  encountered during the decode process.
      */
     public Object decode(Object pObject) throws DecoderException {
         if (pObject == null) {

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.21 2004/08/27 17:10:48 ggregory Exp $
+ * @version $Id: URLCodec.java,v 1.22 2004/08/27 17:18:17 ggregory Exp $
  */
 public class URLCodec implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder {
 
@@ -321,16 +321,12 @@ 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.
      * 
-     * <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
+     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>. Thrown if a failure condition is
+     *                  encountered during the decode process.
      */
     public Object decode(Object pObject) throws DecoderException {
         if (pObject == null) {