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

Javadoc fixes for Java 8. Replace "<tt>Foo</tt>" with "{@code Foo}". 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1603933 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2014-06-19 15:45:42 +00:00
parent 3269410866
commit 0700b14d6a
45 changed files with 151 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
httpclient/src/main/java-deprecated/org/apache/http/impl/auth/NegotiateScheme.java
View File

@ -170,7 +170,7 @@ public class NegotiateScheme extends GGSSchemeBase {
* Returns the authentication parameter with the given name, if available.
*
* <p>There are no valid parameters for Negotiate authentication so this
* method always returns <tt>null</tt>.</p>
* method always returns {@code null}.</p>
*
* @param name The name of the parameter to be returned
*
@ -192,10 +192,10 @@ public class NegotiateScheme extends GGSSchemeBase {
}
/**
* Returns <tt>true</tt>.
* Returns {@code true}.
* Negotiate authentication scheme is connection based.
*
* @return <tt>true</tt>.
* @return {@code true}.
*/
public boolean isConnectionBased() {
return true;

6
httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
View File

@ -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 <tt>true</tt> if the scheme is connection based, <tt>false</tt>
* @return {@code true</tt> if the scheme is connection based, <tt>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 <tt>true</tt> if the authentication process has been completed,
* <tt>false</tt> otherwise.
* @return {@code true} if the authentication process has been completed,
* {@code false} otherwise.
*/
boolean isComplete();

18
httpclient/src/main/java/org/apache/http/auth/AuthScope.java
View File

@ -34,7 +34,7 @@ import org.apache.http.util.Args;
import org.apache.http.util.LangUtils;
/**
* <tt>AuthScope</tt> 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.
* <p/>
* 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 <tt>null</tt> 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 <tt>-1</tt> value represents any port.
* The {@code -1} value represents any port.
*/
public static final int ANY_PORT = -1;
/**
* The <tt>null</tt> value represents any realm.
* The {@code null} value represents any realm.
*/
public static final String ANY_REALM = null;
/**
* The <tt>null</tt> 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 <tt>host</tt>, <tt>port</tt>, <tt>realm</tt>, and
* <tt>authentication scheme</tt>.
* Defines auth scope with the given {@code host</tt>, <tt>port</tt>, <tt>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 <tt>host</tt>, <tt>port</tt> and <tt>realm</tt>.
* Defines auth scope with the given {@code host</tt>, <tt>port</tt> and <tt>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 <tt>host</tt> and <tt>port</tt>.
* Defines auth scope with the given {@code host</tt> and <tt>port}.
*
* @param host authentication host. May be {@link #ANY_HOST} if applies
* to any host.

6
httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java
View File

@ -41,7 +41,7 @@ public class AuthenticationException extends ProtocolException {
private static final long serialVersionUID = -6794031905674764776L;
/**
* Creates a new AuthenticationException with a <tt>null</tt> 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 <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public AuthenticationException(final String message, final Throwable cause) {
super(message, cause);

6
httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java
View File

@ -41,7 +41,7 @@ public class InvalidCredentialsException extends AuthenticationException {
private static final long serialVersionUID = -4834003835215460648L;
/**
* Creates a new InvalidCredentialsException with a <tt>null</tt> 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 <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public InvalidCredentialsException(final String message, final Throwable cause) {
super(message, cause);

6
httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java
View File

@ -42,7 +42,7 @@ public class MalformedChallengeException extends ProtocolException {
private static final long serialVersionUID = 814586927989932284L;
/**
* Creates a new MalformedChallengeException with a <tt>null</tt> 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 <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public MalformedChallengeException(final String message, final Throwable cause) {
super(message, cause);

6
httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java
View File

@ -40,7 +40,7 @@ public class CircularRedirectException extends RedirectException {
private static final long serialVersionUID = 6830063487001091803L;
/**
* Creates a new CircularRedirectException with a <tt>null</tt> 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 <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public CircularRedirectException(final String message, final Throwable cause) {
super(message, cause);

2
httpclient/src/main/java/org/apache/http/client/NonRepeatableRequestException.java
View File

@ -42,7 +42,7 @@ public class NonRepeatableRequestException extends ProtocolException {
private static final long serialVersionUID = 82685265288806048L;
/**
* Creates a new NonRepeatableEntityException with a <tt>null</tt> detail message.
* Creates a new NonRepeatableEntityException with a {@code null} detail message.
*/
public NonRepeatableRequestException() {
super();

6
httpclient/src/main/java/org/apache/http/client/RedirectException.java
View File

@ -41,7 +41,7 @@ public class RedirectException extends ProtocolException {
private static final long serialVersionUID = 4418824536372559326L;
/**
* Creates a new RedirectException with a <tt>null</tt> 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 <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public RedirectException(final String message, final Throwable cause) {
super(message, cause);

2
httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java
View File

@ -92,7 +92,7 @@ public class ResponseContentEncoding implements HttpResponseInterceptor {
}
/**
* Handles <tt>gzip</tt> and <tt>deflate</tt> compressed entities by using the following
* Handles {@code gzip</tt> and <tt>deflate} compressed entities by using the following
* decoders:
* <ul>
* <li>gzip - see {@link GZIPInputStream}</li>

2
httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java
View File

@ -50,7 +50,7 @@ public class ConnectTimeoutException extends InterruptedIOException {
private final HttpHost host;
/**
* Creates a ConnectTimeoutException with a <tt>null</tt> detail message.
* Creates a ConnectTimeoutException with a {@code null} detail message.
*/
public ConnectTimeoutException() {
super();

2
httpclient/src/main/java/org/apache/http/conn/ConnectionPoolTimeoutException.java
View File

@ -42,7 +42,7 @@ public class ConnectionPoolTimeoutException extends ConnectTimeoutException {
private static final long serialVersionUID = -7898874842020245128L;
/**
* Creates a ConnectTimeoutException with a <tt>null</tt> detail message.
* Creates a ConnectTimeoutException with a {@code null} detail message.
*/
public ConnectionPoolTimeoutException() {
super();

6
httpclient/src/main/java/org/apache/http/cookie/ClientCookie.java
View File

@ -31,10 +31,10 @@ package org.apache.http.cookie;
* ClientCookie extends the standard {@link Cookie} interface with
* additional client specific functionality such ability to retrieve
* original cookie attributes exactly as they were specified by the
* origin server. This is important for generating the <tt>Cookie</tt>
* origin server. This is important for generating the {@code Cookie}
* header because some cookie specifications require that the
* <tt>Cookie</tt> header should include certain attributes only if
* they were specified in the <tt>Set-Cookie</tt> header.
* {@code Cookie} header should include certain attributes only if
* they were specified in the {@code Set-Cookie} header.
*
*
* @since 4.0

16
httpclient/src/main/java/org/apache/http/cookie/Cookie.java
View File

@ -55,7 +55,7 @@ public interface Cookie {
/**
* Returns the comment describing the purpose of this cookie, or
* <tt>null</tt> if no such comment has been defined.
* {@code null} if no such comment has been defined.
*
* @return comment
*/
@ -68,21 +68,21 @@ public interface Cookie {
String getCommentURL();
/**
* Returns the expiration {@link Date} of the cookie, or <tt>null</tt>
* Returns the expiration {@link Date} of the cookie, or {@code null}
* if none exists.
* <p><strong>Note:</strong> the object returned by this method is
* considered immutable. Changing it (e.g. using setTime()) could result
* in undefined behaviour. Do so at your peril. </p>
* @return Expiration {@link Date}, or <tt>null</tt>.
* @return Expiration {@link Date}, or {@code null}.
*/
Date getExpiryDate();
/**
* Returns <tt>false</tt> if the cookie should be discarded at the end
* of the "session"; <tt>true</tt> otherwise.
* Returns {@code false} if the cookie should be discarded at the end
* of the "session"; {@code true} otherwise.
*
* @return <tt>false</tt> if the cookie should be discarded at the end
* of the "session"; <tt>true</tt> otherwise
* @return {@code false} if the cookie should be discarded at the end
* of the "session"; {@code true} otherwise
*/
boolean isPersistent();
@ -129,7 +129,7 @@ public interface Cookie {
* Returns true if this cookie has expired.
* @param date Current time
*
* @return <tt>true</tt> if the cookie has expired.
* @return {@code true} if the cookie has expired.
*/
boolean isExpired(final Date date);

2
httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java
View File

@ -66,7 +66,7 @@ public interface CookieAttributeHandler {
*
* @param cookie {@link org.apache.http.cookie.Cookie} to match
* @param origin the cookie source to match against
* @return <tt>true</tt> if the match is successful; <tt>false</tt> otherwise
* @return {@code true</tt> if the match is successful; <tt>false} otherwise
*/
boolean match(Cookie cookie, CookieOrigin origin);

2
httpclient/src/main/java/org/apache/http/cookie/CookiePathComparator.java
View File

@ -34,7 +34,7 @@ import org.apache.http.annotation.Immutable;
/**
* This cookie comparator ensures that multiple cookies satisfying
* a common criteria are ordered in the <tt>Cookie</tt> header such
* a common criteria are ordered in the {@code Cookie} header such
* that those with more specific Path attributes precede those with
* less specific.
*

2
httpclient/src/main/java/org/apache/http/cookie/CookieRestrictionViolationException.java
View File

@ -41,7 +41,7 @@ public class CookieRestrictionViolationException extends MalformedCookieExceptio
private static final long serialVersionUID = 7371235577078589013L;
/**
* Creates a new CookeFormatViolationException with a <tt>null</tt> detail
* Creates a new CookeFormatViolationException with a {@code null} detail
* message.
*/
public CookieRestrictionViolationException() {

14
httpclient/src/main/java/org/apache/http/cookie/CookieSpec.java
View File

@ -55,16 +55,16 @@ public interface CookieSpec {
int getVersion();
/**
* Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.
* Parse the {@code "Set-Cookie"} Header into an array of Cookies.
*
* <p>This method will not perform the validation of the resultant
* {@link Cookie}s</p>
*
* @see #validate
*
* @param header the <tt>Set-Cookie</tt> received from the server
* @param header the {@code Set-Cookie} received from the server
* @param origin details of the cookie origin
* @return an array of <tt>Cookie</tt>s parsed from the header
* @return an array of {@code Cookie}s parsed from the header
* @throws MalformedCookieException if an exception occurs during parsing
*/
List<Cookie> parse(Header header, CookieOrigin origin) throws MalformedCookieException;
@ -85,13 +85,13 @@ public interface CookieSpec {
* @param cookie the Cookie to be matched
* @param origin the target to test against
*
* @return <tt>true</tt> if the cookie should be submitted with a request
* with given attributes, <tt>false</tt> otherwise.
* @return {@code true} if the cookie should be submitted with a request
* with given attributes, {@code false} otherwise.
*/
boolean match(Cookie cookie, CookieOrigin origin);
/**
* Create <tt>"Cookie"</tt> headers for an array of Cookies.
* Create {@code "Cookie"} headers for an array of Cookies.
*
* @param cookies the Cookies format into a Cookie header
* @return a Header for the given Cookies.
@ -102,7 +102,7 @@ public interface CookieSpec {
/**
* Returns a request header identifying what version of the state management
* specification is understood. May be <code>null</code> if the cookie
* specification does not support <tt>Cookie2</tt> header.
* specification does not support {@code Cookie2} header.
*/
Header getVersionHeader();

6
httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java
View File

@ -43,7 +43,7 @@ public class MalformedCookieException extends ProtocolException {
private static final long serialVersionUID = -6695462944287282185L;
/**
* Creates a new MalformedCookieException with a <tt>null</tt> detail message.
* Creates a new MalformedCookieException with a {@code null} detail message.
*/
public MalformedCookieException() {
super();
@ -62,8 +62,8 @@ public class MalformedCookieException extends ProtocolException {
* Creates a new MalformedCookieException with the specified detail message and cause.
*
* @param message the exception detail message
* @param cause the <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public MalformedCookieException(final String message, final Throwable cause) {
super(message, cause);

2
httpclient/src/main/java/org/apache/http/cookie/SetCookie.java
View File

@ -84,7 +84,7 @@ public interface SetCookie extends Cookie {
/**
* Sets the secure attribute of the cookie.
* <p>
* When <tt>true</tt> the cookie should only be sent
* When {@code true} the cookie should only be sent
* using a secure protocol (https). This should only be set when
* the cookie's originating server used a secure protocol to set the
* cookie's value.

2
httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java
View File

@ -50,7 +50,7 @@ public interface SetCookie2 extends SetCookie {
/**
* Set the Discard attribute.
*
* Note: <tt>Discard</tt> attribute overrides <tt>Max-age</tt>.
* Note: {@code Discard</tt> attribute overrides <tt>Max-age}.
*
* @see #isPersistent()
*/

2
httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java
View File

@ -59,7 +59,7 @@ public abstract class AuthSchemeBase implements ContextAwareAuthScheme {
private ChallengeState challengeState;
/**
* Creates an instance of <tt>AuthSchemeBase</tt> with the given challenge
* Creates an instance of {@code AuthSchemeBase} with the given challenge
* state.
*
* @since 4.2

12
httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java
View File

@ -67,7 +67,7 @@ public class BasicScheme extends RFC2617Scheme {
}
/**
* Creates an instance of <tt>BasicScheme</tt> with the given challenge
* Creates an instance of {@code BasicScheme} with the given challenge
* state.
*
* @since 4.2
@ -111,8 +111,8 @@ public class BasicScheme extends RFC2617Scheme {
/**
* Tests if the Basic authentication process has been completed.
*
* @return <tt>true</tt> if Basic authorization has been processed,
* <tt>false</tt> otherwise.
* @return {@code true} if Basic authorization has been processed,
* {@code false} otherwise.
*/
@Override
public boolean isComplete() {
@ -120,9 +120,9 @@ public class BasicScheme extends RFC2617Scheme {
}
/**
* Returns <tt>false</tt>. Basic authentication scheme is request based.
* Returns {@code false}. Basic authentication scheme is request based.
*
* @return <tt>false</tt>.
* @return {@code false}.
*/
@Override
public boolean isConnectionBased() {
@ -182,7 +182,7 @@ public class BasicScheme extends RFC2617Scheme {
}
/**
* Returns a basic <tt>Authorization</tt> header value for the given
* Returns a basic {@code Authorization} header value for the given
* {@link Credentials} and charset.
*
* @param credentials The credentials to encode.

10
httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java
View File

@ -110,7 +110,7 @@ public class DigestScheme extends RFC2617Scheme {
}
/**
* Creates an instance of <tt>DigestScheme</tt> with the given challenge
* Creates an instance of {@code DigestScheme} with the given challenge
* state.
*
* @since 4.2
@ -144,8 +144,8 @@ public class DigestScheme extends RFC2617Scheme {
/**
* Tests if the Digest authentication process has been completed.
*
* @return <tt>true</tt> if Digest authorization has been processed,
* <tt>false</tt> otherwise.
* @return {@code true} if Digest authorization has been processed,
* {@code false} otherwise.
*/
@Override
public boolean isComplete() {
@ -168,9 +168,9 @@ public class DigestScheme extends RFC2617Scheme {
}
/**
* Returns <tt>false</tt>. Digest authentication scheme is request based.
* Returns {@code false}. Digest authentication scheme is request based.
*
* @return <tt>false</tt>.
* @return {@code false}.
*/
@Override
public boolean isConnectionBased() {

4
httpclient/src/main/java/org/apache/http/impl/auth/KerberosScheme.java
View File

@ -108,9 +108,9 @@ public class KerberosScheme extends GGSSchemeBase {
}
/**
* Returns <tt>true</tt>. KERBEROS authentication scheme is connection based.
* Returns {@code true}. KERBEROS authentication scheme is connection based.
*
* @return <tt>true</tt>.
* @return {@code true}.
*/
@Override
public boolean isConnectionBased() {

4
httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java
View File

@ -57,8 +57,8 @@ public class NTLMEngineException extends AuthenticationException {
* Creates a new NTLMEngineException with the specified detail message and cause.
*
* @param message the exception detail message
* @param cause the <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public NTLMEngineException(final String message, final Throwable cause) {
super(message, cause);

2
httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java
View File

@ -66,7 +66,7 @@ public abstract class RFC2617Scheme extends AuthSchemeBase implements Serializab
private transient Charset credentialsCharset;
/**
* Creates an instance of <tt>RFC2617Scheme</tt> with the given challenge
* Creates an instance of {@code RFC2617Scheme} with the given challenge
* state.
*
* @since 4.2

4
httpclient/src/main/java/org/apache/http/impl/auth/SPNegoScheme.java
View File

@ -109,9 +109,9 @@ public class SPNegoScheme extends GGSSchemeBase {
}
/**
* Returns <tt>true</tt>. SPNEGO authentication scheme is connection based.
* Returns {@code true}. SPNEGO authentication scheme is connection based.
*
* @return <tt>true</tt>.
* @return {@code true}.
*/
@Override
public boolean isConnectionBased() {

6
httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java
View File

@ -41,7 +41,7 @@ public class UnsupportedDigestAlgorithmException extends RuntimeException {
private static final long serialVersionUID = 319558534317118022L;
/**
* Creates a new UnsupportedAuthAlgoritmException with a <tt>null</tt> detail message.
* Creates a new UnsupportedAuthAlgoritmException with a {@code null} detail message.
*/
public UnsupportedDigestAlgorithmException() {
super();
@ -60,8 +60,8 @@ public class UnsupportedDigestAlgorithmException extends RuntimeException {
* Creates a new UnsupportedAuthAlgoritmException with the specified detail message and cause.
*
* @param message the exception detail message
* @param cause the <tt>Throwable</tt> that caused this exception, or <tt>null</tt>
* if the cause is unavailable, unknown, or not a <tt>Throwable</tt>
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) {
super(message, cause);

4
httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java
View File

@ -58,8 +58,8 @@ import org.apache.http.util.TextUtils;
/**
* Default implementation of {@link RedirectStrategy}. This strategy honors the restrictions
* on automatic redirection of entity enclosing methods such as POST and PUT imposed by the
* HTTP specification. <tt>302 Moved Temporarily</tt>, <tt>301 Moved Permanently</tt> and
* <tt>307 Temporary Redirect</tt> status codes will result in an automatic redirect of
* HTTP specification. {@code 302 Moved Temporarily</tt>, <tt>301 Moved Permanently} and
* {@code 307 Temporary Redirect} status codes will result in an automatic redirect of
* HEAD and GET methods only. POST and PUT methods will not be automatically redirected
* as requiring user confirmation.
* <p/>

2
httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java
View File

@ -415,7 +415,7 @@ public class HttpClientBuilder {
}
/**
* Assigns <tt>User-Agent</tt> value.
* Assigns {@code User-Agent} value.
* <p/>
* Please note this value can be overridden by the {@link #setHttpProcessor(
* org.apache.http.protocol.HttpProcessor)} method.

26
httpclient/src/main/java/org/apache/http/impl/client/RedirectLocations.java
View File

@ -106,7 +106,7 @@ public class RedirectLocations extends AbstractList<Object> {
* @return the URI at the specified position in this list
* @throws IndexOutOfBoundsException
* if the index is out of range (
* <tt>index &lt; 0 || index &gt;= size()</tt>)
* {@code index &lt; 0 || index &gt;= size()})
* @since 4.3
*/
@Override
@ -116,8 +116,8 @@ public class RedirectLocations extends AbstractList<Object> {
/**
* Returns the number of elements in this list. If this list contains more
* than <tt>Integer.MAX_VALUE</tt> elements, returns
* <tt>Integer.MAX_VALUE</tt>.
* than {@code Integer.MAX_VALUE} elements, returns
* {@code Integer.MAX_VALUE}.
*
* @return the number of elements in this list
* @since 4.3
@ -137,7 +137,7 @@ public class RedirectLocations extends AbstractList<Object> {
* URI to be stored at the specified position
* @return the URI previously at the specified position
* @throws UnsupportedOperationException
* if the <tt>set</tt> operation is not supported by this list
* if the {@code set} operation is not supported by this list
* @throws ClassCastException
* if the element is not a {@link URI}
* @throws NullPointerException
@ -145,7 +145,7 @@ public class RedirectLocations extends AbstractList<Object> {
* permit null elements
* @throws IndexOutOfBoundsException
* if the index is out of range (
* <tt>index &lt; 0 || index &gt;= size()</tt>)
* {@code index &lt; 0 || index &gt;= size()})
* @since 4.3
*/
@Override
@ -169,7 +169,7 @@ public class RedirectLocations extends AbstractList<Object> {
* @param element
* URI to be inserted
* @throws UnsupportedOperationException
* if the <tt>add</tt> operation is not supported by this list
* if the {@code add} operation is not supported by this list
* @throws ClassCastException
* if the element is not a {@link URI}
* @throws NullPointerException
@ -177,7 +177,7 @@ public class RedirectLocations extends AbstractList<Object> {
* permit null elements
* @throws IndexOutOfBoundsException
* if the index is out of range (
* <tt>index &lt; 0 || index &gt; size()</tt>)
* {@code index &lt; 0 || index &gt; size()})
* @since 4.3
*/
@Override
@ -196,7 +196,7 @@ public class RedirectLocations extends AbstractList<Object> {
* @return the URI previously at the specified position
* @throws IndexOutOfBoundsException
* if the index is out of range (
* <tt>index &lt; 0 || index &gt;= size()</tt>)
* {@code index &lt; 0 || index &gt;= size()})
* @since 4.3
*/
@Override
@ -210,13 +210,13 @@ public class RedirectLocations extends AbstractList<Object> {
}
/**
* Returns <tt>true</tt> if this collection contains the specified element.
* More formally, returns <tt>true</tt> if and only if this collection
* contains at least one element <tt>e</tt> such that
* <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>.
* Returns {@code true} if this collection contains the specified element.
* More formally, returns {@code true} if and only if this collection
* contains at least one element {@code e} such that
* {@code (o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))}.
*
* @param o element whose presence in this collection is to be tested
* @return <tt>true</tt> if this collection contains the specified
* @return {@code true} if this collection contains the specified
* element
*/
@Override

2
httpclient/src/main/java/org/apache/http/impl/conn/ConnectionShutdownException.java
View File

@ -41,7 +41,7 @@ public class ConnectionShutdownException extends IllegalStateException {
private static final long serialVersionUID = 5868657401162844497L;
/**
* Creates a new ConnectionShutdownException with a <tt>null</tt> detail message.
* Creates a new ConnectionShutdownException with a {@code null} detail message.
*/
public ConnectionShutdownException() {
super();

4
httpclient/src/main/java/org/apache/http/impl/conn/PoolingHttpClientConnectionManager.java
View File

@ -67,14 +67,14 @@ import org.apache.http.util.Args;
import org.apache.http.util.Asserts;
/**
* <tt>ClientConnectionPoolManager</tt> maintains a pool of
* {@code ClientConnectionPoolManager} maintains a pool of
* {@link HttpClientConnection}s and is able to service connection requests
* from multiple execution threads. Connections are pooled on a per route
* basis. A request for a route which already the manager has persistent
* connections for available in the pool will be services by leasing
* a connection from the pool rather than creating a brand new connection.
* <p/>
* <tt>ClientConnectionPoolManager</tt> maintains a maximum limit of connection
* {@code ClientConnectionPoolManager} maintains a maximum limit of connection
* on a per route basis and in total. Per default this implementation will
* create no more than than 2 concurrent connections per given route
* and no more 20 connections in total. For many real-world applications

4
httpclient/src/main/java/org/apache/http/impl/cookie/AbstractCookieSpec.java
View File

@ -69,11 +69,11 @@ public abstract class AbstractCookieSpec implements CookieSpec {
/**
* Finds an attribute handler {@link CookieAttributeHandler} for the
* given attribute. Returns <tt>null</tt> if no attribute handler is
* given attribute. Returns {@code null} if no attribute handler is
* found for the specified attribute.
*
* @param name attribute name. e.g. Domain, Path, etc.
* @return an attribute handler or <tt>null</tt>
* @return an attribute handler or {@code null}
*/
protected CookieAttributeHandler findAttribHandler(final String name) {
return this.attribHandlerMap.get(name);

18
httpclient/src/main/java/org/apache/http/impl/cookie/BasicClientCookie.java
View File

@ -94,7 +94,7 @@ public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable, Se
/**
* Returns the comment describing the purpose of this cookie, or
* <tt>null</tt> if no such comment has been defined.
* {@code null} if no such comment has been defined.
*
* @return comment
*
@ -129,12 +129,12 @@ public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable, Se
/**
* Returns the expiration {@link Date} of the cookie, or <tt>null</tt>
* Returns the expiration {@link Date} of the cookie, or {@code null}
* if none exists.
* <p><strong>Note:</strong> the object returned by this method is
* considered immutable. Changing it (e.g. using setTime()) could result
* in undefined behaviour. Do so at your peril. </p>
* @return Expiration {@link Date}, or <tt>null</tt>.
* @return Expiration {@link Date}, or {@code null}.
*
* @see #setExpiryDate(java.util.Date)
*
@ -162,11 +162,11 @@ public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable, Se
/**
* Returns <tt>false</tt> if the cookie should be discarded at the end
* of the "session"; <tt>true</tt> otherwise.
* Returns {@code false} if the cookie should be discarded at the end
* of the "session"; {@code true} otherwise.
*
* @return <tt>false</tt> if the cookie should be discarded at the end
* of the "session"; <tt>true</tt> otherwise
* @return {@code false} if the cookie should be discarded at the end
* of the "session"; {@code true} otherwise
*/
@Override
public boolean isPersistent() {
@ -240,7 +240,7 @@ public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable, Se
/**
* Sets the secure attribute of the cookie.
* <p>
* When <tt>true</tt> the cookie should only be sent
* When {@code true} the cookie should only be sent
* using a secure protocol (https). This should only be set when
* the cookie's originating server used a secure protocol to set the
* cookie's value.
@ -295,7 +295,7 @@ public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable, Se
* Returns true if this cookie has expired.
* @param date Current time
*
* @return <tt>true</tt> if the cookie has expired.
* @return {@code true} if the cookie has expired.
*/
@Override
public boolean isExpired(final Date date) {

2
httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatVersionAttributeHandler.java
View File

@ -33,7 +33,7 @@ import org.apache.http.cookie.SetCookie;
import org.apache.http.util.Args;
/**
* <tt>"Version"</tt> cookie attribute handler for BrowserCompat cookie spec.
* {@code "Version"} cookie attribute handler for BrowserCompat cookie spec.
*
* @since 4.3
*/

6
httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java
View File

@ -82,7 +82,7 @@ public class NetscapeDraftSpec extends CookieSpecBase {
}
/**
* Parses the Set-Cookie value into an array of <tt>Cookie</tt>s.
* Parses the Set-Cookie value into an array of {@code Cookie}s.
*
* <p>Syntax of the Set-Cookie HTTP Response Header:</p>
*
@ -101,8 +101,8 @@ public class NetscapeDraftSpec extends CookieSpecBase {
* @see <a href="http://web.archive.org/web/20020803110822/http://wp.netscape.com/newsref/std/cookie_spec.html">
* The Cookie Spec.</a>
*
* @param header the <tt>Set-Cookie</tt> received from the server
* @return an array of <tt>Cookie</tt>s parsed from the Set-Cookie value
* @param header the {@code Set-Cookie} received from the server
* @return an array of {@code Cookie}s parsed from the Set-Cookie value
* @throws MalformedCookieException if an exception occurs during parsing
*/
@Override

4
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java
View File

@ -177,7 +177,7 @@ public class RFC2109Spec extends CookieSpecBase {
}
/**
* Return a name/value string suitable for sending in a <tt>"Cookie"</tt>
* Return a name/value string suitable for sending in a {@code "Cookie"}
* header as defined in RFC 2109 for backward compatibility with cookie
* version 0
* @param buffer The char array buffer to use for output
@ -201,7 +201,7 @@ public class RFC2109Spec extends CookieSpecBase {
}
/**
* Return a string suitable for sending in a <tt>"Cookie"</tt> header
* Return a string suitable for sending in a {@code "Cookie"} header
* as defined in RFC 2109 for backward compatibility with cookie version 0
* @param buffer The char array buffer to use for output
* @param cookie The {@link Cookie} to be formatted as string

2
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965CommentUrlAttributeHandler.java
View File

@ -36,7 +36,7 @@ import org.apache.http.cookie.SetCookie;
import org.apache.http.cookie.SetCookie2;
/**
* <tt>"CommentURL"</tt> cookie attribute handler for RFC 2965 cookie spec.
* {@code "CommentURL"} cookie attribute handler for RFC 2965 cookie spec.
*
* @since 4.0
*/

2
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965DiscardAttributeHandler.java
View File

@ -36,7 +36,7 @@ import org.apache.http.cookie.SetCookie;
import org.apache.http.cookie.SetCookie2;
/**
* <tt>"Discard"</tt> cookie attribute handler for RFC 2965 cookie spec.
* {@code "Discard"} cookie attribute handler for RFC 2965 cookie spec.
*
* @since 4.0
*/

2
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965DomainAttributeHandler.java
View File

@ -40,7 +40,7 @@ import org.apache.http.cookie.SetCookie;
import org.apache.http.util.Args;
/**
* <tt>"Domain"</tt> cookie attribute handler for RFC 2965 cookie spec.
* {@code "Domain"} cookie attribute handler for RFC 2965 cookie spec.
*
*
* @since 3.1

8
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965PortAttributeHandler.java
View File

@ -41,7 +41,7 @@ import org.apache.http.cookie.SetCookie2;
import org.apache.http.util.Args;
/**
* <tt>"Port"</tt> cookie attribute handler for RFC 2965 cookie spec.
* {@code "Port"} cookie attribute handler for RFC 2965 cookie spec.
*
* @since 4.0
*/
@ -82,13 +82,13 @@ public class RFC2965PortAttributeHandler implements CookieAttributeHandler {
}
/**
* Returns <tt>true</tt> if the given port exists in the given
* Returns {@code true} if the given port exists in the given
* ports list.
*
* @param port port of host where cookie was received from or being sent to.
* @param ports port list
* @return true returns <tt>true</tt> if the given port exists in
* the given ports list; <tt>false</tt> otherwise.
* @return true returns {@code true} if the given port exists in
* the given ports list; {@code false} otherwise.
*/
private static boolean portMatch(final int port, final int[] ports) {
boolean portInList = false;

2
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965VersionAttributeHandler.java
View File

@ -39,7 +39,7 @@ import org.apache.http.cookie.SetCookie2;
import org.apache.http.util.Args;
/**
* <tt>"Version"</tt> cookie attribute handler for RFC 2965 cookie spec.
* {@code "Version"} cookie attribute handler for RFC 2965 cookie spec.
*
* @since 4.0
*/

50
httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java
View File

@ -46,7 +46,7 @@ import org.junit.Test;
public class TestCookieRFC2965Spec {
/**
* Test parsing cookie <tt>"Path"</tt> attribute.
* Test parsing cookie {@code "Path"} attribute.
*/
@Test
public void testParsePath() throws Exception {
@ -103,7 +103,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test parsing cookie <tt>"Domain"</tt> attribute.
* Test parsing cookie {@code "Domain"} attribute.
*/
@Test
public void testParseDomain() throws Exception {
@ -169,7 +169,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test parsing cookie <tt>"Port"</tt> attribute.
* Test parsing cookie {@code "Port"} attribute.
*/
@Test
public void testParsePort() throws Exception {
@ -280,7 +280,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test parsing cookie <tt>"Version"</tt> attribute.
* test parsing cookie {@code "Version"} attribute.
*/
@Test
public void testParseVersion() throws Exception {
@ -322,7 +322,7 @@ public class TestCookieRFC2965Spec {
}
}
/**
* test parsing cookie <tt>"Max-age"</tt> attribute.
* test parsing cookie {@code "Max-age"} attribute.
*/
@Test
public void testParseMaxage() throws Exception {
@ -377,7 +377,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test parsing <tt>"Secure"</tt> attribute.
* test parsing {@code "Secure"} attribute.
*/
@Test
public void testParseSecure() throws Exception {
@ -392,7 +392,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test parsing <tt>"Discard"</tt> attribute.
* test parsing {@code "Discard"} attribute.
*/
@Test
public void testParseDiscard() throws Exception {
@ -416,8 +416,8 @@ public class TestCookieRFC2965Spec {
}
/**
* test parsing <tt>"Comment"</tt>, <tt>"CommentURL"</tt> and
* <tt>"Secure"</tt> attributes.
* test parsing {@code "Comment"</tt>, <tt>"CommentURL"} and
* {@code "Secure"} attributes.
*/
@Test
public void testParseOtherAttributes() throws Exception {
@ -462,8 +462,8 @@ public class TestCookieRFC2965Spec {
// ------------------------------------------------------- Test Cookie Validation
/**
* Test <tt>Domain</tt> validation when domain is not specified
* in <tt>Set-Cookie2</tt> header.
* Test {@code Domain} validation when domain is not specified
* in {@code Set-Cookie2} header.
*/
@Test
public void testValidateNoDomain() throws Exception {
@ -482,7 +482,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test <tt>Domain</tt> validation. Cookie domain attribute must have a
* Test {@code Domain} validation. Cookie domain attribute must have a
* leading dot.
*/
@Test
@ -501,7 +501,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test <tt>Domain</tt> validation. Domain must have at least one embedded dot.
* Test {@code Domain} validation. Domain must have at least one embedded dot.
*/
@Test
public void testValidateDomainEmbeddedDot() throws Exception {
@ -527,7 +527,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test local <tt>Domain</tt> validation. Simple host names
* Test local {@code Domain} validation. Simple host names
* (without any dots) are valid only when cookie domain is specified
* as ".local".
*/
@ -574,7 +574,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test <tt>Domain</tt> validation. Effective host name
* Test {@code Domain} validation. Effective host name
* must domain-match domain attribute.
*/
@Test
@ -604,7 +604,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test local <tt>Domain</tt> validation.
* Test local {@code Domain} validation.
* Effective host name minus domain must not contain any dots.
*/
@Test
@ -622,7 +622,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test cookie <tt>Path</tt> validation. Cookie path attribute must path-match
* Test cookie {@code Path} validation. Cookie path attribute must path-match
* request path.
*/
@Test
@ -698,7 +698,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test cookie <tt>Port</tt> validation. Request port must be in the
* Test cookie {@code Port} validation. Request port must be in the
* port attribute list.
*/
@Test
@ -731,7 +731,7 @@ public class TestCookieRFC2965Spec {
}
/**
* Test cookie <tt>Version</tt> validation.
* Test cookie {@code Version} validation.
*/
@Test
public void testValidateVersion() throws Exception {
@ -751,7 +751,7 @@ public class TestCookieRFC2965Spec {
// ------------------------------------------------------- Test Cookie Matching
/**
* test cookie <tt>Path</tt> matching. Cookie path attribute must path-match
* test cookie {@code Path} matching. Cookie path attribute must path-match
* path of the request URI.
*/
@Test
@ -768,7 +768,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test cookie <tt>Domain</tt> matching.
* test cookie {@code Domain} matching.
*/
@Test
public void testMatchDomain() throws Exception {
@ -789,7 +789,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test cookie local <tt>Domain</tt> matching.
* test cookie local {@code Domain} matching.
*/
@Test
public void testMatchDomainLocal() throws Exception {
@ -805,7 +805,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test cookie <tt>Port</tt> matching.
* test cookie {@code Port} matching.
*/
@Test
public void testMatchPort() throws Exception {
@ -865,7 +865,7 @@ public class TestCookieRFC2965Spec {
}
/**
* test cookie <tt>Secure</tt> attribute.
* test cookie {@code Secure} attribute.
*/
@Test
public void testCookieSecure() throws Exception {
@ -996,7 +996,7 @@ public class TestCookieRFC2965Spec {
// ------------------------------------------------------- Backward compatibility tests
/**
* Test rejection of <tt>Set-Cookie</tt> header.
* Test rejection of {@code Set-Cookie} header.
*/
@Test
public void testRejectSetCookie() throws Exception {