io.netty.handler.codec.http

Enum HttpTransferEncoding

java.lang.Object

java.lang.Enum<HttpTransferEncoding>

io.netty.handler.codec.http.HttpTransferEncoding

All Implemented Interfaces:

Serializable, Comparable<HttpTransferEncoding>

public enum HttpTransferEncoding
extends Enum<HttpTransferEncoding>

Represents how an HTTP request or an HTTP response is represented as an HttpMessage and zero or more HttpChunks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHUNKED An HTTP message whose transfer encoding is chunked as defined in the section 3.6 of RFC2616 so that the content is split into multiple chunks.
SINGLE A self-contained HTTP message which is not followed by any HttpChunks.
STREAMED An HTTP message whose transfer encoding is not chunked, but the length of its content is large enough so that the content is split into multiple chunks.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isMultiple() Returns true if and only if a complete HTTP message is composed of an HttpMessage and one or more HttpChunks.
boolean	isSingle() Returns true if and only if a single HttpMessage represents a complete HTTP message, not followed by any HttpChunks.
static HttpTransferEncoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpTransferEncoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHUNKED

public static final HttpTransferEncoding CHUNKED

An HTTP message whose transfer encoding is chunked as defined in the section 3.6 of RFC2616 so that the content is split into multiple chunks. A complete HTTP message is composed of the following:

1. HttpRequest or HttpResponse with empty content
2. A list of HttpChunks whose content are not empty
3. HttpChunkTrailer

STREAMED

public static final HttpTransferEncoding STREAMED

An HTTP message whose transfer encoding is not chunked, but the length of its content is large enough so that the content is split into multiple chunks. A complete HTTP message is composted of the following.

1. HttpRequest or HttpResponse with empty content
2. A list of HttpChunks whose content are not empty
3. HttpChunkTrailer

The difference from CHUNKED is that the transfer encoding of the streamed content is not chunked, and thus HttpMessageEncoder will encode the content as-is, rather than prepending HTTP chunk headers as defined in the section 3.6 of RFC2616.

SINGLE

public static final HttpTransferEncoding SINGLE

A self-contained HTTP message which is not followed by any HttpChunks. A user can set the content of the message via HttpMessage.setContent(io.netty.buffer.ByteBuf).

Method Detail

values

public static HttpTransferEncoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpTransferEncoding c : HttpTransferEncoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpTransferEncoding valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isMultiple

public boolean isMultiple()

Returns true if and only if a complete HTTP message is composed of an HttpMessage and one or more HttpChunks.

isSingle

public boolean isSingle()

Returns true if and only if a single HttpMessage represents a complete HTTP message, not followed by any HttpChunks.