You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2014/08/21 16:56:51 UTC
svn commit: r1619420 [2/3] - in
/httpcomponents/httpclient/trunk/httpclient/src:
examples/org/apache/http/examples/client/
main/java-deprecated/org/apache/http/client/
main/java-deprecated/org/apache/http/conn/
main/java-deprecated/org/apache/http/conn...
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ConnectionBackoffStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ConnectionBackoffStrategy.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ConnectionBackoffStrategy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ConnectionBackoffStrategy.java Thu Aug 21 14:56:49 2014
@@ -32,7 +32,7 @@ import org.apache.http.HttpResponse;
* When managing a dynamic number of connections for a given route, this
* strategy assesses whether a given request execution outcome should
* result in a backoff signal or not, based on either examining the
- * <code>Throwable</code> that resulted or by examining the resulting
+ * {@code Throwable} that resulted or by examining the resulting
* response (e.g. for its status code).
*
* @since 4.2
@@ -41,11 +41,11 @@ import org.apache.http.HttpResponse;
public interface ConnectionBackoffStrategy {
/**
- * Determines whether seeing the given <code>Throwable</code> as
+ * Determines whether seeing the given {@code Throwable} as
* a result of request execution should result in a backoff
* signal.
- * @param t the <code>Throwable</code> that happened
- * @return <code>true</code> if a backoff signal should be
+ * @param t the {@code Throwable} that happened
+ * @return {@code true} if a backoff signal should be
* given
*/
boolean shouldBackoff(Throwable t);
@@ -56,8 +56,8 @@ public interface ConnectionBackoffStrate
* signal. Implementations MUST restrict themselves to examining
* the response header and MUST NOT consume any of the response
* body, if any.
- * @param resp the <code>HttpResponse</code> that was received
- * @return <code>true</code> if a backoff signal should be
+ * @param resp the {@code HttpResponse} that was received
+ * @return {@code true} if a backoff signal should be
* given
*/
boolean shouldBackoff(HttpResponse resp);
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java Thu Aug 21 14:56:49 2014
@@ -95,7 +95,7 @@ public interface HttpClient {
*
* @param request the request to execute
* @param context the context to use for the execution, or
- * <code>null</code> to use the default context
+ * {@code null} to use the default context
*
* @return the response to the request. This is always a final response,
* never an intermediate response with an 1xx status code.
@@ -112,7 +112,7 @@ public interface HttpClient {
* Executes HTTP request using the default context.
*
* @param target the target host for the request.
- * Implementations may accept <code>null</code>
+ * Implementations may accept {@code null}
* if they can still determine a route, for example
* to a default target or by inspecting the request.
* @param request the request to execute
@@ -132,12 +132,12 @@ public interface HttpClient {
* Executes HTTP request using the given context.
*
* @param target the target host for the request.
- * Implementations may accept <code>null</code>
+ * Implementations may accept {@code null}
* if they can still determine a route, for example
* to a default target or by inspecting the request.
* @param request the request to execute
* @param context the context to use for the execution, or
- * <code>null</code> to use the default context
+ * {@code null} to use the default context
*
* @return the response to the request. This is always a final response,
* never an intermediate response with an 1xx status code.
@@ -188,7 +188,7 @@ public interface HttpClient {
* @param request the request to execute
* @param responseHandler the response handler
* @param context the context to use for the execution, or
- * <code>null</code> to use the default context
+ * {@code null} to use the default context
*
* @return the response object as generated by the response handler.
* @throws IOException in case of a problem or the connection was aborted
@@ -212,7 +212,7 @@ public interface HttpClient {
* </p>
*
* @param target the target host for the request.
- * Implementations may accept <code>null</code>
+ * Implementations may accept {@code null}
* if they can still determine a route, for example
* to a default target or by inspecting the request.
* @param request the request to execute
@@ -240,13 +240,13 @@ public interface HttpClient {
* </p>
*
* @param target the target host for the request.
- * Implementations may accept <code>null</code>
+ * Implementations may accept {@code null}
* if they can still determine a route, for example
* to a default target or by inspecting the request.
* @param request the request to execute
* @param responseHandler the response handler
* @param context the context to use for the execution, or
- * <code>null</code> to use the default context
+ * {@code null} to use the default context
*
* @return the response object as generated by the response handler.
* @throws IOException in case of a problem or the connection was aborted
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpRequestRetryHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpRequestRetryHandler.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpRequestRetryHandler.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpRequestRetryHandler.java Thu Aug 21 14:56:49 2014
@@ -52,7 +52,7 @@ public interface HttpRequestRetryHandler
* unsuccessfully executed
* @param context the context for the request execution
*
- * @return <code>true</code> if the method should be retried, <code>false</code>
+ * @return {@code true</code> if the method should be retried, <code>false}
* otherwise
*/
boolean retryRequest(IOException exception, int executionCount, HttpContext context);
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectStrategy.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectStrategy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectStrategy.java Thu Aug 21 14:56:49 2014
@@ -54,7 +54,7 @@ public interface RedirectStrategy {
* @param response the response received from the target server
* @param context the context for the request execution
*
- * @return <code>true</code> if the request should be redirected, <code>false</code>
+ * @return {@code true</code> if the request should be redirected, <code>false}
* otherwise
*/
boolean isRedirected(
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ServiceUnavailableRetryStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ServiceUnavailableRetryStrategy.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ServiceUnavailableRetryStrategy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/ServiceUnavailableRetryStrategy.java Thu Aug 21 14:56:49 2014
@@ -47,7 +47,7 @@ public interface ServiceUnavailableRetry
* unsuccessfully executed
* @param context the context for the request execution
- * @return <code>true</code> if the method should be retried, <code>false</code>
+ * @return {@code true</code> if the method should be retried, <code>false}
* otherwise
*/
boolean retryRequest(HttpResponse response, int executionCount, HttpContext context);
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java Thu Aug 21 14:56:49 2014
@@ -33,7 +33,7 @@ import org.apache.http.protocol.HttpCont
* A handler for determining if the given execution context is user specific
* or not. The token object returned by this handler is expected to uniquely
* identify the current user if the context is user specific or to be
- * <code>null</code> if the context does not contain any resources or details
+ * {@code null} if the context does not contain any resources or details
* specific to the current user.
* <p>
* The user token will be used to ensure that user specific resources will not
@@ -47,7 +47,7 @@ public interface UserTokenHandler {
/**
* The token object returned by this method is expected to uniquely
* identify the current user if the context is user specific or to be
- * <code>null</code> if it is not.
+ * {@code null} if it is not.
*
* @param context the execution context
*
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/config/RequestConfig.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/config/RequestConfig.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/config/RequestConfig.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/config/RequestConfig.java Thu Aug 21 14:56:49 2014
@@ -115,7 +115,7 @@ public class RequestConfig implements Cl
* HTTP/1.1 protocol.
* </p>
* <p>
- * Default: <code>false</code>
+ * Default: {@code false}
* </p>
*/
public boolean isExpectContinueEnabled() {
@@ -125,7 +125,7 @@ public class RequestConfig implements Cl
/**
* Returns HTTP proxy to be used for request execution.
* <p>
- * Default: <code>null</code>
+ * Default: {@code null}
* </p>
*/
public HttpHost getProxy() {
@@ -140,7 +140,7 @@ public class RequestConfig implements Cl
* connection originates.
* </p>
* <p>
- * Default: <code>null</code>
+ * Default: {@code null}
* </p>
*/
public InetAddress getLocalAddress() {
@@ -153,7 +153,7 @@ public class RequestConfig implements Cl
* should be used only when appropriate. For performance critical
* operations this check should be disabled.
* <p>
- * Default: <code>false</code> since 4.4
+ * Default: {@code false} since 4.4
* </p>
*
* @deprecated (4.4) Use {@link
@@ -168,7 +168,7 @@ public class RequestConfig implements Cl
* Determines the name of the cookie specification to be used for HTTP state
* management.
* <p>
- * Default: <code>null</code>
+ * Default: {@code null}
* </p>
*/
public String getCookieSpec() {
@@ -178,7 +178,7 @@ public class RequestConfig implements Cl
/**
* Determines whether redirects should be handled automatically.
* <p>
- * Default: <code>true</code>
+ * Default: {@code true}
* </p>
*/
public boolean isRedirectsEnabled() {
@@ -189,7 +189,7 @@ public class RequestConfig implements Cl
* Determines whether relative redirects should be rejected. HTTP specification
* requires the location value be an absolute URI.
* <p>
- * Default: <code>true</code>
+ * Default: {@code true}
* </p>
*/
public boolean isRelativeRedirectsAllowed() {
@@ -201,7 +201,7 @@ public class RequestConfig implements Cl
* be allowed. The HTTP spec is not sufficiently clear whether circular redirects
* are permitted, therefore optionally they can be enabled
* <p>
- * Default: <code>false</code>
+ * Default: {@code false}
* </p>
*/
public boolean isCircularRedirectsAllowed() {
@@ -212,7 +212,7 @@ public class RequestConfig implements Cl
* Returns the maximum number of redirects to be followed. The limit on number
* of redirects is intended to prevent infinite loops.
* <p>
- * Default: <code>50</code>
+ * Default: {@code 50}
* </p>
*/
public int getMaxRedirects() {
@@ -222,7 +222,7 @@ public class RequestConfig implements Cl
/**
* Determines whether authentication should be handled automatically.
* <p>
- * Default: <code>true</code>
+ * Default: {@code true}
* </p>
*/
public boolean isAuthenticationEnabled() {
@@ -233,7 +233,7 @@ public class RequestConfig implements Cl
* Determines the order of preference for supported authentication schemes
* when authenticating with the target host.
* <p>
- * Default: <code>null</code>
+ * Default: {@code null}
* </p>
*/
public Collection<String> getTargetPreferredAuthSchemes() {
@@ -244,7 +244,7 @@ public class RequestConfig implements Cl
* Determines the order of preference for supported authentication schemes
* when authenticating with the proxy host.
* <p>
- * Default: <code>null</code>
+ * Default: {@code null}
* </p>
*/
public Collection<String> getProxyPreferredAuthSchemes() {
@@ -260,7 +260,7 @@ public class RequestConfig implements Cl
* A negative value is interpreted as undefined (system default).
* </p>
* <p>
- * Default: <code>-1</code>
+ * Default: {@code -1}
* </p>
*/
public int getConnectionRequestTimeout() {
@@ -275,7 +275,7 @@ public class RequestConfig implements Cl
* A negative value is interpreted as undefined (system default).
* </p>
* <p>
- * Default: <code>-1</code>
+ * Default: {@code -1}
* </p>
*/
public int getConnectTimeout() {
@@ -283,7 +283,7 @@ public class RequestConfig implements Cl
}
/**
- * Defines the socket timeout (<code>SO_TIMEOUT</code>) in milliseconds,
+ * Defines the socket timeout ({@code SO_TIMEOUT}) in milliseconds,
* which is the timeout for waiting for data or, put differently,
* a maximum period inactivity between two consecutive data packets).
* <p>
@@ -291,7 +291,7 @@ public class RequestConfig implements Cl
* A negative value is interpreted as undefined (system default).
* </p>
* <p>
- * Default: <code>-1</code>
+ * Default: {@code -1}
* </p>
*/
public int getSocketTimeout() {
@@ -301,7 +301,7 @@ public class RequestConfig implements Cl
/**
* Determines whether compressed entities should be decompressed automatically.
* <p>
- * Default: <code>true</code>
+ * Default: {@code true}
* </p>
*
* @since 4.4
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/DeflateDecompressingEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/DeflateDecompressingEntity.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/DeflateDecompressingEntity.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/DeflateDecompressingEntity.java Thu Aug 21 14:56:49 2014
@@ -33,15 +33,15 @@ import org.apache.http.HttpEntity;
/**
* {@link org.apache.http.entity.HttpEntityWrapper} responsible for handling
- * deflate Content Coded responses. In RFC2616 terms, <code>deflate</code>
- * means a <code>zlib</code> stream as defined in RFC1950. Some server
+ * deflate Content Coded responses. In RFC2616 terms, {@code deflate}
+ * means a {@code zlib} stream as defined in RFC1950. Some server
* implementations have misinterpreted RFC2616 to mean that a
- * <code>deflate</code> stream as defined in RFC1951 should be used
+ * {@code deflate} stream as defined in RFC1951 should be used
* (or maybe they did that since that's how IE behaves?). It's confusing
- * that <code>deflate</code> in HTTP 1.1 means <code>zlib</code> streams
- * rather than <code>deflate</code> streams. We handle both types in here,
+ * that {@code deflate</code> in HTTP 1.1 means <code>zlib} streams
+ * rather than {@code deflate} streams. We handle both types in here,
* since that's what is seen on the internet. Moral - prefer
- * <code>gzip</code>!
+ * {@code gzip}!
*
* @see GzipDecompressingEntity
*
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/EntityBuilder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/EntityBuilder.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/EntityBuilder.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/entity/EntityBuilder.java Thu Aug 21 14:56:49 2014
@@ -274,7 +274,7 @@ public class EntityBuilder {
}
/**
- * Returns <code>true</code> if entity is to be chunk coded, <code>false</code> otherwise.
+ * Returns {@code true</code> if entity is to be chunk coded, <code>false} otherwise.
*/
public boolean isChunked() {
return chunked;
@@ -289,7 +289,7 @@ public class EntityBuilder {
}
/**
- * Returns <code>true</code> if entity is to be GZIP compressed, <code>false</code> otherwise.
+ * Returns {@code true</code> if entity is to be GZIP compressed, <code>false} otherwise.
*/
public boolean isGzipCompress() {
return gzipCompress;
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java Thu Aug 21 14:56:49 2014
@@ -41,14 +41,14 @@ import org.apache.http.HttpRequest;
public interface HttpUriRequest extends HttpRequest {
/**
- * Returns the HTTP method this request uses, such as <code>GET</code>,
- * <code>PUT</code>, <code>POST</code>, or other.
+ * Returns the HTTP method this request uses, such as {@code GET},
+ * {@code PUT</code>, <code>POST}, or other.
*/
String getMethod();
/**
* Returns the URI this request uses, such as
- * <code>http://example.org/path/to/file</code>.
+ * {@code http://example.org/path/to/file}.
* <p>
* Note that the URI may be absolute URI (as above) or may be a relative URI.
* </p>
@@ -77,8 +77,8 @@ public interface HttpUriRequest extends
/**
* Tests if the request execution has been aborted.
*
- * @return <code>true</code> if the request execution has been aborted,
- * <code>false</code> otherwise.
+ * @return {@code true} if the request execution has been aborted,
+ * {@code false} otherwise.
*/
boolean isAborted();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/ClientPNames.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/ClientPNames.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/ClientPNames.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/ClientPNames.java Thu Aug 21 14:56:49 2014
@@ -91,7 +91,7 @@ public interface ClientPNames {
public static final String COOKIE_POLICY = "http.protocol.cookie-policy";
/**
- * Defines the virtual host to be used in the <code>Host</code>
+ * Defines the virtual host to be used in the {@code Host}
* request header instead of the physical host.
* <p>
* This parameter expects a value of type {@link org.apache.http.HttpHost}.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestAddCookies.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestAddCookies.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestAddCookies.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestAddCookies.java Thu Aug 21 14:56:49 2014
@@ -60,7 +60,7 @@ import org.apache.http.util.TextUtils;
/**
* Request interceptor that matches cookies available in the current
* {@link CookieStore} to the request being executed and generates
- * corresponding <code>Cookie</code> request headers.
+ * corresponding {@code Cookie} request headers.
*
* @since 4.0
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestClientConnControl.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestClientConnControl.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestClientConnControl.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestClientConnControl.java Thu Aug 21 14:56:49 2014
@@ -41,9 +41,9 @@ import org.apache.http.protocol.HttpCont
import org.apache.http.util.Args;
/**
- * This protocol interceptor is responsible for adding <code>Connection</code>
- * or <code>Proxy-Connection</code> headers to the outgoing requests, which
- * is essential for managing persistence of <code>HTTP/1.0</code> connections.
+ * This protocol interceptor is responsible for adding {@code Connection}
+ * or {@code Proxy-Connection} headers to the outgoing requests, which
+ * is essential for managing persistence of {@code HTTP/1.0} connections.
*
* @since 4.0
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestExpectContinue.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestExpectContinue.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestExpectContinue.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestExpectContinue.java Thu Aug 21 14:56:49 2014
@@ -44,7 +44,7 @@ import org.apache.http.util.Args;
/**
* RequestExpectContinue is responsible for enabling the 'expect-continue'
- * handshake by adding <code>Expect</code> header.
+ * handshake by adding {@code Expect} header.
* <p>
* This interceptor takes into account {@link RequestConfig#isExpectContinueEnabled()}
* setting.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/DateUtils.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/DateUtils.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/DateUtils.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/DateUtils.java Thu Aug 21 14:56:49 2014
@@ -62,7 +62,7 @@ public final class DateUtils {
/**
* Date format pattern used to parse HTTP date headers in ANSI C
- * <code>asctime()</code> format.
+ * {@code asctime()} format.
*/
public static final String PATTERN_ASCTIME = "EEE MMM d HH:mm:ss yyyy";
@@ -114,9 +114,9 @@ public final class DateUtils {
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @param startDate During parsing, two digit years will be placed in the range
- * <code>startDate</code> to <code>startDate + 100 years</code>. This value may
- * be <code>null</code>. When <code>null</code> is given as a parameter, year
- * <code>2000</code> will be used.
+ * {@code startDate</code> to <code>startDate + 100 years}. This value may
+ * be {@code null</code>. When <code>null} is given as a parameter, year
+ * {@code 2000} will be used.
*
* @return the parsed date or null if input could not be parsed
*/
@@ -214,9 +214,9 @@ public final class DateUtils {
* creates a {@link SimpleDateFormat} for the requested format string.
*
* @param pattern
- * a non-<code>null</code> format String according to
+ * a non-{@code null} format String according to
* {@link SimpleDateFormat}. The format is not checked against
- * <code>null</code> since all paths go through
+ * {@code null} since all paths go through
* {@link DateUtils}.
* @return the requested format. This simple dateformat should not be used
* to {@link SimpleDateFormat#applyPattern(String) apply} to a
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java Thu Aug 21 14:56:49 2014
@@ -231,7 +231,7 @@ public class URIUtils {
/**
* Resolves a URI reference against a base URI. Work-around for bug in
- * java.net.URI (<http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535>)
+ * java.net.URI (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535)
*
* @param baseURI the base URI
* @param reference the URI reference
@@ -243,7 +243,7 @@ public class URIUtils {
/**
* Resolves a URI reference against a base URI. Work-around for bugs in
- * java.net.URI (e.g. <http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535>)
+ * java.net.URI (e.g. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535)
*
* @param baseURI the base URI
* @param reference the URI reference
@@ -349,7 +349,7 @@ public class URIUtils {
* Extracts target host from the given {@link URI}.
*
* @param uri
- * @return the target host if the URI is absolute or <code>null</null> if the URI is
+ * @return the target host if the URI is absolute or {@code null} if the URI is
* relative or does not contain a valid host name.
*
* @since 4.1
@@ -417,10 +417,10 @@ public class URIUtils {
* original request before any redirects
* @param target
* if the last URI is relative, it is resolved against this target,
- * or <code>null</code> if not available.
+ * or {@code null} if not available.
* @param redirects
* collection of redirect locations since the original request
- * or <code>null</code> if not available.
+ * or {@code null} if not available.
* @return interpreted (absolute) URI
*/
public static URI resolve(
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URLEncodedUtils.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URLEncodedUtils.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URLEncodedUtils.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URLEncodedUtils.java Thu Aug 21 14:56:49 2014
@@ -71,17 +71,17 @@ public class URLEncodedUtils {
/**
* Returns a list of {@link NameValuePair NameValuePairs} as built from the URI's query portion. For example, a URI
- * of http://example.org/path/to/file?a=1&b=2&c=3 would return a list of three NameValuePairs, one for a=1, one for
- * b=2, and one for c=3. By convention, {@code '&'} and {@code ';'} are accepted as parameter separators.
+ * of {@code http://example.org/path/to/file?a=1&b=2&c=3} would return a list of three NameValuePairs, one for a=1,
+ * one for b=2, and one for c=3. By convention, {@code '&'} and {@code ';'} are accepted as parameter separators.
* <p>
* This is typically useful while parsing an HTTP PUT.
*
* This API is currently only used for testing.
*
* @param uri
- * URI to parse
+ * URI to parse
* @param charset
- * Charset name to use while parsing the query
+ * Charset name to use while parsing the query
* @return a list of {@link NameValuePair} as built from the URI's query portion.
*/
public static List <NameValuePair> parse(final URI uri, final String charset) {
@@ -125,7 +125,7 @@ public class URLEncodedUtils {
/**
* Returns true if the entity's Content-Type header is
- * <code>application/x-www-form-urlencoded</code>.
+ * {@code application/x-www-form-urlencoded}.
*/
public static boolean isEncoded(final HttpEntity entity) {
final Header h = entity.getContentType();
@@ -140,8 +140,8 @@ public class URLEncodedUtils {
}
/**
- * Adds all parameters within the Scanner to the list of <code>parameters</code>, as encoded by
- * <code>encoding</code>. For example, a scanner containing the string <code>a=1&b=2&c=3</code> would add the
+ * Adds all parameters within the Scanner to the list of {@code parameters}, as encoded by
+ * {@code encoding</code>. For example, a scanner containing the string <code>a=1&b=2&c=3} would add the
* {@link NameValuePair NameValuePairs} a=1, b=2, and c=3 to the list of parameters. By convention, {@code '&'} and
* {@code ';'} are accepted as parameter separators.
*
@@ -161,8 +161,8 @@ public class URLEncodedUtils {
/**
* Adds all parameters within the Scanner to the list of
- * <code>parameters</code>, as encoded by <code>encoding</code>. For
- * example, a scanner containing the string <code>a=1&b=2&c=3</code> would
+ * {@code parameters</code>, as encoded by <code>encoding}. For
+ * example, a scanner containing the string {@code a=1&b=2&c=3} would
* add the {@link NameValuePair NameValuePairs} a=1, b=2, and c=3 to the
* list of parameters.
*
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionManager.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionManager.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionManager.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionManager.java Thu Aug 21 14:56:49 2014
@@ -53,7 +53,7 @@ public interface ClientConnectionManager
/**
* Obtains the scheme registry used by this manager.
*
- * @return the scheme registry, never <code>null</code>
+ * @return the scheme registry, never {@code null}
*/
SchemeRegistry getSchemeRegistry();
@@ -67,7 +67,7 @@ public interface ClientConnectionManager
/**
* Releases a connection for use by others.
* You may optionally specify how long the connection is valid
- * to be reused. Values <= 0 are considered to be valid forever.
+ * to be reused. Values <= 0 are considered to be valid forever.
* If the connection is not marked as reusable, the connection will
* not be reused regardless of the valid duration.
*
@@ -92,7 +92,7 @@ public interface ClientConnectionManager
* All expired connections will also be closed.
*
* @param idletime the idle time of connections to be closed
- * @param tunit the unit for the <code>idletime</code>
+ * @param tunit the unit for the {@code idletime}
*
* @see #closeExpiredConnections()
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionRequest.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionRequest.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ClientConnectionRequest.java Thu Aug 21 14:56:49 2014
@@ -51,8 +51,8 @@ public interface ClientConnectionRequest
* be thrown.
*
* @param timeout the timeout, 0 or negative for no timeout
- * @param tunit the unit for the <code>timeout</code>,
- * may be <code>null</code> only if there is no timeout
+ * @param tunit the unit for the {@code timeout},
+ * may be {@code null} only if there is no timeout
*
* @return a connection that can be used to communicate
* along the given route
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionKeepAliveStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionKeepAliveStrategy.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionKeepAliveStrategy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionKeepAliveStrategy.java Thu Aug 21 14:56:49 2014
@@ -59,7 +59,7 @@ public interface ConnectionKeepAliveStra
* the context in which the connection is being used.
*
* @return the duration in ms for which it is safe to keep the connection
- * idle, or <=0 if no suggested duration.
+ * idle, or <=0 if no suggested duration.
*/
long getKeepAliveDuration(HttpResponse response, HttpContext context);
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionRequest.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionRequest.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectionRequest.java Thu Aug 21 14:56:49 2014
@@ -52,8 +52,8 @@ public interface ConnectionRequest exten
* be thrown.
*
* @param timeout the timeout, 0 or negative for no timeout
- * @param tunit the unit for the <code>timeout</code>,
- * may be <code>null</code> only if there is no timeout
+ * @param tunit the unit for the {@code timeout},
+ * may be {@code null} only if there is no timeout
*
* @return a connection that can be used to communicate
* along the given route
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorInputStream.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorInputStream.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorInputStream.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorInputStream.java Thu Aug 21 14:56:49 2014
@@ -48,7 +48,7 @@ public class EofSensorInputStream extend
/**
* The wrapped input stream, while accessible.
- * The value changes to <code>null</code> when the wrapped stream
+ * The value changes to {@code null} when the wrapped stream
* becomes inaccessible.
*/
protected InputStream wrappedStream;
@@ -56,7 +56,7 @@ public class EofSensorInputStream extend
/**
* Indicates whether this stream itself is closed.
* If it isn't, but {@link #wrappedStream wrappedStream}
- * is <code>null</code>, we're running in EOF mode.
+ * is {@code null}, we're running in EOF mode.
* All read operations will indicate EOF without accessing
* the underlying stream. After closing this stream, read
* operations will trigger an {@link IOException IOException}.
@@ -76,7 +76,7 @@ public class EofSensorInputStream extend
* should be closed before detaching from it.
*
* @param in the wrapped stream
- * @param watcher the watcher for events, or <code>null</code> for
+ * @param watcher the watcher for events, or {@code null} for
* auto-close behavior without notification
*/
public EofSensorInputStream(final InputStream in,
@@ -98,8 +98,8 @@ public class EofSensorInputStream extend
/**
* Checks whether the underlying stream can be read from.
*
- * @return <code>true</code> if the underlying stream is accessible,
- * <code>false</code> if this stream is in EOF mode and
+ * @return {@code true} if the underlying stream is accessible,
+ * {@code false} if this stream is in EOF mode and
* detached from the underlying stream
*
* @throws IOException if this stream is already closed
@@ -179,10 +179,11 @@ public class EofSensorInputStream extend
* This method should only be called while the underlying stream is
* still accessible. Use {@link #isReadAllowed isReadAllowed} to
* check that condition.
- * <br/>
+ * <p>
* If EOF is detected, the watcher will be notified and this stream
* is detached from the underlying stream. This prevents multiple
* notifications from this stream.
+ * </p>
*
* @param eof the result of the calling read operation.
* A negative value indicates that EOF is reached.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorWatcher.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorWatcher.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorWatcher.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/EofSensorWatcher.java Thu Aug 21 14:56:49 2014
@@ -42,13 +42,13 @@ public interface EofSensorWatcher {
*
* @param wrapped the underlying stream which has reached EOF
*
- * @return <code>true</code> if <code>wrapped</code> should be closed,
- * <code>false</code> if it should be left alone
+ * @return {@code true</code> if <code>wrapped} should be closed,
+ * {@code false} if it should be left alone
*
* @throws IOException
* in case of an IO problem, for example if the watcher itself
* closes the underlying stream. The caller will leave the
- * wrapped stream alone, as if <code>false</code> was returned.
+ * wrapped stream alone, as if {@code false} was returned.
*/
boolean eofDetected(InputStream wrapped)
throws IOException;
@@ -60,13 +60,13 @@ public interface EofSensorWatcher {
*
* @param wrapped the underlying stream which has not reached EOF
*
- * @return <code>true</code> if <code>wrapped</code> should be closed,
- * <code>false</code> if it should be left alone
+ * @return {@code true</code> if <code>wrapped} should be closed,
+ * {@code false} if it should be left alone
*
* @throws IOException
* in case of an IO problem, for example if the watcher itself
* closes the underlying stream. The caller will leave the
- * wrapped stream alone, as if <code>false</code> was returned.
+ * wrapped stream alone, as if {@code false} was returned.
*/
boolean streamClosed(InputStream wrapped)
throws IOException;
@@ -82,13 +82,13 @@ public interface EofSensorWatcher {
*
* @param wrapped the underlying stream which has not reached EOF
*
- * @return <code>true</code> if <code>wrapped</code> should be closed,
- * <code>false</code> if it should be left alone
+ * @return {@code true</code> if <code>wrapped} should be closed,
+ * {@code false} if it should be left alone
*
* @throws IOException
* in case of an IO problem, for example if the watcher itself
* closes the underlying stream. The caller will leave the
- * wrapped stream alone, as if <code>false</code> was returned.
+ * wrapped stream alone, as if {@code false} was returned.
*/
boolean streamAbort(InputStream wrapped)
throws IOException;
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpClientConnectionManager.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpClientConnectionManager.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpClientConnectionManager.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpClientConnectionManager.java Thu Aug 21 14:56:49 2014
@@ -66,7 +66,7 @@ public interface HttpClientConnectionMan
* {@link #upgrade(org.apache.http.HttpClientConnection,
* org.apache.http.conn.routing.HttpRoute,
* org.apache.http.protocol.HttpContext) upgrade} method to upgrade
- * the connection after having executed <code>CONNECT</code> method to
+ * the connection after having executed {@code CONNECT} method to
* all intermediate proxy hops and and finally calling {@link #routeComplete(
* org.apache.http.HttpClientConnection,
* org.apache.http.conn.routing.HttpRoute,
@@ -75,7 +75,7 @@ public interface HttpClientConnectionMan
* </p>
*
* @param route HTTP route of the requested connection.
- * @param state expected state of the connection or <code>null</code>
+ * @param state expected state of the connection or {@code null}
* if the connection is not expected to carry any state.
*/
ConnectionRequest requestConnection(HttpRoute route, Object state);
@@ -84,7 +84,7 @@ public interface HttpClientConnectionMan
* Releases the connection back to the manager making it potentially
* re-usable by other consumers. Optionally, the maximum period
* of how long the manager should keep the connection alive can be
- * defined using <code>validDuration</code> and <code>timeUnit</code>
+ * defined using {@code validDuration</code> and <code>timeUnit}
* parameters.
*
* @param conn the managed connection to release.
@@ -115,7 +115,7 @@ public interface HttpClientConnectionMan
/**
* Upgrades the underlying connection socket to TLS/SSL (or another layering
- * protocol) after having executed <code>CONNECT</code> method to all
+ * protocol) after having executed {@code CONNECT} method to all
* intermediate proxy hops
*
* @param conn the managed connection.
@@ -144,16 +144,18 @@ public interface HttpClientConnectionMan
/**
* Closes idle connections in the pool.
- * <p/>
+ * <p>
* Open connections in the pool that have not been used for the
* timespan given by the argument will be closed.
* Currently allocated connections are not subject to this method.
* Times will be checked with milliseconds precision
- *
+ * </p>
+ * <p>
* All expired connections will also be closed.
+ * </p>
*
* @param idletime the idle time of connections to be closed
- * @param tunit the unit for the <code>idletime</code>
+ * @param tunit the unit for the {@code idletime}
*
* @see #closeExpiredConnections()
*/
@@ -161,11 +163,12 @@ public interface HttpClientConnectionMan
/**
* Closes all expired connections in the pool.
- * <p/>
+ * <p>
* Open connections in the pool that have not been used for
* the timespan defined when the connection was released will be closed.
* Currently allocated connections are not subject to this method.
* Times will be checked with milliseconds precision.
+ * </p>
*/
void closeExpiredConnections();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpRoutedConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpRoutedConnection.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpRoutedConnection.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/HttpRoutedConnection.java Thu Aug 21 14:56:49 2014
@@ -47,8 +47,8 @@ public interface HttpRoutedConnection ex
* The return value is well-defined only while the connection is open.
* It may change even while the connection is open.
*
- * @return <code>true</code> if this connection is secure,
- * <code>false</code> otherwise
+ * @return {@code true} if this connection is secure,
+ * {@code false} otherwise
*/
boolean isSecure();
@@ -56,7 +56,7 @@ public interface HttpRoutedConnection ex
* Obtains the current route of this connection.
*
* @return the route established so far, or
- * <code>null</code> if not connected
+ * {@code null} if not connected
*/
HttpRoute getRoute();
@@ -65,16 +65,17 @@ public interface HttpRoutedConnection ex
* If this connection is open, and the underlying socket is an
* {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of
* that socket is obtained. This is a potentially blocking operation.
- * <br/>
+ * <p>
* <b>Note:</b> Whether the underlying socket is an SSL socket
* can not necessarily be determined via {@link #isSecure}.
* Plain sockets may be considered secure, for example if they are
* connected to a known host in the same network segment.
* On the other hand, SSL sockets may be considered insecure,
* for example depending on the chosen cipher suite.
+ * </p>
*
* @return the underlying SSL session if available,
- * <code>null</code> otherwise
+ * {@code null} otherwise
*/
SSLSession getSSLSession();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedClientConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedClientConnection.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedClientConnection.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedClientConnection.java Thu Aug 21 14:56:49 2014
@@ -55,8 +55,8 @@ public interface ManagedClientConnection
* The return value is well-defined only while the connection is open.
* It may change even while the connection is open.
*
- * @return <code>true</code> if this connection is secure,
- * <code>false</code> otherwise
+ * @return {@code true} if this connection is secure,
+ * {@code false} otherwise
*/
@Override
boolean isSecure();
@@ -65,7 +65,7 @@ public interface ManagedClientConnection
* Obtains the current route of this connection.
*
* @return the route established so far, or
- * <code>null</code> if not connected
+ * {@code null} if not connected
*/
@Override
HttpRoute getRoute();
@@ -75,16 +75,17 @@ public interface ManagedClientConnection
* If this connection is open, and the underlying socket is an
* {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of
* that socket is obtained. This is a potentially blocking operation.
- * <br/>
+ * <p>
* <b>Note:</b> Whether the underlying socket is an SSL socket
* can not necessarily be determined via {@link #isSecure}.
* Plain sockets may be considered secure, for example if they are
* connected to a known host in the same network segment.
* On the other hand, SSL sockets may be considered insecure,
* for example depending on the chosen cipher suite.
+ * </p>
*
* @return the underlying SSL session if available,
- * <code>null</code> otherwise
+ * {@code null} otherwise
*/
@Override
SSLSession getSSLSession();
@@ -107,14 +108,15 @@ public interface ManagedClientConnection
* The route is the one previously passed to {@link #open open}.
* Subsequently, {@link #layerProtocol layerProtocol} can be called
* to layer the TLS/SSL protocol on top of the tunnelled connection.
- * <br/>
+ * <p>
* <b>Note:</b> In HttpClient 3, a call to the corresponding method
* would automatically trigger the layering of the TLS/SSL protocol.
* This is not the case anymore, you can establish a tunnel without
* layering a new protocol over the connection.
+ * </p>
*
- * @param secure <code>true</code> if the tunnel should be considered
- * secure, <code>false</code> otherwise
+ * @param secure {@code true} if the tunnel should be considered
+ * secure, {@code false} otherwise
* @param params the parameters for tunnelling this connection
*
* @throws IOException in case of a problem
@@ -136,8 +138,8 @@ public interface ManagedClientConnection
* of the tunnel. The tunnel does <i>not</i> yet
* reach to the target, use {@link #tunnelTarget}
* to indicate an end-to-end tunnel.
- * @param secure <code>true</code> if the connection should be
- * considered secure, <code>false</code> otherwise
+ * @param secure {@code true} if the connection should be
+ * considered secure, {@code false} otherwise
* @param params the parameters for tunnelling this connection
*
* @throws IOException in case of a problem
@@ -169,11 +171,12 @@ public interface ManagedClientConnection
* The connection will automatically clear the checkpoint when
* used for communication. A call to this method indicates that
* the next checkpoint has been reached.
- * <br/>
+ * <p>
* A reusable communication state is necessary but not sufficient
* for the connection to be reused.
* A {@link #getRoute route} mismatch, the connection being closed,
* or other circumstances might prevent reuse.
+ * </p>
*/
void markReusable();
@@ -183,12 +186,13 @@ public interface ManagedClientConnection
* to prevent its reuse. Reasons for preventing reuse include
* error conditions and the evaluation of a
* {@link org.apache.http.ConnectionReuseStrategy reuse strategy}.
- * <br/>
+ * <p>
* <b>Note:</b>
* It is <i>not</i> necessary to call here before writing to
* or reading from this connection. Communication attempts will
* automatically unmark the state as non-reusable. It can then
* be switched back using {@link #markReusable markReusable}.
+ * </p>
*/
void unmarkReusable();
@@ -197,9 +201,9 @@ public interface ManagedClientConnection
* See {@link #markReusable markReusable} and
* {@link #unmarkReusable unmarkReusable} for details.
*
- * @return <code>true</code> if this connection is marked as being in
+ * @return {@code true} if this connection is marked as being in
* a reusable communication state,
- * <code>false</code> otherwise
+ * {@code false} otherwise
*/
boolean isMarkedReusable();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedHttpClientConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedHttpClientConnection.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedHttpClientConnection.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ManagedHttpClientConnection.java Thu Aug 21 14:56:49 2014
@@ -73,7 +73,7 @@ public interface ManagedHttpClientConnec
* that socket is obtained. This is a potentially blocking operation.
*
* @return the underlying SSL session if available,
- * <code>null</code> otherwise
+ * {@code null} otherwise
*/
SSLSession getSSLSession();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/BasicRouteDirector.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/BasicRouteDirector.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/BasicRouteDirector.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/BasicRouteDirector.java Thu Aug 21 14:56:49 2014
@@ -43,7 +43,7 @@ public class BasicRouteDirector implemen
*
* @param plan the planned route
* @param fact the currently established route, or
- * <code>null</code> if nothing is established
+ * {@code null} if nothing is established
*
* @return one of the constants defined in this class, indicating
* either the next step to perform, or success, or failure.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoute.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoute.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoute.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoute.java Thu Aug 21 14:56:49 2014
@@ -52,7 +52,7 @@ public final class HttpRoute implements
/**
* The local address to connect from.
- * <code>null</code> indicates that the default should be used.
+ * {@code null} indicates that the default should be used.
*/
private final InetAddress localAddress;
@@ -91,11 +91,11 @@ public final class HttpRoute implements
*
* @param target the host to which to route
* @param local the local address to route from, or
- * <code>null</code> for the default
+ * {@code null} for the default
* @param proxies the proxy chain to use, or
- * <code>null</code> for a direct route
- * @param secure <code>true</code> if the route is (to be) secure,
- * <code>false</code> otherwise
+ * {@code null} for a direct route
+ * @param secure {@code true} if the route is (to be) secure,
+ * {@code false} otherwise
* @param tunnelled the tunnel type of this route
* @param layered the layering type of this route
*/
@@ -110,17 +110,17 @@ public final class HttpRoute implements
*
* @param target the host to which to route
* @param local the local address to route from, or
- * <code>null</code> for the default
+ * {@code null} for the default
* @param proxy the proxy to use, or
- * <code>null</code> for a direct route
- * @param secure <code>true</code> if the route is (to be) secure,
- * <code>false</code> otherwise
- * @param tunnelled <code>true</code> if the route is (to be) tunnelled
+ * {@code null} for a direct route
+ * @param secure {@code true} if the route is (to be) secure,
+ * {@code false} otherwise
+ * @param tunnelled {@code true} if the route is (to be) tunnelled
* via the proxy,
- * <code>false</code> otherwise
- * @param layered <code>true</code> if the route includes a
+ * {@code false} otherwise
+ * @param layered {@code true} if the route includes a
* layered protocol,
- * <code>false</code> otherwise
+ * {@code false} otherwise
*/
public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy,
final boolean secure, final TunnelType tunnelled, final LayerType layered) {
@@ -134,9 +134,9 @@ public final class HttpRoute implements
*
* @param target the host to which to route
* @param local the local address to route from, or
- * <code>null</code> for the default
- * @param secure <code>true</code> if the route is (to be) secure,
- * <code>false</code> otherwise
+ * {@code null} for the default
+ * @param secure {@code true} if the route is (to be) secure,
+ * {@code false} otherwise
*/
public HttpRoute(final HttpHost target, final InetAddress local, final boolean secure) {
this(target, local, Collections.<HttpHost>emptyList(), secure,
@@ -155,16 +155,16 @@ public final class HttpRoute implements
/**
* Creates a new route through a proxy.
- * When using this constructor, the <code>proxy</code> MUST be given.
+ * When using this constructor, the {@code proxy} MUST be given.
* For convenience, it is assumed that a secure connection will be
* layered over a tunnel through the proxy.
*
* @param target the host to which to route
* @param local the local address to route from, or
- * <code>null</code> for the default
+ * {@code null} for the default
* @param proxy the proxy to use
- * @param secure <code>true</code> if the route is (to be) secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is (to be) secure,
+ * {@code false} otherwise
*/
public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy,
final boolean secure) {
@@ -251,8 +251,8 @@ public final class HttpRoute implements
*
* @param obj the object to compare with
*
- * @return <code>true</code> if the argument is the same route,
- * <code>false</code>
+ * @return {@code true} if the argument is the same route,
+ * {@code false}
*/
@Override
public final boolean equals(final Object obj) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRouteDirector.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRouteDirector.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRouteDirector.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRouteDirector.java Thu Aug 21 14:56:49 2014
@@ -63,7 +63,7 @@ public interface HttpRouteDirector {
*
* @param plan the planned route
* @param fact the currently established route, or
- * <code>null</code> if nothing is established
+ * {@code null} if nothing is established
*
* @return one of the constants defined in this interface, indicating
* either the next step to perform, or success, or failure.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoutePlanner.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoutePlanner.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoutePlanner.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/HttpRoutePlanner.java Thu Aug 21 14:56:49 2014
@@ -50,12 +50,12 @@ public interface HttpRoutePlanner {
* Determines the route for a request.
*
* @param target the target host for the request.
- * Implementations may accept <code>null</code>
+ * Implementations may accept {@code null}
* if they can still determine a route, for example
* to a default target or by inspecting the request.
* @param request the request to execute
* @param context the context to use for the subsequent execution.
- * Implementations may accept <code>null</code>.
+ * Implementations may accept {@code null}.
*
* @return the route that the request should take
*
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteInfo.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteInfo.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteInfo.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteInfo.java Thu Aug 21 14:56:49 2014
@@ -55,11 +55,12 @@ public interface RouteInfo {
* over an existing connection.
* Protocols can only be layered over a tunnel to the target, or
* or over a direct connection without proxies.
- * <br/>
+ * <p>
* Layering a protocol
* over a direct connection makes little sense, since the connection
* could be established with the new protocol in the first place.
* But we don't want to exclude that use case.
+ * </p>
*/
public enum LayerType { PLAIN, LAYERED }
@@ -74,7 +75,7 @@ public interface RouteInfo {
* Obtains the local address to connect from.
*
* @return the local address,
- * or <code>null</code>
+ * or {@code null}
*/
InetAddress getLocalAddress();
@@ -109,7 +110,7 @@ public interface RouteInfo {
* Obtains the first proxy host.
*
* @return the first proxy in the proxy chain, or
- * <code>null</code> if this route is direct
+ * {@code null} if this route is direct
*/
HttpHost getProxyHost();
@@ -125,9 +126,9 @@ public interface RouteInfo {
* Checks whether this route is tunnelled through a proxy.
* If there is a proxy chain, only end-to-end tunnels are considered.
*
- * @return <code>true</code> if tunnelled end-to-end through at least
+ * @return {@code true} if tunnelled end-to-end through at least
* one proxy,
- * <code>false</code> otherwise
+ * {@code false} otherwise
*/
boolean isTunnelled();
@@ -145,16 +146,16 @@ public interface RouteInfo {
* In the presence of proxies, only layering over an end-to-end tunnel
* is considered.
*
- * @return <code>true</code> if layered,
- * <code>false</code> otherwise
+ * @return {@code true} if layered,
+ * {@code false} otherwise
*/
boolean isLayered();
/**
* Checks whether this route is secure.
*
- * @return <code>true</code> if secure,
- * <code>false</code> otherwise
+ * @return {@code true} if secure,
+ * {@code false} otherwise
*/
boolean isSecure();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteTracker.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteTracker.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteTracker.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/routing/RouteTracker.java Thu Aug 21 14:56:49 2014
@@ -48,7 +48,7 @@ public final class RouteTracker implemen
/**
* The local address to connect from.
- * <code>null</code> indicates that the default should be used.
+ * {@code null} indicates that the default should be used.
*/
private final InetAddress localAddress;
@@ -76,7 +76,7 @@ public final class RouteTracker implemen
*
* @param target the host to which to route
* @param local the local address to route from, or
- * <code>null</code> for the default
+ * {@code null} for the default
*/
public RouteTracker(final HttpHost target, final InetAddress local) {
Args.notNull(target, "Target host");
@@ -111,8 +111,8 @@ public final class RouteTracker implemen
/**
* Tracks connecting to the target.
*
- * @param secure <code>true</code> if the route is secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is secure,
+ * {@code false} otherwise
*/
public final void connectTarget(final boolean secure) {
Asserts.check(!this.connected, "Already connected");
@@ -124,8 +124,8 @@ public final class RouteTracker implemen
* Tracks connecting to the first proxy.
*
* @param proxy the proxy connected to
- * @param secure <code>true</code> if the route is secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is secure,
+ * {@code false} otherwise
*/
public final void connectProxy(final HttpHost proxy, final boolean secure) {
Args.notNull(proxy, "Proxy host");
@@ -138,8 +138,8 @@ public final class RouteTracker implemen
/**
* Tracks tunnelling to the target.
*
- * @param secure <code>true</code> if the route is secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is secure,
+ * {@code false} otherwise
*/
public final void tunnelTarget(final boolean secure) {
Asserts.check(this.connected, "No tunnel unless connected");
@@ -154,8 +154,8 @@ public final class RouteTracker implemen
* the route as tunnelled. Only end-to-end tunnels are considered there.
*
* @param proxy the proxy tunnelled to
- * @param secure <code>true</code> if the route is secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is secure,
+ * {@code false} otherwise
*/
public final void tunnelProxy(final HttpHost proxy, final boolean secure) {
Args.notNull(proxy, "Proxy host");
@@ -174,8 +174,8 @@ public final class RouteTracker implemen
/**
* Tracks layering a protocol.
*
- * @param secure <code>true</code> if the route is secure,
- * <code>false</code> otherwise
+ * @param secure {@code true} if the route is secure,
+ * {@code false} otherwise
*/
public final void layerProtocol(final boolean secure) {
// it is possible to layer a protocol over a direct connection,
@@ -263,7 +263,7 @@ public final class RouteTracker implemen
* If not connected, nothing has been tracked so far.
*
* @return the tracked route, or
- * <code>null</code> if nothing has been tracked so far
+ * {@code null} if nothing has been tracked so far
*/
public final HttpRoute toRoute() {
return !this.connected ?
@@ -277,8 +277,8 @@ public final class RouteTracker implemen
*
* @param o the object to compare with
*
- * @return <code>true</code> if the argument is the same tracked route,
- * <code>false</code>
+ * @return {@code true} if the argument is the same tracked route,
+ * {@code false}
*/
@Override
public final boolean equals(final Object o) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/Scheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/Scheme.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/Scheme.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/Scheme.java Thu Aug 21 14:56:49 2014
@@ -77,7 +77,7 @@ public final class Scheme {
/**
* Creates a new scheme.
* Whether the created scheme allows for layered connections
- * depends on the class of <code>factory</code>.
+ * depends on the class of {@code factory}.
*
* @param name the scheme name, for example "http".
* The name will be converted to lowercase.
@@ -108,7 +108,7 @@ public final class Scheme {
/**
* Creates a new scheme.
* Whether the created scheme allows for layered connections
- * depends on the class of <code>factory</code>.
+ * depends on the class of {@code factory}.
*
* @param name the scheme name, for example "http".
* The name will be converted to lowercase.
@@ -197,8 +197,8 @@ public final class Scheme {
/**
* Indicates whether this scheme allows for layered connections.
*
- * @return <code>true</code> if layered connections are possible,
- * <code>false</code> otherwise
+ * @return {@code true} if layered connections are possible,
+ * {@code false} otherwise
*/
public final boolean isLayered() {
return layered;
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeRegistry.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeRegistry.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeRegistry.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeRegistry.java Thu Aug 21 14:56:49 2014
@@ -63,7 +63,7 @@ public final class SchemeRegistry {
*
* @param name the name of the scheme to look up (in lowercase)
*
- * @return the scheme, never <code>null</code>
+ * @return the scheme, never {@code null}
*
* @throws IllegalStateException
* if the scheme with the given name is not registered
@@ -79,11 +79,11 @@ public final class SchemeRegistry {
/**
* Obtains the scheme for a host.
- * Convenience method for <code>getScheme(host.getSchemeName())</pre>
+ * Convenience method for {@code getScheme(host.getSchemeName())}
*
- * @param host the host for which to obtain the scheme
+ * @param host the host for which to obtain the scheme
*
- * @return the scheme for the given host, never <code>null</code>
+ * @return the scheme for the given host, never {@code null}
*
* @throws IllegalStateException
* if a scheme with the respective name is not registered
@@ -99,7 +99,7 @@ public final class SchemeRegistry {
* @param name the name of the scheme to look up (in lowercase)
*
* @return the scheme, or
- * <code>null</code> if there is none by this name
+ * {@code null} if there is none by this name
*/
public final Scheme get(final String name) {
Args.notNull(name, "Scheme name");
@@ -117,7 +117,7 @@ public final class SchemeRegistry {
* @param sch the scheme to register
*
* @return the scheme previously registered with that name, or
- * <code>null</code> if none was registered
+ * {@code null} if none was registered
*/
public final Scheme register(final Scheme sch) {
Args.notNull(sch, "Scheme");
@@ -131,7 +131,7 @@ public final class SchemeRegistry {
* @param name the name of the scheme to unregister (in lowercase)
*
* @return the unregistered scheme, or
- * <code>null</code> if there was none
+ * {@code null} if there was none
*/
public final Scheme unregister(final String name) {
Args.notNull(name, "Scheme name");
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java Thu Aug 21 14:56:49 2014
@@ -77,22 +77,22 @@ public interface SchemeSocketFactory {
*
* @param sock the socket to connect, as obtained from
* {@link #createSocket(HttpParams) createSocket}.
- * <code>null</code> indicates that a new socket
+ * {@code null} indicates that a new socket
* should be created and connected.
* @param remoteAddress the remote address to connect to.
* @param localAddress the local address to bind the socket to, or
- * <code>null</code> for any
+ * {@code null} for any
* @param params additional {@link HttpParams parameters} for connecting
*
* @return the connected socket. The returned object may be different
- * from the <code>sock</code> argument if this factory supports
+ * from the {@code sock} argument if this factory supports
* a layered protocol.
*
* @throws IOException if an I/O error occurs
* @throws UnknownHostException if the IP address of the target host
* can not be determined
* @throws ConnectTimeoutException if the socket cannot be connected
- * within the time limit defined in the <code>params</code>
+ * within the time limit defined in the {@code params}
*
* @see org.apache.http.conn.HttpInetSocketAddress
*/
@@ -114,9 +114,9 @@ public interface SchemeSocketFactory {
*
* @param sock the connected socket to check
*
- * @return <code>true</code> if the connection of the socket
+ * @return {@code true} if the connection of the socket
* should be considered secure, or
- * <code>false</code> if it should not
+ * {@code false} if it should not
*
* @throws IllegalArgumentException
* if the argument is invalid, for example because it is
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SocketFactory.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SocketFactory.java Thu Aug 21 14:56:49 2014
@@ -63,25 +63,25 @@ public interface SocketFactory {
*
* @param sock the socket to connect, as obtained from
* {@link #createSocket createSocket}.
- * <code>null</code> indicates that a new socket
+ * {@code null} indicates that a new socket
* should be created and connected.
* @param host the host to connect to
* @param port the port to connect to on the host
* @param localAddress the local address to bind the socket to, or
- * <code>null</code> for any
+ * {@code null} for any
* @param localPort the port on the local machine,
* 0 or a negative number for any
* @param params additional {@link HttpParams parameters} for connecting
*
* @return the connected socket. The returned object may be different
- * from the <code>sock</code> argument if this factory supports
+ * from the {@code sock} argument if this factory supports
* a layered protocol.
*
* @throws IOException if an I/O error occurs
* @throws UnknownHostException if the IP address of the target host
* can not be determined
* @throws ConnectTimeoutException if the socket cannot be connected
- * within the time limit defined in the <code>params</code>
+ * within the time limit defined in the {@code params}
*/
Socket connectSocket(
Socket sock,
@@ -98,7 +98,7 @@ public interface SocketFactory {
* by this factory.
* The factory will <i>not</i> perform I/O operations
* in this method.
- * <br/>
+ * <p>
* As a rule of thumb, plain sockets are not secure and
* TLS/SSL sockets are secure. However, there may be
* application specific deviations. For example, a plain
@@ -106,12 +106,13 @@ public interface SocketFactory {
* could be considered secure. On the other hand, a
* TLS/SSL socket could be considered insecure based on
* the cipher suite chosen for the connection.
+ * </p>
*
* @param sock the connected socket to check
*
- * @return <code>true</code> if the connection of the socket
+ * @return {@code true} if the connection of the socket
* should be considered secure, or
- * <code>false</code> if it should not
+ * {@code false} if it should not
*
* @throws IllegalArgumentException
* if the argument is invalid, for example because it is
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java?rev=1619420&r1=1619419&r2=1619420&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java Thu Aug 21 14:56:49 2014
@@ -57,14 +57,14 @@ public interface ConnectionSocketFactory
*
* @param connectTimeout connect timeout.
* @param sock the socket to connect, as obtained from {@link #createSocket(HttpContext)}.
- * <code>null</code> indicates that a new socket should be created and connected.
+ * {@code null} indicates that a new socket should be created and connected.
* @param host target host as specified by the caller (end user).
* @param remoteAddress the resolved remote address to connect to.
- * @param localAddress the local address to bind the socket to, or <code>null</code> for any.
+ * @param localAddress the local address to bind the socket to, or {@code null} for any.
* @param context the actual HTTP context.
*
* @return the connected socket. The returned object may be different
- * from the <code>sock</code> argument if this factory supports
+ * from the {@code sock} argument if this factory supports
* a layered protocol.
*
* @throws IOException if an I/O error occurs