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

Javadoc fixes

Browse Source
This commit is contained in:
Norman Maurer 2012-12-23 23:03:54 +01:00
parent a9fdb682be
commit 2ea45950f1
7 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
codec-http/src/main/java/io/netty/handler/codec/http/HttpCodecUtil.java
View File

@ -57,7 +57,7 @@ final class HttpCodecUtil {
/**
* Validates the specified header value
*
* @param value The value being validated
* @param headerValue The value being validated
*/
static void validateHeaderValue(String headerValue) {
//Check to see if the value is null

7
codec-http/src/main/java/io/netty/handler/codec/http/HttpContentDecoder.java
View File

@ -24,7 +24,7 @@ import io.netty.handler.codec.MessageToMessageDecoder;
/**
* Decodes the content of the received {@link HttpRequest} and {@link HttpChunk}.
* The original content is replaced with the new content decoded by the
* {@link DecoderEmbedder}, which is created by {@link #newContentDecoder(String)}.
* {@link EmbeddedByteChannel}, which is created by {@link #newContentDecoder(String)}.
* Once decoding is finished, the value of the <tt>'Content-Encoding'</tt>
* header is set to the target content encoding, as returned by {@link #getTargetContentEncoding(String)}.
* Also, the <tt>'Content-Length'</tt> header is updated to the length of the
@ -127,11 +127,11 @@ public abstract class HttpContentDecoder extends MessageToMessageDecoder<Object,
}
/**
* Returns a new {@link DecoderEmbedder} that decodes the HTTP message
* Returns a new {@link EmbeddedByteChannel} that decodes the HTTP message
* content encoded in the specified <tt>contentEncoding</tt>.
*
* @param contentEncoding the value of the {@code "Content-Encoding"} header
* @return a new {@link DecoderEmbedder} if the specified encoding is supported.
* @return a new {@link EmbeddedByteChannel} if the specified encoding is supported.
* {@code null} otherwise (alternatively, you can throw an exception
* to block unknown encoding).
*/
@ -145,6 +145,7 @@ public abstract class HttpContentDecoder extends MessageToMessageDecoder<Object,
* @param contentEncoding the value of the {@code "Content-Encoding"} header
* @return the expected content encoding of the new content
*/
@SuppressWarnings("unused")
protected String getTargetContentEncoding(String contentEncoding) throws Exception {
return HttpHeaders.Values.IDENTITY;
}

4
codec-http/src/main/java/io/netty/handler/codec/http/HttpContentEncoder.java
View File

@ -27,7 +27,7 @@ import java.util.Queue;
/**
* Encodes the content of the outbound {@link HttpResponse} and {@link HttpChunk}.
* The original content is replaced with the new content encoded by the
* {@link EncoderEmbedder}, which is created by {@link #beginEncode(HttpMessage, String)}.
* {@link EmbeddedByteChannel}, which is created by {@link #beginEncode(HttpMessage, String)}.
* Once encoding is finished, the value of the <tt>'Content-Encoding'</tt> header
* is set to the target content encoding, as returned by
* {@link #beginEncode(HttpMessage, String)}.
@ -163,7 +163,7 @@ public abstract class HttpContentEncoder extends MessageToMessageCodec<HttpMessa
* the value of the {@code "Accept-Encoding"} header
*
* @return the result of preparation, which is composed of the determined
* target content encoding and a new {@link EncoderEmbedder} that
* target content encoding and a new {@link EmbeddedByteChannel} that
* encodes the content into the target content encoding.
* {@code null} if {@code acceptEncoding} is unsupported or rejected
* and thus the content should be handled as-is (i.e. no encoding).

4
codec-http/src/main/java/io/netty/handler/codec/http/HttpMessageDecoder.java
View File

@ -76,8 +76,8 @@ import java.util.List;
* </pre>
* triggers {@link HttpRequestDecoder} to generate 4 objects:
* <ol>
* <li>An {@link HttpRequest} whose {@link HttpMessage#isChunked() chunked}
* property is {@code true},</li>
* <li>An {@link HttpRequest} whose {@link HttpMessage#getTransferEncoding()}
* property is {@link HttpTransferEncoding#CHUNKED},</li>
* <li>The first {@link HttpChunk} whose content is {@code 'abcdefghijklmnopqrstuvwxyz'},</li>
* <li>The second {@link HttpChunk} whose content is {@code '1234567890abcdef'}, and</li>
* <li>An {@link HttpChunkTrailer} which marks the end of the content.</li>

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

@ -43,7 +43,7 @@ public interface HttpRequest extends HttpMessage {
/**
* Sets the {@link HttpMethod} of this {@link HttpRequest}.
*
* @param The {@link HttpMethod} to set
* @param method The {@link HttpMethod} to set
*/
void setMethod(HttpMethod method);

4
codec-http/src/main/java/io/netty/handler/codec/http/websocketx/CloseWebSocketFrame.java
View File

@ -24,6 +24,8 @@ import io.netty.util.CharsetUtil;
*/
public class CloseWebSocketFrame extends WebSocketFrame {
private static final byte[] EMTPY_REASON = new byte[0];
/**
* Creates a new empty close frame.
*/
@ -73,7 +75,7 @@ public class CloseWebSocketFrame extends WebSocketFrame {
setFinalFragment(finalFragment);
setRsv(rsv);
byte[] reasonBytes = new byte[0];
byte[] reasonBytes = EMTPY_REASON;
if (reasonText != null) {
reasonBytes = reasonText.getBytes(CharsetUtil.UTF_8);
}

2
codec-http/src/main/java/io/netty/handler/codec/spdy/SpdyHttpResponseStreamIdHandler.java
View File

@ -24,7 +24,7 @@ import io.netty.handler.codec.http.HttpMessage;
import io.netty.handler.codec.http.HttpResponse;
/**
* {@link MessageToMessageCodec} that takes care of adding the right {@link SpdyHttpHeaders#Names#STREAM_ID} to the
* {@link MessageToMessageCodec} that takes care of adding the right {@link SpdyHttpHeaders.Names#STREAM_ID} to the
* {@link HttpResponse} if one is not present. This makes it possible to just re-use plan handlers current used
* for HTTP.
*/