commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util EncodingUtil.java
Date Wed, 14 Jan 2004 20:48:44 GMT
olegk       2004/01/14 12:48:43

  Modified:    httpclient/src/java/org/apache/commons/httpclient
                        HttpClient.java HttpConnection.java
                        HttpConstants.java HttpMethodBase.java
               httpclient/src/java/org/apache/commons/httpclient/auth
                        AuthScheme.java AuthSchemeBase.java
                        BasicScheme.java DigestScheme.java NTLMScheme.java
                        RFC2617Scheme.java
               httpclient/src/java/org/apache/commons/httpclient/params
                        HttpMethodParams.java
               httpclient/src/java/org/apache/commons/httpclient/util
                        EncodingUtil.java
  Log:
  Javadocs corrections
  
  Revision  Changes    Path
  1.91      +12 -8     jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpClient.java
  
  Index: HttpClient.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpClient.java,v
  retrieving revision 1.90
  retrieving revision 1.91
  diff -u -r1.90 -r1.91
  --- HttpClient.java	12 Jan 2004 18:50:14 -0000	1.90
  +++ HttpClient.java	14 Jan 2004 20:48:43 -0000	1.91
  @@ -282,7 +282,8 @@
        *
        * @see #setStrictMode(boolean)
        *
  -     * @deprecated Use {@link HttpClientParams#getParameter(String)} 
  +     * @deprecated Use 
  +     * {@link org.apache.commons.httpclient.params.HttpClientParams#getParameter(String)}

        * to exercise a more granular control over HTTP protocol strictness.
        */
       public synchronized boolean isStrictMode() {
  @@ -296,7 +297,8 @@
        *
        * @param newTimeoutInMilliseconds Timeout in milliseconds
        * 
  -     * @deprecated Use {@link HttpConnectionManagerParams#setSoTimeout(int)},
  +     * @deprecated Use 
  +     * {@link org.apache.commons.httpclient.params.HttpConnectionManagerParams#setSoTimeout(int)},
        * {@link HttpConnectionManager#getParams()}.
        *
        */
  @@ -313,7 +315,8 @@
        * 
        * @see HttpConnectionManager#getConnection(HostConfiguration, long)
        * 
  -     * @deprecated Use {@link HttpClientParams#setConnectionManagerTimeout(long)},
  +     * @deprecated Use 
  +     * {@link org.apache.commons.httpclient.params.HttpClientParams#setConnectionManagerTimeout(long)},
        * {@link HttpClient#getParams()}
        */
       public synchronized void setHttpConnectionFactoryTimeout(long timeout) {
  @@ -327,7 +330,8 @@
        * @see HttpConnection#setConnectionTimeout(int)
        * @param newTimeoutInMilliseconds Timeout in milliseconds.
        * 
  -     * @deprecated Use {@link HttpConnectionManagerParams#setConnectionTimeout(int)},
  +     * @deprecated Use 
  +     * {@link org.apache.commons.httpclient.params.HttpConnectionManagerParams#setConnectionTimeout(int)},
        * {@link HttpConnectionManager#getParams()}.
        */
       public synchronized void setConnectionTimeout(int newTimeoutInMilliseconds) {
  
  
  
  1.84      +8 -8      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java
  
  Index: HttpConnection.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v
  retrieving revision 1.83
  retrieving revision 1.84
  diff -u -r1.83 -r1.84
  --- HttpConnection.java	13 Jan 2004 18:47:25 -0000	1.83
  +++ HttpConnection.java	14 Jan 2004 20:48:43 -0000	1.84
  @@ -1002,7 +1002,7 @@
        * Writes the specified String (as bytes) to the output stream.
        *
        * @param data the string to be written
  -     * @params charset the charset to use for writing the data
  +     * @param charset the charset to use for writing the data
        * @throws IllegalStateException if the connection is not open
        * @throws IOException if an I/O problem occurs
        */
  @@ -1013,7 +1013,7 @@
       }
       
       /**
  -     * @deprecated Use {@link #println(String, String)}
  +     * @deprecated Use {@link #printLine(String, String)}
        * 
        * Writes the specified String (as bytes), followed by
        * <tt>"\r\n".getBytes()</tt> to the output stream.
  @@ -1033,7 +1033,7 @@
        * <tt>"\r\n".getBytes()</tt> to the output stream.
        *
        * @param data the data to be written
  -     * @params charset the charset to use for writing the data
  +     * @param charset the charset to use for writing the data
        * @throws IllegalStateException if the connection is not open
        * @throws IOException if an I/O problem occurs
        */
  @@ -1078,7 +1078,7 @@
        * If the stream ends before the line terminator is found,
        * the last part of the string will still be returned.
        * 
  -     * @params charset the charset to use for reading the data
  +     * @param charset the charset to use for reading the data
        *
        * @throws IllegalStateException if the connection is not open
        * @throws IOException if an I/O problem occurs
  
  
  
  1.12      +4 -4      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConstants.java
  
  Index: HttpConstants.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConstants.java,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- HttpConstants.java	13 Jan 2004 18:47:25 -0000	1.11
  +++ HttpConstants.java	14 Jan 2004 20:48:43 -0000	1.12
  @@ -75,7 +75,7 @@
    * @author Oleg Kalnichevski
    * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
    * 
  - * @deprecated use {@link EncodingUtil}
  + * @deprecated use EncodingUtil class
    */
   public class HttpConstants {
   
  
  
  
  1.197     +8 -8      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java
  
  Index: HttpMethodBase.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v
  retrieving revision 1.196
  retrieving revision 1.197
  diff -u -r1.196 -r1.197
  --- HttpMethodBase.java	13 Jan 2004 18:47:25 -0000	1.196
  +++ HttpMethodBase.java	14 Jan 2004 20:48:43 -0000	1.197
  @@ -807,8 +807,8 @@
        * 
        * @param strictMode <tt>true</tt> for strict mode, <tt>false</tt>
otherwise
        * 
  -     * @deprecated Use {@link HttpParams#setParameter(String, Object)} to exercise 
  -     * a more granular control over HTTP protocol strictness.
  +     * @deprecated Use {@link org.apache.commons.httpclient.params.HttpParams#setParameter(String,
Object)}
  +     * to exercise a more granular control over HTTP protocol strictness.
        */
       public void setStrictMode(boolean strictMode) {
           if (strictMode) {
  @@ -819,8 +819,8 @@
       }
   
       /**
  -     * @deprecated Use {@link HttpParams#setParameter(String, Object)} to exercise 
  -     * a more granular control over HTTP protocol strictness.
  +     * @deprecated Use {@link org.apache.commons.httpclient.params.HttpParams#setParameter(String,
Object)}
  +     * to exercise a more granular control over HTTP protocol strictness.
        *
        * @return <tt>false</tt>
        */
  
  
  
  1.9       +4 -4      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/AuthScheme.java
  
  Index: AuthScheme.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/AuthScheme.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- AuthScheme.java	12 Jan 2004 18:50:14 -0000	1.8
  +++ AuthScheme.java	14 Jan 2004 20:48:43 -0000	1.9
  @@ -108,7 +108,7 @@
        * may involve multiple challenge-response exchanges. Such schemes must be able 
        * to maintain the state information when dealing with sequential challenges 
        * 
  -     * @param the challenge string
  +     * @param challenge the challenge string
        */
       void processChallenge(final String challenge) throws MalformedChallengeException;
       
  
  
  
  1.5       +4 -4      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/AuthSchemeBase.java
  
  Index: AuthSchemeBase.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/AuthSchemeBase.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- AuthSchemeBase.java	10 Dec 2003 21:04:13 -0000	1.4
  +++ AuthSchemeBase.java	14 Jan 2004 20:48:43 -0000	1.5
  @@ -87,7 +87,7 @@
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
        * 
  -     * @deprecated Use parameterless constructor and {@link AuthScheme#challenge(String)}

  +     * @deprecated Use parameterless constructor and {@link AuthScheme#processChallenge(String)}

        *             method
        */
       public AuthSchemeBase(final String challenge) 
  
  
  
  1.13      +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/BasicScheme.java
  
  Index: BasicScheme.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/BasicScheme.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- BasicScheme.java	13 Jan 2004 18:47:26 -0000	1.12
  +++ BasicScheme.java	14 Jan 2004 20:48:43 -0000	1.13
  @@ -111,7 +111,7 @@
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
        * 
  -     * @deprecated Use parameterless constructor and {@link AuthScheme#challenge(String)}

  +     * @deprecated Use parameterless constructor and {@link AuthScheme#processChallenge(String)}

        *             method
        */
       public BasicScheme(final String challenge) throws MalformedChallengeException {
  @@ -131,7 +131,7 @@
       /**
        * Processes the Basic challenge.
        *  
  -     * @param the challenge string
  +     * @param challenge the challenge string
        * 
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
  
  
  
  1.17      +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/DigestScheme.java
  
  Index: DigestScheme.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/DigestScheme.java,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- DigestScheme.java	13 Jan 2004 18:47:26 -0000	1.16
  +++ DigestScheme.java	14 Jan 2004 20:48:43 -0000	1.17
  @@ -166,7 +166,7 @@
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
        * 
  -     * @deprecated Use parameterless constructor and {@link AuthScheme#challenge(String)}

  +     * @deprecated Use parameterless constructor and {@link AuthScheme#processChallenge(String)}

        *             method
        */
       public DigestScheme(final String challenge) 
  @@ -178,7 +178,7 @@
       /**
        * Processes the Digest challenge.
        *  
  -     * @param the challenge string
  +     * @param challenge the challenge string
        * 
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
  
  
  
  1.16      +4 -4      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/NTLMScheme.java
  
  Index: NTLMScheme.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/NTLMScheme.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- NTLMScheme.java	12 Jan 2004 18:50:14 -0000	1.15
  +++ NTLMScheme.java	14 Jan 2004 20:48:43 -0000	1.16
  @@ -123,7 +123,7 @@
       /**
        * Processes the NTLM challenge.
        *  
  -     * @param the challenge string
  +     * @param challenge the challenge string
        * 
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
  
  
  
  1.7       +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/RFC2617Scheme.java
  
  Index: RFC2617Scheme.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/RFC2617Scheme.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- RFC2617Scheme.java	12 Jan 2004 18:50:14 -0000	1.6
  +++ RFC2617Scheme.java	14 Jan 2004 20:48:43 -0000	1.7
  @@ -97,7 +97,7 @@
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
        * 
  -     * @deprecated Use parameterless constructor and {@link AuthScheme#challenge(String)}

  +     * @deprecated Use parameterless constructor and {@link AuthScheme#processChallenge(String)}

        *             method
        */
       public RFC2617Scheme(final String challenge) throws MalformedChallengeException {
  @@ -110,7 +110,7 @@
        * may involve multiple challenge-response exchanges. Such schemes must be able 
        * to maintain the state information when dealing with sequential challenges 
        * 
  -     * @param the challenge string
  +     * @param challenge the challenge string
        * 
        * @throws MalformedChallengeException is thrown if the authentication challenge
        * is malformed
  
  
  
  1.9       +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/params/HttpMethodParams.java
  
  Index: HttpMethodParams.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/params/HttpMethodParams.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- HttpMethodParams.java	13 Jan 2004 18:47:27 -0000	1.8
  +++ HttpMethodParams.java	14 Jan 2004 20:48:43 -0000	1.9
  @@ -244,7 +244,7 @@
        * </p>
        * <p>
        * Set this to 0 to disallow any garbage/empty lines before the status line.<br
/>
  -     * To specify no limit, use {@link Integer.MAX_VALUE} (default in lenient mode).
  +     * To specify no limit, use {@link java.lang.Integer#MAX_VALUE} (default in lenient
mode).
        * </p>
        *  
        * This parameter expects a value of type {@link Integer}.
  
  
  
  1.5       +4 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util/EncodingUtil.java
  
  Index: EncodingUtil.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util/EncodingUtil.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- EncodingUtil.java	13 Jan 2004 18:47:27 -0000	1.4
  +++ EncodingUtil.java	14 Jan 2004 20:48:43 -0000	1.5
  @@ -99,8 +99,7 @@
        * as in multi-line text field values, are represented as CR LF pairs, i.e. `%0D%0A'.
        * 
        * <p>
  -     * if the given charset is not supported, {@link DEFAULT_CONTENT_CHARSET default HTTP
  -     * content encoding} is used instead.
  +     * if the given charset is not supported, ISO-8859-1 is used instead.
        * </p>
        * 
        * @param pairs the values to be encoded
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message