Javadoc fixes.
git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1612086 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
ca956c1b90
commit
9e4c8332f8
|
@ -95,7 +95,7 @@ public interface AuthScheme {
|
||||||
* Tests if the authentication scheme is provides authorization on a per
|
* Tests if the authentication scheme is provides authorization on a per
|
||||||
* connection basis instead of usual per request basis
|
* connection basis instead of usual per request basis
|
||||||
*
|
*
|
||||||
* @return {@code true</tt> if the scheme is connection based, <tt>false}
|
* @return {@code true} if the scheme is connection based, {@code false}
|
||||||
* if the scheme is request based.
|
* if the scheme is request based.
|
||||||
*/
|
*/
|
||||||
boolean isConnectionBased();
|
boolean isConnectionBased();
|
||||||
|
|
|
@ -89,7 +89,7 @@ public class AuthScope {
|
||||||
private final HttpHost origin;
|
private final HttpHost origin;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines auth scope with the given {@code host</tt>, <tt>port</tt>, <tt>realm}, and
|
* Defines auth scope with the given {@code host}, {@code port}, {@code realm}, and
|
||||||
* {@code authentication scheme}.
|
* {@code authentication scheme}.
|
||||||
*
|
*
|
||||||
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
||||||
|
@ -148,7 +148,7 @@ public class AuthScope {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines auth scope with the given {@code host</tt>, <tt>port</tt> and <tt>realm}.
|
* Defines auth scope with the given {@code host}, {@code port} and {@code realm}.
|
||||||
*
|
*
|
||||||
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
||||||
* to any host.
|
* to any host.
|
||||||
|
@ -162,7 +162,7 @@ public class AuthScope {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines auth scope with the given {@code host</tt> and <tt>port}.
|
* Defines auth scope with the given {@code host} and {@code port}.
|
||||||
*
|
*
|
||||||
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
* @param host authentication host. May be {@link #ANY_HOST} if applies
|
||||||
* to any host.
|
* to any host.
|
||||||
|
|
|
@ -60,7 +60,7 @@ public class AuthenticationException extends ProtocolException {
|
||||||
* Creates a new AuthenticationException with the specified detail message and cause.
|
* Creates a new AuthenticationException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public AuthenticationException(final String message, final Throwable cause) {
|
public AuthenticationException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -60,7 +60,7 @@ public class InvalidCredentialsException extends AuthenticationException {
|
||||||
* Creates a new InvalidCredentialsException with the specified detail message and cause.
|
* Creates a new InvalidCredentialsException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public InvalidCredentialsException(final String message, final Throwable cause) {
|
public InvalidCredentialsException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -61,7 +61,7 @@ public class MalformedChallengeException extends ProtocolException {
|
||||||
* Creates a new MalformedChallengeException with the specified detail message and cause.
|
* Creates a new MalformedChallengeException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public MalformedChallengeException(final String message, final Throwable cause) {
|
public MalformedChallengeException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -59,7 +59,7 @@ public class CircularRedirectException extends RedirectException {
|
||||||
* Creates a new CircularRedirectException with the specified detail message and cause.
|
* Creates a new CircularRedirectException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public CircularRedirectException(final String message, final Throwable cause) {
|
public CircularRedirectException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -60,7 +60,7 @@ public class RedirectException extends ProtocolException {
|
||||||
* Creates a new RedirectException with the specified detail message and cause.
|
* Creates a new RedirectException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public RedirectException(final String message, final Throwable cause) {
|
public RedirectException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -92,7 +92,7 @@ public class ResponseContentEncoding implements HttpResponseInterceptor {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles {@code gzip</tt> and <tt>deflate} compressed entities by using the following
|
* Handles {@code gzip} and {@code deflate} compressed entities by using the following
|
||||||
* decoders:
|
* decoders:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>gzip - see {@link GZIPInputStream}</li>
|
* <li>gzip - see {@link GZIPInputStream}</li>
|
||||||
|
|
|
@ -66,7 +66,7 @@ public interface CookieAttributeHandler {
|
||||||
*
|
*
|
||||||
* @param cookie {@link org.apache.http.cookie.Cookie} to match
|
* @param cookie {@link org.apache.http.cookie.Cookie} to match
|
||||||
* @param origin the cookie source to match against
|
* @param origin the cookie source to match against
|
||||||
* @return {@code true</tt> if the match is successful; <tt>false} otherwise
|
* @return {@code true} if the match is successful; {@code false} otherwise
|
||||||
*/
|
*/
|
||||||
boolean match(Cookie cookie, CookieOrigin origin);
|
boolean match(Cookie cookie, CookieOrigin origin);
|
||||||
|
|
||||||
|
|
|
@ -62,7 +62,7 @@ public class MalformedCookieException extends ProtocolException {
|
||||||
* Creates a new MalformedCookieException with the specified detail message and cause.
|
* Creates a new MalformedCookieException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public MalformedCookieException(final String message, final Throwable cause) {
|
public MalformedCookieException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -50,7 +50,7 @@ public interface SetCookie2 extends SetCookie {
|
||||||
/**
|
/**
|
||||||
* Set the Discard attribute.
|
* Set the Discard attribute.
|
||||||
*
|
*
|
||||||
* Note: {@code Discard</tt> attribute overrides <tt>Max-age}.
|
* Note: {@code Discard} attribute overrides {@code Max-age}.
|
||||||
*
|
*
|
||||||
* @see #isPersistent()
|
* @see #isPersistent()
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -57,7 +57,7 @@ public class NTLMEngineException extends AuthenticationException {
|
||||||
* Creates a new NTLMEngineException with the specified detail message and cause.
|
* Creates a new NTLMEngineException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public NTLMEngineException(final String message, final Throwable cause) {
|
public NTLMEngineException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -60,7 +60,7 @@ public class UnsupportedDigestAlgorithmException extends RuntimeException {
|
||||||
* Creates a new UnsupportedAuthAlgoritmException with the specified detail message and cause.
|
* Creates a new UnsupportedAuthAlgoritmException with the specified detail message and cause.
|
||||||
*
|
*
|
||||||
* @param message the exception detail message
|
* @param message the exception detail message
|
||||||
* @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
|
* @param cause the {@code Throwable} that caused this exception, or {@code null}
|
||||||
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
* if the cause is unavailable, unknown, or not a {@code Throwable}
|
||||||
*/
|
*/
|
||||||
public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) {
|
public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) {
|
||||||
|
|
|
@ -58,7 +58,7 @@ import org.apache.http.util.TextUtils;
|
||||||
/**
|
/**
|
||||||
* Default implementation of {@link RedirectStrategy}. This strategy honors the restrictions
|
* 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
|
* on automatic redirection of entity enclosing methods such as POST and PUT imposed by the
|
||||||
* HTTP specification. {@code 302 Moved Temporarily</tt>, <tt>301 Moved Permanently} and
|
* HTTP specification. {@code 302 Moved Temporarily}, {@code 301 Moved Permanently} and
|
||||||
* {@code 307 Temporary Redirect} status codes will result in an automatic redirect of
|
* {@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
|
* HEAD and GET methods only. POST and PUT methods will not be automatically redirected
|
||||||
* as requiring user confirmation.
|
* as requiring user confirmation.
|
||||||
|
|
|
@ -416,7 +416,7 @@ public class TestCookieRFC2965Spec {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* test parsing {@code "Comment"</tt>, <tt>"CommentURL"} and
|
* test parsing {@code "Comment"}, {@code "CommentURL"} and
|
||||||
* {@code "Secure"} attributes.
|
* {@code "Secure"} attributes.
|
||||||
*/
|
*/
|
||||||
@Test
|
@Test
|
||||||
|
|
Loading…
Reference in New Issue