Javadoc 8 fixes.

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1619405 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2014-08-21 14:19:59 +00:00
parent 4007c05f9b
commit c76412a839
11 changed files with 19 additions and 14 deletions

View File

@ -52,10 +52,11 @@ public interface RequestDirector {
/** /**
* Executes a request. * Executes a request.
* <br/><b>Note:</b> * <p>
* For the time being, a new director is instantiated for each request. * <b>Note:</b> For the time being, a new director is instantiated for each request.
* This is the same behavior as for <code>HttpMethodDirector</code> * This is the same behavior as for <code>HttpMethodDirector</code>
* in HttpClient 3. * in HttpClient 3.
* </p>
* *
* @param target the target host for the request. * @param target the target host for the request.
* Implementations may accept <code>null</code> * Implementations may accept <code>null</code>

View File

@ -52,7 +52,7 @@ public interface UserTokenHandler {
* @param context the execution context * @param context the execution context
* *
* @return user token that uniquely identifies the user or * @return user token that uniquely identifies the user or
* <code>null</null> if the context is not user specific. * {@code null} if the context is not user specific.
*/ */
Object getUserToken(HttpContext context); Object getUserToken(HttpContext context);

View File

@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe;
* <p> * <p>
* The HTTP GET method is defined in section 9.3 of * The HTTP GET method is defined in section 9.3 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The GET method means retrieve whatever information (in the form of an * The GET method means retrieve whatever information (in the form of an
* entity) is identified by the Request-URI. If the Request-URI refers * entity) is identified by the Request-URI. If the Request-URI refers
@ -43,7 +44,6 @@ import org.apache.http.annotation.NotThreadSafe;
* returned as the entity in the response and not the source text of the * returned as the entity in the response and not the source text of the
* process, unless that text happens to be the output of the process. * process, unless that text happens to be the output of the process.
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe;
* <p> * <p>
* The HTTP HEAD method is defined in section 9.4 of * The HTTP HEAD method is defined in section 9.4 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The HEAD method is identical to GET except that the server MUST NOT * The HEAD method is identical to GET except that the server MUST NOT
* return a message-body in the response. The metainformation contained * return a message-body in the response. The metainformation contained
@ -46,7 +47,6 @@ import org.apache.http.annotation.NotThreadSafe;
* often used for testing hypertext links for validity, accessibility, * often used for testing hypertext links for validity, accessibility,
* and recent modification. * and recent modification.
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -43,6 +43,7 @@ import org.apache.http.util.Args;
* <p> * <p>
* The HTTP OPTIONS method is defined in section 9.2 of * The HTTP OPTIONS method is defined in section 9.2 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The OPTIONS method represents a request for information about the * The OPTIONS method represents a request for information about the
* communication options available on the request/response chain * communication options available on the request/response chain
@ -51,7 +52,6 @@ import org.apache.http.util.Args;
* or the capabilities of a server, without implying a resource action * or the capabilities of a server, without implying a resource action
* or initiating a resource retrieval. * or initiating a resource retrieval.
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -35,7 +35,9 @@ import org.apache.http.annotation.NotThreadSafe;
* HTTP PATCH method. * HTTP PATCH method.
* <p> * <p>
* The HTTP PATCH method is defined in <a * The HTTP PATCH method is defined in <a
* href="http://tools.ietf.org/html/rfc5789">RF5789</a>: <blockquote> The PATCH * href="http://tools.ietf.org/html/rfc5789">RF5789</a>:
* </p>
* <blockquote> The PATCH
* method requests that a set of changes described in the request entity be * method requests that a set of changes described in the request entity be
* applied to the resource identified by the Request- URI. Differs from the PUT * applied to the resource identified by the Request- URI. Differs from the PUT
* method in the way the server processes the enclosed entity to modify the * method in the way the server processes the enclosed entity to modify the
@ -43,8 +45,8 @@ import org.apache.http.annotation.NotThreadSafe;
* origin server, and the client is requesting that the stored version be * origin server, and the client is requesting that the stored version be
* replaced. With PATCH, however, the enclosed entity contains a set of * replaced. With PATCH, however, the enclosed entity contains a set of
* instructions describing how a resource currently residing on the origin * instructions describing how a resource currently residing on the origin
* server should be modified to produce a new version. </blockquote> * server should be modified to produce a new version.
* </p> * </blockquote>
* *
* @since 4.2 * @since 4.2
*/ */

View File

@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe;
* <p> * <p>
* The HTTP POST method is defined in section 9.5 of * The HTTP POST method is defined in section 9.5 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The POST method is used to request that the origin server accept the entity * The POST method is used to request that the origin server accept the entity
* enclosed in the request as a new subordinate of the resource identified by * enclosed in the request as a new subordinate of the resource identified by
@ -50,7 +51,6 @@ import org.apache.http.annotation.NotThreadSafe;
* <li>Extending a database through an append operation</li> * <li>Extending a database through an append operation</li>
* </ul> * </ul>
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -36,13 +36,13 @@ import org.apache.http.annotation.NotThreadSafe;
* <p> * <p>
* The HTTP PUT method is defined in section 9.6 of * The HTTP PUT method is defined in section 9.6 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The PUT method requests that the enclosed entity be stored under the * The PUT method requests that the enclosed entity be stored under the
* supplied Request-URI. If the Request-URI refers to an already * supplied Request-URI. If the Request-URI refers to an already
* existing resource, the enclosed entity SHOULD be considered as a * existing resource, the enclosed entity SHOULD be considered as a
* modified version of the one residing on the origin server. * modified version of the one residing on the origin server.
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe;
* <p> * <p>
* The HTTP TRACE method is defined in section 9.6 of * The HTTP TRACE method is defined in section 9.6 of
* <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>: * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
* </p>
* <blockquote> * <blockquote>
* The TRACE method is used to invoke a remote, application-layer loop- * The TRACE method is used to invoke a remote, application-layer loop-
* back of the request message. The final recipient of the request * back of the request message. The final recipient of the request
@ -45,7 +46,6 @@ import org.apache.http.annotation.NotThreadSafe;
* value of zero (0) in the request (see section 14.31). A TRACE request * value of zero (0) in the request (see section 14.31). A TRACE request
* MUST NOT include an entity. * MUST NOT include an entity.
* </blockquote> * </blockquote>
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View File

@ -49,8 +49,9 @@ public interface HttpUriRequest extends HttpRequest {
/** /**
* Returns the URI this request uses, such as * Returns the URI this request uses, such as
* <code>http://example.org/path/to/file</code>. * <code>http://example.org/path/to/file</code>.
* <br/> * <p>
* Note that the URI may be absolute URI (as above) or may be a relative URI. * Note that the URI may be absolute URI (as above) or may be a relative URI.
* </p>
* <p> * <p>
* Implementations are encouraged to return * Implementations are encouraged to return
* the URI that was initially requested. * the URI that was initially requested.

View File

@ -40,10 +40,11 @@ import org.apache.http.params.CoreProtocolPNames;
* module and all dependency modules or informational units. * module and all dependency modules or informational units.
* It does not define additional parameter names, but references * It does not define additional parameter names, but references
* other interfaces defining parameter names. * other interfaces defining parameter names.
* <br/> * <p>
* This interface is meant as a navigation aid for developers. * This interface is meant as a navigation aid for developers.
* When referring to parameter names, you should use the interfaces * When referring to parameter names, you should use the interfaces
* in which the respective constants are actually defined. * in which the respective constants are actually defined.
* </p>
* *
* @since 4.0 * @since 4.0
* *