Make HttpRequest's documentation easier to read

This commit is contained in:
Cruz Julian Bishop 2012-06-29 16:37:40 +10:00 committed by Trustin Lee
parent 98c61e4128
commit d975ab365c

View File

@ -34,22 +34,30 @@ package io.netty.handler.codec.http;
public interface HttpRequest extends HttpMessage {
/**
* Returns the method of this request.
* Gets the {@link HttpMethod} of this {@link HttpRequest}.
*
* @return The {@link HttpMethod} of this {@link HttpRequest}
*/
HttpMethod getMethod();
/**
* Sets the method of this request.
* Sets the {@link HttpMethod} of this {@link HttpRequest}.
*
* @param The {@link HttpMethod} to set
*/
void setMethod(HttpMethod method);
/**
* Returns the URI (or path) of this request.
* Gets the requested URI (or alternatively, path)
*
* @return The URI being requested
*/
String getUri();
/**
* Sets the URI (or path) of this request.
* Sets the URI (or alternatively, path) being requested.
*
* @param uri The URI being requested
*/
void setUri(String uri);
}