andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make HttpRequest's documentation easier to read

Browse Source
This commit is contained in:
Cruz Julian Bishop 2012-06-29 16:37:40 +10:00
parent 59bb92171b
commit a818cad45a
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java
View File

@ -34,22 +34,30 @@ package io.netty.handler.codec.http;
public interface HttpRequest extends HttpMessage { 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(); 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); 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(); 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); void setUri(String uri);
} }