commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r1379145 - in /commons/proper/codec/trunk/src/main/java/org/apache/commons/codec: ./ net/
Date Thu, 30 Aug 2012 21:02:53 GMT
Author: tn
Date: Thu Aug 30 21:02:52 2012
New Revision: 1379145

URL: http://svn.apache.org/viewvc?rev=1379145&view=rev
Log:
Harmonize javadoc format style, add missing . at end of first paragraph.

Modified:
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryDecoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryEncoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Decoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Encoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringDecoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryDecoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryDecoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryDecoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryDecoder.java Thu
Aug 30 21:02:52 2012
@@ -28,11 +28,10 @@ public interface BinaryDecoder extends D
      * Decodes a byte array and returns the results as a byte array.
      *
      * @param source
-     *                  A byte array which has been encoded with the appropriate encoder
+     *            A byte array which has been encoded with the appropriate encoder
      * @return a byte array that contains decoded content
      * @throws DecoderException
-     *                  A decoder exception is thrown if a Decoder encounters a failure condition
during
-     *                  the decode process.
+     *             A decoder exception is thrown if a Decoder encounters a failure condition
during the decode process.
      */
     byte[] decode(byte[] source) throws DecoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryEncoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryEncoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryEncoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/BinaryEncoder.java Thu
