Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@www.apache.org Received: (qmail 11803 invoked from network); 27 Aug 2004 17:18:24 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 27 Aug 2004 17:18:24 -0000 Received: (qmail 43934 invoked by uid 500); 27 Aug 2004 17:18:19 -0000 Delivered-To: apmail-jakarta-commons-dev-archive@jakarta.apache.org Received: (qmail 43817 invoked by uid 500); 27 Aug 2004 17:18:19 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 43801 invoked by uid 500); 27 Aug 2004 17:18:18 -0000 Received: (qmail 43796 invoked by uid 99); 27 Aug 2004 17:18:18 -0000 X-ASF-Spam-Status: No, hits=-2.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.27.1) with SMTP; Fri, 27 Aug 2004 10:18:18 -0700 Received: (qmail 11756 invoked by uid 1643); 27 Aug 2004 17:18:17 -0000 Date: 27 Aug 2004 17:18:17 -0000 Message-ID: <20040827171817.11755.qmail@minotaur.apache.org> From: ggregory@apache.org To: jakarta-commons-cvs@apache.org Subject: cvs commit: jakarta-commons/codec/src/java/org/apache/commons/codec/net URLCodec.java QCodec.java BCodec.java QuotedPrintableCodec.java X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N ggregory 2004/08/27 10:18:17 Modified: codec/src/java/org/apache/commons/codec/net URLCodec.java QCodec.java BCodec.java QuotedPrintableCodec.java Log: 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). Revision Changes Path 1.22 +3 -7 jakarta-commons/codec/src/java/org/apache/commons/codec/net/URLCodec.java Index: URLCodec.java =================================================================== RCS file: /home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/net/URLCodec.java,v retrieving revision 1.21 retrieving revision 1.22 diff -u -r1.21 -r1.22 --- URLCodec.java 27 Aug 2004 17:10:48 -0000 1.21 +++ URLCodec.java 27 Aug 2004 17:18:17 -0000 1.22 @@ -321,16 +321,12 @@ * Decodes a URL safe object into its original form. Escaped characters are converted back to their original * representation. * - *

- * Currently, this method only works with String and byte[] arguments. - * A DecoderException is thrown if the argument is not a String or byte[].. - *

- * * @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 String or byte[]. Thrown if a failure condition is + * encountered during the decode process. */ public Object decode(Object pObject) throws DecoderException { if (pObject == null) { 1.9 +3 -8 jakarta-commons/codec/src/java/org/apache/commons/codec/net/QCodec.java Index: QCodec.java =================================================================== RCS file: /home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/net/QCodec.java,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- QCodec.java 27 Aug 2004 17:10:48 -0000 1.8 +++ QCodec.java 27 Aug 2004 17:18:17 -0000 1.9 @@ -259,19 +259,14 @@ * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original * representation. * - *

- * Currently, this method only works with String arguments. - * A DecoderException is thrown if the argument is not a String. - *

- * - * * @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 String. Thrown if a failure condition is + * encountered during the decode process. */ public Object decode(Object pObject) throws DecoderException { if (pObject == null) { 1.9 +3 -7 jakarta-commons/codec/src/java/org/apache/commons/codec/net/BCodec.java Index: BCodec.java =================================================================== RCS file: /home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/net/BCodec.java,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- BCodec.java 27 Aug 2004 17:10:48 -0000 1.8 +++ BCodec.java 27 Aug 2004 17:18:17 -0000 1.9 @@ -177,18 +177,14 @@ * Decodes a Base64 object into its original form. Escaped characters are converted back to their original * representation. * - *

- * Currently, this method only works with String arguments. - * A DecoderException is thrown if the argument is not a String. - *

- * * @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 String. Thrown if a failure condition is + * encountered during the decode process. */ public Object decode(Object value) throws DecoderException { if (value == null) { 1.11 +3 -8 jakarta-commons/codec/src/java/org/apache/commons/codec/net/QuotedPrintableCodec.java Index: QuotedPrintableCodec.java =================================================================== RCS file: /home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/net/QuotedPrintableCodec.java,v retrieving revision 1.10 retrieving revision 1.11 diff -u -r1.10 -r1.11 --- QuotedPrintableCodec.java 27 Aug 2004 17:10:48 -0000 1.10 +++ QuotedPrintableCodec.java 27 Aug 2004 17:18:17 -0000 1.11 @@ -332,17 +332,12 @@ * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original * representation. * - *

- * Currently, this method only works with String and byte[] arguments. - * A DecoderException is thrown if the argument is not a String or byte[].. - *

- * * @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 String or byte[]. Thrown if a failure condition is + * encountered during the decode process. */ public Object decode(Object pObject) throws DecoderException { if (pObject == null) { --------------------------------------------------------------------- To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org For additional commands, e-mail: commons-dev-help@jakarta.apache.org