Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

JavaDoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@492183 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Roland Weber 2007-01-03 15:36:59 +00:00
parent 661ee70ce0
commit 36c082fdfc
8 changed files with 21 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/java/org/apache/http/auth/AuthScheme.java
View File

@ -75,7 +75,7 @@ public interface AuthScheme {
* may involve multiple challenge-response exchanges. Such schemes must be able
* to maintain the state information when dealing with sequential challenges
*
* @param challenge the challenge string
* @param header the challenge header
*
* @since 3.0
*/
@ -134,7 +134,7 @@ public interface AuthScheme {
* Produces an authorization string for the given set of {@link Credentials}.
*
* @param credentials The set of credentials to be used for athentication
* @param method The method being authenticated
* @param message The request being authenticated
* @throws AuthenticationException if authorization string cannot
* be generated due to an authentication failure
*

6
src/java/org/apache/http/conn/impl/IdleConnectionHandler.java
View File

@ -43,7 +43,7 @@ import org.apache.http.conn.HttpHostConnection;
*
* <p>This class is not synchronized.</p>
*
* @see org.apache.commons.httpclient.HttpConnectionManager#closeIdleConnections(long)
* @see org.apache.http.conn.HttpConnectionManager#closeIdleConnections(long)
*
* @since 3.0
*/
@ -63,11 +63,11 @@ public class IdleConnectionHandler {
/**
* Registers the given connection with this handler. The connection will be held until
* {@link #remove(HttpConnection)} or {@link #closeIdleConnections(long)} is called.
* {@link #remove} or {@link #closeIdleConnections} is called.
*
* @param connection the connection to add
*
* @see #remove(HttpConnection)
* @see #remove
*/
public void add(HttpHostConnection connection) {

7
src/java/org/apache/http/conn/impl/MultiThreadedHttpConnectionManager.java
View File

@ -430,8 +430,7 @@ public class MultiThreadedHttpConnectionManager implements HttpConnectionManager
* Gets the total number of pooled connections for the given host configuration. This
* is the total number of connections that have been created and are still in use
* by this connection manager for the host configuration. This value will
* not exceed the {@link #getMaxConnectionsPerHost() maximum number of connections per
* host}.
* not exceed the maximum number of connections per host.
*
* @param hostConfiguration The host configuration
* @return The total number of pooled connections
@ -446,8 +445,8 @@ public class MultiThreadedHttpConnectionManager implements HttpConnectionManager
/**
* Gets the total number of pooled connections. This is the total number of
* connections that have been created and are still in use by this connection
* manager. This value will not exceed the {@link #getMaxTotalConnections()
* maximum number of connections}.
* manager. This value will not exceed the maximum number of connections
* in total.
*
* @return the total number of pooled connections
*/

4
src/java/org/apache/http/conn/impl/SimpleHttpConnectionManager.java
View File

@ -184,9 +184,7 @@ public class SimpleHttpConnectionManager implements HttpConnectionManager {
return httpConnection;
}
/**
* @see HttpConnectionManager#releaseConnection(org.apache.commons.httpclient.HttpConnection)
*/
// non-javadoc, see interface HttpConnectionManager
public void releaseConnection(HttpHostConnection conn) {
if (conn != httpConnection) {
throw new IllegalStateException("Unexpected release of an unknown connection.");

2
src/java/org/apache/http/conn/params/HttpConnectionManagerParams.java
View File

@ -38,7 +38,7 @@ import org.apache.http.params.HttpParams;
/**
* This class represents a collection of HTTP protocol parameters applicable to
* {@link HttpConnectionManager HTTP connection managers}.
* {@link org.apache.http.conn.HttpConnectionManager HTTP connection managers}.
* Protocol parameters may be linked together to form a hierarchy. If a particular
* parameter value has not been explicitly defined in the collection itself, its
* value will be drawn from the parent collection of parameters.

8
src/java/org/apache/http/cookie/CookieAttributeHandler.java
View File

@ -47,9 +47,9 @@ public interface CookieAttributeHandler {
/**
* Parse the given cookie attribute value and update the corresponding
* {@link org.apache.commons.httpclient.Cookie} property.
* {@link org.apache.http.cookie.Cookie} property.
*
* @param cookie {@link org.apache.commons.httpclient.Cookie} to be updated
* @param cookie {@link org.apache.http.cookie.Cookie} to be updated
* @param value cookie attribute value from the cookie response header
*/
void parse(Cookie cookie, String value)
@ -58,7 +58,7 @@ public interface CookieAttributeHandler {
/**
* Peforms cookie validation for the given attribute value.
*
* @param cookie {@link org.apache.commons.httpclient.Cookie} to validate
* @param cookie {@link org.apache.http.cookie.Cookie} to validate
* @param origin the cookie source to validate against
* @throws MalformedCookieException if cookie validation fails for this attribute
*/
@ -69,7 +69,7 @@ public interface CookieAttributeHandler {
* Matches the given value (property of the destination host where request is being
* submitted) with the corresponding cookie attribute.
*
* @param cookie {@link org.apache.commons.httpclient.Cookie} to match
* @param cookie {@link org.apache.http.cookie.Cookie} to match
* @param origin the cookie source to match against
* @return <tt>true</tt> if the match is successful; <tt>false</tt> otherwise
*/

2
src/java/org/apache/http/cookie/CookieSpec.java
View File

@ -56,7 +56,7 @@ public interface CookieSpec {
* <p>This method will not perform the validation of the resultant
* {@link Cookie}s</p>
*
* @see #validate(String, int, String, boolean, Cookie)
* @see #validate
*
* @param header the <tt>Set-Cookie</tt> received from the server
* @param origin details of the cookie origin

13
src/java/org/apache/http/cookie/params/CookieSpecParams.java
View File

@ -56,8 +56,8 @@ public final class CookieSpecParams {
public static final String DATE_PATTERNS = "http.protocol.cookie-datepatterns";
/**
* Defines whether {@link org.apache.commons.httpclient.Cookie cookies} should be put on
* a single {@link org.apache.commons.httpclient.Header response header}.
* Defines whether {@link org.apache.http.cookie.Cookie cookies} should be put on
* a single {@link org.apache.http.Header request header}.
* <p>
* This parameter expects a value of type {@link Boolean}.
* </p>
@ -65,7 +65,7 @@ public final class CookieSpecParams {
public static final String SINGLE_COOKIE_HEADER = "http.protocol.single-cookie-header";
/**
* Defines {@link CookieSpec cookie specification} to be used for cookie management.
* Defines {@link org.apache.http.cookie.CookieSpec cookie specification} to be used for cookie management.
* <p>
* This parameter expects a value of type {@link String}.
* </p>
@ -105,11 +105,10 @@ public final class CookieSpecParams {
}
/**
* Assigns the {@link CookiePolicy cookie policy} to be used by the
* {@link org.apache.commons.httpclient.HttpMethod HTTP methods}
* this collection of parameters applies to.
* Assigns the {@link org.apache.http.cookie.CookiePolicy cookie policy} to be used
* when executing a request based on these parameters.
*
* @param policy the {@link CookiePolicy cookie policy}
* @param policy the cookie policy
*/
public static void setCookiePolicy(final HttpParams params, String policy) {
if (params == null) {