Aug 30 21:02:52 2012
@@ -25,14 +25,13 @@ package org.apache.commons.codec;
 public interface BinaryEncoder extends Encoder {
 
     /**
-     * Encodes a byte array and return the encoded data
-     * as a byte array.
+     * Encodes a byte array and return the encoded data as a byte array.
      *
      * @param source
-     *                  Data to be encoded
+     *            Data to be encoded
      * @return A byte array containing the encoded data
      * @throws EncoderException
-     *                  thrown if the Encoder encounters a failure condition during the encoding
process.
+     *             thrown if the Encoder encounters a failure condition during the encoding
process.
      */
     byte[] encode(byte[] source) throws EncoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Decoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Decoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Decoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Decoder.java Thu Aug
30 21:02:52 2012
@@ -30,17 +30,17 @@ package org.apache.commons.codec;
 public interface Decoder {
 
     /**
-     * Decodes an "encoded" Object and returns a "decoded" Object.  Note that the implementation
of this
-     * interface will try to cast the Object parameter to the specific type expected by a
particular Decoder
-     * implementation.  If a {@link ClassCastException} occurs this decode method will throw
a DecoderException.
+     * Decodes an "encoded" Object and returns a "decoded" Object. Note that the implementation
of this interface will
+     * try to cast the Object parameter to the specific type expected by a particular Decoder
implementation. If a
+     * {@link ClassCastException} occurs this decode method will throw a DecoderException.
      *
      * @param source
-     *                  the object to decode
+     *            the object to decode
      * @return a 'decoded" object
      * @throws DecoderException
-     *                  a decoder exception can be thrown for any number of reasons.  Some
good candidates are that
-     *                  the parameter passed to this method is null, a param cannot be cast
to the appropriate type
-     *                  for a specific encoder.
+     *             a decoder exception can be thrown for any number of reasons. Some good
candidates are that the
+     *             parameter passed to this method is null, a param cannot be cast to the
appropriate type for a
+     *             specific encoder.
      */
     Object decode(Object source) throws DecoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
Thu Aug 30 21:02:52 2012
@@ -55,11 +55,9 @@ public class DecoderException extends Ex
 
     /**
      * Constructs a new exception with the specified detail message and cause.
-     *
      * <p>
      * Note that the detail message associated with <code>cause</code> is not
automatically incorporated into this
      * exception's detail message.
-     * </p>
      *
      * @param message
      *            The detail message which is saved for later retrieval by the {@link #getMessage()}
method.

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Encoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Encoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Encoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Encoder.java Thu Aug
30 21:02:52 2012
@@ -33,11 +33,11 @@ public interface Encoder {
      * <code>byte[]</code> or <code>String</code>s depending on the
implementation used.
      *
      * @param source
-     *                  An object to encode
+     *            An object to encode
      * @return An "encoded" Object
      * @throws EncoderException
-     *                  An encoder exception is thrown if the encoder experiences a failure
condition during
-     *                  the encoding process.
+     *             An encoder exception is thrown if the encoder experiences a failure condition
during the encoding
+     *             process.
      */
     Object encode(Object source) throws EncoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringDecoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringDecoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringDecoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringDecoder.java Thu
Aug 30 21:02:52 2012
@@ -28,10 +28,10 @@ public interface StringDecoder extends D
      * Decodes a String and returns a String.
      *
      * @param source
-     *                  the String to decode
+     *            the String to decode
      * @return the encoded String
      * @throws DecoderException
-     *                  thrown if there is an error condition during the Encoding process.
+     *             thrown if there is an error condition during the Encoding process.
      */
     String decode(String source) throws DecoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoder.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoder.java Thu
Aug 30 21:02:52 2012
@@ -28,10 +28,10 @@ public interface StringEncoder extends E
      * Encodes a String and returns a String.
      *
      * @param source
-     *                  the String to encode
+     *            the String to encode
      * @return the encoded String
      * @throws EncoderException
-     *                  thrown if there is an error condition during the encoding process.
+     *             thrown if there is an error condition during the encoding process.
      */
     String encode(String source) throws EncoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java Thu
Aug 30 21:02:52 2012
@@ -61,7 +61,7 @@ public class BCodec extends RFC1522Codec
      * Constructor which allows for the selection of a default charset
      *
      * @param charset
-     *                  the default string charset to use.
+     *            the default string charset to use.
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard
charsets</a>
      * @since 1.7
@@ -74,7 +74,7 @@ public class BCodec extends RFC1522Codec
      * Constructor which allows for the selection of a default charset
      *
      * @param charsetName
-     *                  the default charset to use.
+     *            the default charset to use.
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      * @since 1.7 throws UnsupportedCharsetException if the named charset is unavailable
@@ -109,13 +109,12 @@ public class BCodec extends RFC1522Codec
      * Encodes a string into its Base64 form using the specified charset. Unsafe characters
are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @param charset
-     *                  the charset for <code>value</code>
+     *            the charset for <code>value</code>
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      * @since 1.7
      */
     public String encode(final String value, final Charset charset) throws EncoderException
{
@@ -129,13 +128,12 @@ public class BCodec extends RFC1522Codec
      * Encodes a string into its Base64 form using the specified charset. Unsafe characters
are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @param charset
-     *                  the charset for <code>value</code>
+     *            the charset for <code>value</code>
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     public String encode(final String value, final String charset) throws EncoderException
{
         if (value == null) {
@@ -152,11 +150,10 @@ public class BCodec extends RFC1522Codec
      * Encodes a string into its Base64 form using the default charset. Unsafe characters
are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public String encode(String value) throws EncoderException {
@@ -192,11 +189,10 @@ public class BCodec extends RFC1522Codec
      * Encodes an object into its Base64 form using the default charset. Unsafe characters
are escaped.
      *
      * @param value
-     *                  object to convert to Base64 form
+     *            object to convert to Base64 form
      * @return Base64 object
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public Object encode(Object value) throws EncoderException {
@@ -216,13 +212,11 @@ public class BCodec extends RFC1522Codec
      * representation.
      *
      * @param value
-     *                  Base64 object to convert into its original form
-     *
+     *            Base64 object to convert into its original form
      * @return original object
-     *
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code>.
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.
      */
     @Override
     public Object decode(Object value) throws DecoderException {

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java Thu
Aug 30 21:02:52 2012
@@ -118,10 +118,10 @@ public class QCodec extends RFC1522Codec
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charset
-     *                  the default string charset to use.
+     *            the default string charset to use.
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard
charsets</a>
      * @since 1.7
@@ -132,10 +132,10 @@ public class QCodec extends RFC1522Codec
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charsetName
-     *                  the charset to use.
+     *            the charset to use.
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      * @since 1.7 throws UnsupportedCharsetException if the named charset is unavailable
@@ -197,13 +197,12 @@ public class QCodec extends RFC1522Codec
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe
characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      * @since 1.7
      */
     public String encode(final String str, final Charset charset) throws EncoderException
{
@@ -217,13 +216,12 @@ public class QCodec extends RFC1522Codec
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe
characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     public String encode(final String str, final String charset) throws EncoderException
{
         if (str == null) {
@@ -240,11 +238,10 @@ public class QCodec extends RFC1522Codec
      * Encodes a string into its quoted-printable form using the default charset. Unsafe
characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public String encode(String str) throws EncoderException {
@@ -259,12 +256,10 @@ public class QCodec extends RFC1522Codec
      * representation.
      *
      * @param str
-     *                  quoted-printable string to convert into its original form
-     *
+     *            quoted-printable string to convert into its original form
      * @return original string
-     *
      * @throws DecoderException
-     *                  A decoder exception is thrown if a failure condition is encountered
during the decode process.
+     *             A decoder exception is thrown if a failure condition is encountered during
the decode process.
      */
     @Override
     public String decode(String str) throws DecoderException {
@@ -282,11 +277,10 @@ public class QCodec extends RFC1522Codec
      * Encodes an object into its quoted-printable form using the default charset. Unsafe
characters are escaped.
      *
      * @param obj
-     *                  object to convert to quoted-printable form
+     *            object to convert to quoted-printable form
      * @return quoted-printable object
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding
process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -306,13 +300,11 @@ public class QCodec extends RFC1522Codec
      * representation.
      *
      * @param obj
-     *                  quoted-printable object to convert into its original form
-     *
+     *            quoted-printable object to convert into its original form
      * @return original object
-     *
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code>.
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.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {
@@ -359,7 +351,7 @@ public class QCodec extends RFC1522Codec
      * Defines whether optional transformation of SPACE characters is to be used
      *
      * @param b
-     *                  {@code true} if SPACE characters are to be transformed, {@code false}
otherwise
+     *            {@code true} if SPACE characters are to be transformed, {@code false} otherwise
      */
     public void setEncodeBlanks(boolean b) {
         this.encodeBlanks = b;

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
Thu Aug 30 21:02:52 2012
@@ -94,10 +94,10 @@ public class QuotedPrintableCodec implem
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charset
-     *                  the default string charset to use.
+     *            the default string charset to use.
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      * @since 1.7
@@ -107,7 +107,7 @@ public class QuotedPrintableCodec implem
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charsetName
      *            the default string charset to use.
@@ -123,9 +123,9 @@ public class QuotedPrintableCodec implem
      * Encodes byte into its quoted-printable representation.
      *
      * @param b
-     *                  byte to encode
+     *            byte to encode
      * @param buffer
-     *                  the buffer to write to
+     *            the buffer to write to
      */
     private static final void encodeQuotedPrintable(int b, ByteArrayOutputStream buffer)
{
         buffer.write(ESCAPE_CHAR);
@@ -142,9 +142,9 @@ public class QuotedPrintableCodec implem
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
      *
      * @param printable
-     *                  bitset of characters deemed quoted-printable
+     *            bitset of characters deemed quoted-printable
      * @param bytes
-     *                  array of bytes to be encoded
+     *            array of bytes to be encoded
      * @return array of bytes containing quoted-printable data
      */
     public static final byte[] encodeQuotedPrintable(BitSet printable, byte[] bytes) {
@@ -177,10 +177,10 @@ public class QuotedPrintableCodec implem
      * RFC 1521.
      *
      * @param bytes
-     *                  array of quoted-printable characters
+     *            array of quoted-printable characters
      * @return array of original bytes
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is unsuccessful
+     *             Thrown if quoted-printable decoding is unsuccessful
      */
     public static final byte[] decodeQuotedPrintable(byte[] bytes) throws DecoderException
{
         if (bytes == null) {
@@ -211,7 +211,7 @@ public class QuotedPrintableCodec implem
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
      *
      * @param bytes
-     *                  array of bytes to be encoded
+     *            array of bytes to be encoded
      * @return array of bytes containing quoted-printable data
      */
     @Override
@@ -227,10 +227,10 @@ public class QuotedPrintableCodec implem
      * RFC 1521.
      *
      * @param bytes
-     *                  array of quoted-printable characters
+     *            array of quoted-printable characters
      * @return array of original bytes
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is unsuccessful
+     *             Thrown if quoted-printable decoding is unsuccessful
      */
     @Override
     public byte[] decode(byte[] bytes) throws DecoderException {
@@ -244,11 +244,10 @@ public class QuotedPrintableCodec implem
      * RFC 1521 and is suitable for encoding binary data.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  Thrown if quoted-printable encoding is unsuccessful
+     *             Thrown if quoted-printable encoding is unsuccessful
      *
      * @see #getCharset()
      */
@@ -262,12 +261,12 @@ public class QuotedPrintableCodec implem
      * are converted back to their original representation.
      *
      * @param str
-     *                  quoted-printable string to convert into its original form
+     *            quoted-printable string to convert into its original form
      * @param charset
-     *                  the original string charset
+     *            the original string charset
      * @return original string
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is unsuccessful
+     *             Thrown if quoted-printable decoding is unsuccessful
      * @since 1.7
      */
     public String decode(String str, Charset charset) throws DecoderException {
@@ -282,14 +281,14 @@ public class QuotedPrintableCodec implem
      * are converted back to their original representation.
      *
      * @param str
-     *                  quoted-printable string to convert into its original form
+     *            quoted-printable string to convert into its original form
      * @param charset
-     *                  the original string charset
+     *            the original string charset
      * @return original string
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is unsuccessful
+     *             Thrown if quoted-printable decoding is unsuccessful
      * @throws UnsupportedEncodingException
-     *                  Thrown if charset is not supported
+     *             Thrown if charset is not supported
      */
     public String decode(String str, String charset) throws DecoderException, UnsupportedEncodingException
{
         if (str == null) {
@@ -303,11 +302,10 @@ public class QuotedPrintableCodec implem
      * converted back to their original representation.
      *
      * @param str
-     *                  quoted-printable string to convert into its original form
+     *            quoted-printable string to convert into its original form
      * @return original string
      * @throws DecoderException
-     *                  Thrown if quoted-printable decoding is unsuccessful.
-     *                  Thrown if charset is not supported.
+     *             Thrown if quoted-printable decoding is unsuccessful. Thrown if charset
is not supported.
      * @see #getCharset()
      */
     @Override
@@ -319,11 +317,11 @@ public class QuotedPrintableCodec implem
      * Encodes an object into its quoted-printable safe form. Unsafe characters are escaped.
      *
      * @param obj
-     *                  string to convert to a quoted-printable form
+     *            string to convert to a quoted-printable form
      * @return quoted-printable object
      * @throws EncoderException
-     *                  Thrown if quoted-printable encoding is not applicable to objects
of this type or if
-     *                  encoding is unsuccessful
+     *             Thrown if quoted-printable encoding is not applicable to objects of this
type or if encoding is
+     *             unsuccessful
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -341,15 +339,15 @@ public class QuotedPrintableCodec implem
     }
 
     /**
-     * Decodes a quoted-printable object into its original form. Escaped characters are converted
back to their
-     * original representation.
+     * Decodes a quoted-printable object into its original form. Escaped characters are converted
back to their original
+     * representation.
      *
      * @param obj
-     *                  quoted-printable object to convert into its original form
+     *            quoted-printable object to convert into its original form
      * @return original object
      * @throws DecoderException
-     *                  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.
+     *             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.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {
@@ -392,9 +390,9 @@ public class QuotedPrintableCodec implem
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
      * @since 1.7
      */
@@ -412,13 +410,12 @@ public class QuotedPrintableCodec implem
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
-     *
      * @throws UnsupportedEncodingException
-     *                  Thrown if the charset is not supported
+     *             Thrown if the charset is not supported
      */
     public String encode(String str, String charset) throws UnsupportedEncodingException
{
         if (str == null) {

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
Thu Aug 30 21:02:52 2012
@@ -41,39 +41,31 @@ import org.apache.commons.codec.binary.S
  */
 abstract class RFC1522Codec {
 
-    /**
-     * Separator.
-     */
+    /** Separator. */
     protected static final char SEP = '?';
 
-    /**
-     * Prefix
-     */
+    /** Prefix. */
     protected static final String POSTFIX = "?=";
 
-    /**
-     * Postfix
-     */
+    /** Postfix. */
     protected static final String PREFIX = "=?";
 
     /**
-     * Applies an RFC 1522 compliant encoding scheme to the given string of text with the
-     * given charset. This method constructs the "encoded-word" header common to all the
-     * RFC 1522 codecs and then invokes {@link #doEncoding(byte [])} method of a concrete
-     * class to perform the specific encoding.
-     *
-     * @param text a string to encode
-     * @param charset a charset to be used
-     *
+     * Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset.
+     * <p>
+     * This method constructs the "encoded-word" header common to all the RFC 1522 codecs
and then invokes
+     * {@link #doEncoding(byte [])} method of a concrete class to perform the specific encoding.
+     *
+     * @param text
+     *            a string to encode
+     * @param charset
+     *            a charset to be used
      * @return RFC 1522 compliant "encoded-word"
-     *
-     * @throws EncoderException thrown if there is an error condition during the Encoding
-     *  process.
+     * @throws EncoderException
+     *             thrown if there is an error condition during the Encoding process.
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard
charsets</a>
      */
-    protected String encodeText(final String text, final Charset charset)
-     throws EncoderException
-    {
+    protected String encodeText(final String text, final Charset charset) throws EncoderException
{
         if (text == null) {
             return null;
         }
@@ -90,25 +82,25 @@ abstract class RFC1522Codec {
     }
 
     /**
-     * Applies an RFC 1522 compliant encoding scheme to the given string of text with the
-     * given charset. This method constructs the "encoded-word" header common to all the
-     * RFC 1522 codecs and then invokes {@link #doEncoding(byte [])} method of a concrete
-     * class to perform the specific encoding.
-     *
-     * @param text a string to encode
-     * @param charsetName the charset to use
-     *
+     * Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset.
+     * <p>
+     * This method constructs the "encoded-word" header common to all the RFC 1522 codecs
and then invokes
+     * {@link #doEncoding(byte [])} method of a concrete class to perform the specific encoding.
+     *
+     * @param text
+     *            a string to encode
+     * @param charsetName
+     *            the charset to use
      * @return RFC 1522 compliant "encoded-word"
-     *
-     * @throws EncoderException thrown if there is an error condition during the Encoding
-     *  process.
-     * @throws UnsupportedEncodingException if charset is not available
+     * @throws EncoderException
+     *             thrown if there is an error condition during the Encoding process.
+     * @throws UnsupportedEncodingException
+     *             if charset is not available
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard
charsets</a>
      */
     protected String encodeText(final String text, final String charsetName)
-     throws EncoderException, UnsupportedEncodingException
-    {
+            throws EncoderException, UnsupportedEncodingException {
         if (text == null) {
             return null;
         }
@@ -116,21 +108,21 @@ abstract class RFC1522Codec {
     }
 
     /**
-     * Applies an RFC 1522 compliant decoding scheme to the given string of text. This method
-     * processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes
+     * Applies an RFC 1522 compliant decoding scheme to the given string of text.
+     * <p>
+     * This method processes the "encoded-word" header common to all the RFC 1522 codecs
and then invokes
      * {@link #doEncoding(byte [])} method of a concrete class to perform the specific decoding.
      *
-     * @param text a string to decode
+     * @param text
+     *            a string to decode
      * @return A new decoded String or {@code null} if the input is {@code null}.
-     *
-     * @throws DecoderException thrown if there is an error condition during the decoding
-     *  process.
-     * @throws UnsupportedEncodingException thrown if charset specified in the "encoded-word"
-     *  header is not supported
+     * @throws DecoderException
+     *             thrown if there is an error condition during the decoding process.
+     * @throws UnsupportedEncodingException
+     *             thrown if charset specified in the "encoded-word" header is not supported
      */
     protected String decodeText(final String text)
-     throws DecoderException, UnsupportedEncodingException
-    {
+            throws DecoderException, UnsupportedEncodingException {
         if (text == null) {
             return null;
         }
@@ -154,8 +146,7 @@ abstract class RFC1522Codec {
         }
         String encoding = text.substring(from, to);
         if (!getEncoding().equalsIgnoreCase(encoding)) {
-            throw new DecoderException("This codec cannot decode " +
-                encoding + " encoded content");
+            throw new DecoderException("This codec cannot decode " + encoding + " encoded
content");
         }
         from = to + 1;
         to = text.indexOf(SEP, from);
@@ -165,33 +156,31 @@ abstract class RFC1522Codec {
     }
 
     /**
-     * Returns the codec name (referred to as encoding in the RFC 1522)
+     * Returns the codec name (referred to as encoding in the RFC 1522).
      *
      * @return name of the codec
      */
     protected abstract String getEncoding();
 
     /**
-     * Encodes an array of bytes using the defined encoding scheme
-     *
-     * @param bytes Data to be encoded
+     * Encodes an array of bytes using the defined encoding scheme.
      *
+     * @param bytes
+     *            Data to be encoded
      * @return A byte array containing the encoded data
-     *
-     * @throws EncoderException thrown if the Encoder encounters a failure condition
-     *  during the encoding process.
+     * @throws EncoderException
+     *             thrown if the Encoder encounters a failure condition during the encoding
process.
      */
     protected abstract byte[] doEncoding(byte[] bytes) throws EncoderException;
 
     /**
-     * Decodes an array of bytes using the defined encoding scheme
-     *
-     * @param bytes Data to be decoded
+     * Decodes an array of bytes using the defined encoding scheme.
      *
+     * @param bytes
+     *            Data to be decoded
      * @return a byte array that contains decoded data
-     *
-     * @throws DecoderException A decoder exception is thrown if a Decoder encounters a
-     *  failure condition during the decode process.
+     * @throws DecoderException
+     *             A decoder exception is thrown if a Decoder encounters a failure condition
during the decode process.
      */
     protected abstract byte[] doDecoding(byte[] bytes) throws DecoderException;
 }

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java?rev=1379145&r1=1379144&r2=1379145&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java Thu
Aug 30 21:02:52 2012
@@ -100,7 +100,7 @@ public class URLCodec implements BinaryE
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charset the default string charset to use.
      */
@@ -113,9 +113,9 @@ public class URLCodec implements BinaryE
      * Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters
are escaped.
      *
      * @param urlsafe
-     *                  bitset of characters deemed URL safe
+     *            bitset of characters deemed URL safe
      * @param bytes
-     *                  array of bytes to convert to URL safe characters
+     *            array of bytes to convert to URL safe characters
      * @return array of bytes containing URL safe characters
      */
     public static final byte[] encodeUrl(BitSet urlsafe, byte[] bytes) {
@@ -149,15 +149,14 @@ public class URLCodec implements BinaryE
     }
 
     /**
-     * Decodes an array of URL safe 7-bit characters into an array of
-     * original bytes. Escaped characters are converted back to their
-     * original representation.
+     * Decodes an array of URL safe 7-bit characters into an array of original bytes. Escaped
characters are converted
+     * back to their original representation.
      *
      * @param bytes
-     *                  array of URL safe characters
+     *            array of URL safe characters
      * @return array of original bytes
      * @throws DecoderException
-     *                  Thrown if URL decoding is unsuccessful
+     *             Thrown if URL decoding is unsuccessful
      */
     public static final byte[] decodeUrl(byte[] bytes) throws DecoderException {
         if (bytes == null) {
@@ -184,11 +183,10 @@ public class URLCodec implements BinaryE
     }
 
     /**
-     * Encodes an array of bytes into an array of URL safe 7-bit
-     * characters. Unsafe characters are escaped.
+     * Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters
are escaped.
      *
      * @param bytes
-     *                  array of bytes to convert to URL safe characters
+     *            array of bytes to convert to URL safe characters
      * @return array of bytes containing URL safe characters
      */
     @Override
@@ -198,15 +196,14 @@ public class URLCodec implements BinaryE
 
 
     /**
-     * Decodes an array of URL safe 7-bit characters into an array of
-     * original bytes. Escaped characters are converted back to their
-     * original representation.
+     * Decodes an array of URL safe 7-bit characters into an array of original bytes. Escaped
characters are converted
+     * back to their original representation.
      *
      * @param bytes
-     *                  array of URL safe characters
+     *            array of URL safe characters
      * @return array of original bytes
      * @throws DecoderException
-     *                  Thrown if URL decoding is unsuccessful
+     *             Thrown if URL decoding is unsuccessful
      */
     @Override
     public byte[] decode(byte[] bytes) throws DecoderException {
@@ -217,12 +214,12 @@ public class URLCodec implements BinaryE
      * Encodes a string into its URL safe form using the specified string charset. Unsafe
characters are escaped.
      *
      * @param str
-     *                  string to convert to a URL safe form
+     *            string to convert to a URL safe form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return URL safe string
      * @throws UnsupportedEncodingException
-     *                  Thrown if charset is not supported
+     *             Thrown if charset is not supported
      */
     public String encode(String str, String charset) throws UnsupportedEncodingException
{
         if (str == null) {
@@ -232,14 +229,13 @@ public class URLCodec implements BinaryE
     }
 
     /**
-     * Encodes a string into its URL safe form using the default string
-     * charset. Unsafe characters are escaped.
+     * Encodes a string into its URL safe form using the default string charset. Unsafe characters
are escaped.
      *
      * @param str
-     *                  string to convert to a URL safe form
+     *            string to convert to a URL safe form
      * @return URL safe string
      * @throws EncoderException
-     *                  Thrown if URL encoding is unsuccessful
+     *             Thrown if URL encoding is unsuccessful
      *
      * @see #getDefaultCharset()
      */
@@ -257,19 +253,18 @@ public class URLCodec implements BinaryE
 
 
     /**
-     * Decodes a URL safe string into its original form using the
-     * specified encoding. Escaped characters are converted back
-     * to their original representation.
+     * Decodes a URL safe string into its original form using the specified encoding. Escaped
characters are converted
+     * back to their original representation.
      *
      * @param str
-     *                  URL safe string to convert into its original form
+     *            URL safe string to convert into its original form
      * @param charset
-     *                  the original string charset
+     *            the original string charset
      * @return original string
      * @throws DecoderException
-     *                  Thrown if URL decoding is unsuccessful
+     *             Thrown if URL decoding is unsuccessful
      * @throws UnsupportedEncodingException
-     *                  Thrown if charset is not supported
+     *             Thrown if charset is not supported
      */
     public String decode(String str, String charset) throws DecoderException, UnsupportedEncodingException
{
         if (str == null) {
@@ -279,15 +274,14 @@ public class URLCodec implements BinaryE
     }
 
     /**
-     * Decodes a URL safe string into its original form using the default
-     * string charset. Escaped characters are converted back to their
-     * original representation.
+     * Decodes a URL safe string into its original form using the default string charset.
Escaped characters are
+     * converted back to their original representation.
      *
      * @param str
-     *                  URL safe string to convert into its original form
+     *            URL safe string to convert into its original form
      * @return original string
      * @throws DecoderException
-     *                  Thrown if URL decoding is unsuccessful
+     *             Thrown if URL decoding is unsuccessful
      * @see #getDefaultCharset()
      */
     @Override
@@ -306,10 +300,10 @@ public class URLCodec implements BinaryE
      * Encodes an object into its URL safe form. Unsafe characters are escaped.
      *
      * @param obj
-     *                  string to convert to a URL safe form
+     *            string to convert to a URL safe form
      * @return URL safe object
      * @throws EncoderException
-     *                  Thrown if URL encoding is not applicable to objects of this type
or if encoding is unsuccessful
+     *             Thrown if URL encoding is not applicable to objects of this type or if
encoding is unsuccessful
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -330,11 +324,11 @@ public class URLCodec implements BinaryE
      * representation.
      *
      * @param obj
-     *                  URL safe object to convert into its original form
+     *            URL safe object to convert into its original form
      * @return original object
      * @throws DecoderException
-     *                  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.
+     *             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.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {



Mime
View raw message