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.
*
- * <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) {
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.
*
- * <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) {
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.
*
- * <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) {
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.
*
- * <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) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
