Package org.apache.pekko.http.javadsl.model

Class HttpEntity.ChunkStreamPart

java.lang.Object

org.apache.pekko.http.javadsl.model.HttpEntity.ChunkStreamPart

Direct Known Subclasses:

HttpEntity.ChunkStreamPart

Enclosing interface:

HttpEntity

public abstract static class HttpEntity.ChunkStreamPart
extends Object

A part of a stream of incoming data for `Transfer-Encoding: chunked` messages.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpEntity.ChunkStreamPart	LAST	The default last ChunkStreamPart that has no extension and no trailer headers.

Constructor Summary

Constructors

Constructor	Description
ChunkStreamPart()

Method Summary

Modifier and Type	Method	Description
static HttpEntity.ChunkStreamPart	create(org.apache.pekko.util.ByteString data)	Creates a chunk from data with an empty extension.
static HttpEntity.ChunkStreamPart	create(org.apache.pekko.util.ByteString data, String extension)	Creates a chunk from data and extension.
static HttpEntity.ChunkStreamPart	createLast(String extension, Iterable<HttpHeader> trailerHeaders)	Creates a last chunk with extension and headers.
abstract org.apache.pekko.util.ByteString	data()	Returns the byte data of this chunk.
abstract String	extension()	Returns extensions data for this chunk.
abstract Iterable<HttpHeader>	getTrailerHeaders()	If this is the last chunk, this will return an Iterable of the trailer headers.
abstract boolean	isLastChunk()	Returns if this is the last chunk

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LAST

public static final HttpEntity.ChunkStreamPart LAST

The default last ChunkStreamPart that has no extension and no trailer headers.

Constructor Details

ChunkStreamPart

public ChunkStreamPart()

Method Details

data

public abstract org.apache.pekko.util.ByteString data()

Returns the byte data of this chunk. Will be non-empty for every regular chunk. Will be empty for the last chunk.

extension

public abstract String extension()

Returns extensions data for this chunk.

isLastChunk

public abstract boolean isLastChunk()

Returns if this is the last chunk

getTrailerHeaders

public abstract Iterable<HttpHeader> getTrailerHeaders()

If this is the last chunk, this will return an Iterable of the trailer headers. Otherwise, it will be empty.

create

public static HttpEntity.ChunkStreamPart create(org.apache.pekko.util.ByteString data,
 String extension)

Creates a chunk from data and extension.

create

public static HttpEntity.ChunkStreamPart create(org.apache.pekko.util.ByteString data)

Creates a chunk from data with an empty extension.

createLast

public static HttpEntity.ChunkStreamPart createLast(String extension,
 Iterable<HttpHeader> trailerHeaders)

Creates a last chunk with extension and headers.