From 0700b14d6af0615b9bdaffe40482b3fe05e4441d Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Thu, 19 Jun 2014 15:45:42 +0000 Subject: [PATCH] Javadoc fixes for Java 8. Replace "Foo" with "{@code Foo}". git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1603933 13f79535-47bb-0310-9956-ffa450edef68 --- .../http/impl/auth/NegotiateScheme.java | 6 +-- .../java/org/apache/http/auth/AuthScheme.java | 6 +-- .../java/org/apache/http/auth/AuthScope.java | 18 +++---- .../http/auth/AuthenticationException.java | 6 +-- .../auth/InvalidCredentialsException.java | 6 +-- .../auth/MalformedChallengeException.java | 6 +-- .../client/CircularRedirectException.java | 6 +-- .../client/NonRepeatableRequestException.java | 2 +- .../apache/http/client/RedirectException.java | 6 +-- .../protocol/ResponseContentEncoding.java | 2 +- .../http/conn/ConnectTimeoutException.java | 2 +- .../conn/ConnectionPoolTimeoutException.java | 2 +- .../org/apache/http/cookie/ClientCookie.java | 6 +-- .../java/org/apache/http/cookie/Cookie.java | 16 +++--- .../http/cookie/CookieAttributeHandler.java | 2 +- .../http/cookie/CookiePathComparator.java | 2 +- .../CookieRestrictionViolationException.java | 2 +- .../org/apache/http/cookie/CookieSpec.java | 14 +++--- .../http/cookie/MalformedCookieException.java | 6 +-- .../org/apache/http/cookie/SetCookie.java | 2 +- .../org/apache/http/cookie/SetCookie2.java | 2 +- .../apache/http/impl/auth/AuthSchemeBase.java | 2 +- .../apache/http/impl/auth/BasicScheme.java | 12 ++--- .../apache/http/impl/auth/DigestScheme.java | 10 ++-- .../apache/http/impl/auth/KerberosScheme.java | 4 +- .../http/impl/auth/NTLMEngineException.java | 4 +- .../apache/http/impl/auth/RFC2617Scheme.java | 2 +- .../apache/http/impl/auth/SPNegoScheme.java | 4 +- .../UnsupportedDigestAlgorithmException.java | 6 +-- .../impl/client/DefaultRedirectStrategy.java | 4 +- .../http/impl/client/HttpClientBuilder.java | 2 +- .../http/impl/client/RedirectLocations.java | 26 +++++----- .../conn/ConnectionShutdownException.java | 2 +- .../PoolingHttpClientConnectionManager.java | 4 +- .../http/impl/cookie/AbstractCookieSpec.java | 4 +- .../http/impl/cookie/BasicClientCookie.java | 18 +++---- .../BrowserCompatVersionAttributeHandler.java | 2 +- .../http/impl/cookie/NetscapeDraftSpec.java | 6 +-- .../apache/http/impl/cookie/RFC2109Spec.java | 4 +- .../RFC2965CommentUrlAttributeHandler.java | 2 +- .../RFC2965DiscardAttributeHandler.java | 2 +- .../cookie/RFC2965DomainAttributeHandler.java | 2 +- .../cookie/RFC2965PortAttributeHandler.java | 8 +-- .../RFC2965VersionAttributeHandler.java | 2 +- .../impl/cookie/TestCookieRFC2965Spec.java | 50 +++++++++---------- 45 files changed, 151 insertions(+), 151 deletions(-) diff --git a/httpclient/src/main/java-deprecated/org/apache/http/impl/auth/NegotiateScheme.java b/httpclient/src/main/java-deprecated/org/apache/http/impl/auth/NegotiateScheme.java index 6711c8af0..156da76cc 100644 --- a/httpclient/src/main/java-deprecated/org/apache/http/impl/auth/NegotiateScheme.java +++ b/httpclient/src/main/java-deprecated/org/apache/http/impl/auth/NegotiateScheme.java @@ -170,7 +170,7 @@ public class NegotiateScheme extends GGSSchemeBase { * Returns the authentication parameter with the given name, if available. * *

There are no valid parameters for Negotiate authentication so this - * method always returns null.

+ * method always returns {@code null}.

* * @param name The name of the parameter to be returned * @@ -192,10 +192,10 @@ public class NegotiateScheme extends GGSSchemeBase { } /** - * Returns true. + * Returns {@code true}. * Negotiate authentication scheme is connection based. * - * @return true. + * @return {@code true}. */ public boolean isConnectionBased() { return true; diff --git a/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java b/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java index e9d4ae239..6b5cb6128 100644 --- a/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java +++ b/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java @@ -95,7 +95,7 @@ public interface AuthScheme { * Tests if the authentication scheme is provides authorization on a per * connection basis instead of usual per request basis * - * @return true if the scheme is connection based, false + * @return {@code true if the scheme is connection based, false} * if the scheme is request based. */ boolean isConnectionBased(); @@ -106,8 +106,8 @@ public interface AuthScheme { * successfully or unsuccessfully, that is, all the required authorization * challenges have been processed in their entirety. * - * @return true if the authentication process has been completed, - * false otherwise. + * @return {@code true} if the authentication process has been completed, + * {@code false} otherwise. */ boolean isComplete(); diff --git a/httpclient/src/main/java/org/apache/http/auth/AuthScope.java b/httpclient/src/main/java/org/apache/http/auth/AuthScope.java index c3c7f85e7..9a8d50058 100644 --- a/httpclient/src/main/java/org/apache/http/auth/AuthScope.java +++ b/httpclient/src/main/java/org/apache/http/auth/AuthScope.java @@ -34,7 +34,7 @@ import org.apache.http.util.Args; import org.apache.http.util.LangUtils; /** - * AuthScope represents an authentication scope consisting of a host name, + * {@code AuthScope} represents an authentication scope consisting of a host name, * a port number, a realm name and an authentication scheme name. *

* This class can also optionally contain a host of origin, if created in response @@ -46,23 +46,23 @@ import org.apache.http.util.LangUtils; public class AuthScope { /** - * The null value represents any host. In the future versions of + * The {@code null} value represents any host. In the future versions of * HttpClient the use of this parameter will be discontinued. */ public static final String ANY_HOST = null; /** - * The -1 value represents any port. + * The {@code -1} value represents any port. */ public static final int ANY_PORT = -1; /** - * The null value represents any realm. + * The {@code null} value represents any realm. */ public static final String ANY_REALM = null; /** - * The null value represents any authentication scheme. + * The {@code null} value represents any authentication scheme. */ public static final String ANY_SCHEME = null; @@ -89,8 +89,8 @@ public class AuthScope { private final HttpHost origin; /** - * Defines auth scope with the given host, port, realm, and - * authentication scheme. + * Defines auth scope with the given {@code host, port, realm}, and + * {@code authentication scheme}. * * @param host authentication host. May be {@link #ANY_HOST} if applies * to any host. @@ -148,7 +148,7 @@ public class AuthScope { } /** - * Defines auth scope with the given host, port and realm. + * Defines auth scope with the given {@code host, port and realm}. * * @param host authentication host. May be {@link #ANY_HOST} if applies * to any host. @@ -162,7 +162,7 @@ public class AuthScope { } /** - * Defines auth scope with the given host and port. + * Defines auth scope with the given {@code host and port}. * * @param host authentication host. May be {@link #ANY_HOST} if applies * to any host. diff --git a/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java b/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java index cd59d9e53..5c2f716a3 100644 --- a/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java +++ b/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java @@ -41,7 +41,7 @@ public class AuthenticationException extends ProtocolException { private static final long serialVersionUID = -6794031905674764776L; /** - * Creates a new AuthenticationException with a null detail message. + * Creates a new AuthenticationException with a {@code null} detail message. */ public AuthenticationException() { super(); @@ -60,8 +60,8 @@ public class AuthenticationException extends ProtocolException { * Creates a new AuthenticationException with the specified detail message and cause. * * @param message the exception detail message - * @param cause the Throwable that caused this exception, or null - * if the cause is unavailable, unknown, or not a Throwable + * @param cause the {@code Throwable that caused this exception, or null} + * if the cause is unavailable, unknown, or not a {@code Throwable} */ public AuthenticationException(final String message, final Throwable cause) { super(message, cause); diff --git a/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java b/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java index a110a18a7..ee5e9a776 100644 --- a/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java +++ b/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java @@ -41,7 +41,7 @@ public class InvalidCredentialsException extends AuthenticationException { private static final long serialVersionUID = -4834003835215460648L; /** - * Creates a new InvalidCredentialsException with a null detail message. + * Creates a new InvalidCredentialsException with a {@code null} detail message. */ public InvalidCredentialsException() { super(); @@ -60,8 +60,8 @@ public class InvalidCredentialsException extends AuthenticationException { * Creates a new InvalidCredentialsException with the specified detail message and cause. * * @param message the exception detail message - * @param cause the Throwable that caused this exception, or null - * if the cause is unavailable, unknown, or not a Throwable + * @param cause the {@code Throwable that caused this exception, or null} + * if the cause is unavailable, unknown, or not a {@code Throwable} */ public InvalidCredentialsException(final String message, final Throwable cause) { super(message, cause); diff --git a/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java b/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java index 1fa538374..ac1e01305 100644 --- a/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java +++ b/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java @@ -42,7 +42,7 @@ public class MalformedChallengeException extends ProtocolException { private static final long serialVersionUID = 814586927989932284L; /** - * Creates a new MalformedChallengeException with a null detail message. + * Creates a new MalformedChallengeException with a {@code null} detail message. */ public MalformedChallengeException() { super(); @@ -61,8 +61,8 @@ public class MalformedChallengeException extends ProtocolException { * Creates a new MalformedChallengeException with the specified detail message and cause. * * @param message the exception detail message - * @param cause the Throwable that caused this exception, or null - * if the cause is unavailable, unknown, or not a Throwable + * @param cause the {@code Throwable that caused this exception, or null} + * if the cause is unavailable, unknown, or not a {@code Throwable} */ public MalformedChallengeException(final String message, final Throwable cause) { super(message, cause); diff --git a/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java b/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java index c88e10c6a..5e40924eb 100644 --- a/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java +++ b/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java @@ -40,7 +40,7 @@ public class CircularRedirectException extends RedirectException { private static final long serialVersionUID = 6830063487001091803L; /** - * Creates a new CircularRedirectException with a null detail message. + * Creates a new CircularRedirectException with a {@code null} detail message. */ public CircularRedirectException() { super(); @@ -59,8 +59,8 @@ public class CircularRedirectException extends RedirectException { * Creates a new CircularRedirectException with the specified detail message and cause. * * @param message the exception detail message - * @param cause the Throwable that caused this exception, or null - * if the cause is unavailable, unknown, or not a Throwable + * @param cause the {@code Throwable that caused this exception, or null} + * if the cause is unavailable, unknown, or not a {@code Throwable} */ public CircularRedirectException(final String message, final Throwable cause) { super(message, cause); diff --git a/httpclient/src/main/java/org/apache/http/client/NonRepeatableRequestException.java b/httpclient/src/main/java/org/apache/http/client/NonRepeatableRequestException.java index 342126fcc..4f4befb2c 100644 --- a/httpclient/src/main/java/org/apache/http/client/NonRepeatableRequestException.java +++ b/httpclient/src/main/java/org/apache/http/client/NonRepeatableRequestException.java @@ -42,7 +42,7 @@ public class NonRepeatableRequestException extends ProtocolException { private static final long serialVersionUID = 82685265288806048L; /** - * Creates a new NonRepeatableEntityException with a null detail message. + * Creates a new NonRepeatableEntityException with a {@code null} detail message. */ public NonRepeatableRequestException() { super(); diff --git a/httpclient/src/main/java/org/apache/http/client/RedirectException.java b/httpclient/src/main/java/org/apache/http/client/RedirectException.java index c2b3ba987..866bfcac2 100644 --- a/httpclient/src/main/java/org/apache/http/client/RedirectException.java +++ b/httpclient/src/main/java/org/apache/http/client/RedirectException.java @@ -41,7 +41,7 @@ public class RedirectException extends ProtocolException { private static final long serialVersionUID = 4418824536372559326L; /** - * Creates a new RedirectException with a null detail message. + * Creates a new RedirectException with a {@code null} detail message. */ public RedirectException() { super(); @@ -60,8 +60,8 @@ public class RedirectException extends ProtocolException { * Creates a new RedirectException with the specified detail message and cause. * * @param message the exception detail message - * @param cause the Throwable that caused this exception, or null - * if the cause is unavailable, unknown, or not a Throwable + * @param cause the {@code Throwable that caused this exception, or null} + * if the cause is unavailable, unknown, or not a {@code Throwable} */ public RedirectException(final String message, final Throwable cause) { super(message, cause); diff --git a/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java b/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java index 91a4441de..d9f87d739 100644 --- a/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java +++ b/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java @@ -92,7 +92,7 @@ public class ResponseContentEncoding implements HttpResponseInterceptor { } /** - * Handles gzip and deflate compressed entities by using the following + * Handles {@code gzip and deflate} compressed entities by using the following * decoders: *