Package org.apache.hc.core5.http.nio.entity

Class CharSequenceAsyncEntityConsumer<T>

java.lang.Object

org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

org.apache.hc.core5.http.nio.entity.AbstractCharAsyncEntityConsumer<T>

org.apache.hc.core5.http.nio.entity.CharSequenceAsyncEntityConsumer<T>

All Implemented Interfaces:

AsyncDataConsumer, AsyncEntityConsumer<T>, ResourceHolder

Direct Known Subclasses:

StringAsyncEntityConsumer

public class CharSequenceAsyncEntityConsumer<T>
extends AbstractCharAsyncEntityConsumer<T>

AsyncEntityConsumer implementation that processes the data stream content into a CharSequence.

Since:

5.5

Field Summary

Fields inherited from class org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

DEF_BUF_SIZE

Constructor Summary

Constructors

Constructor	Description
CharSequenceAsyncEntityConsumer(int bufSize, int capacityIncrement, CharCodingConfig charCodingConfig, Function<CharSequence,T> transformation)
CharSequenceAsyncEntityConsumer(int capacityIncrement, Function<CharSequence,T> transformation)
CharSequenceAsyncEntityConsumer(Function<CharSequence,T> transformation)
CharSequenceAsyncEntityConsumer(CharCodingConfig charCodingConfig, Function<CharSequence,T> transformation)

Method Summary

Modifier and Type	Method	Description
protected int	capacityIncrement()	Triggered to obtain the capacity increment.
protected final void	data(CharBuffer src, boolean endOfStream)	Triggered to pass incoming data packet to the data consumer.
T	generateContent()	Triggered to generate entity representation.
void	releaseResources()
protected final void	streamStart(ContentType contentType)	Triggered to signal beginning of entity content stream.

Methods inherited from class org.apache.hc.core5.http.nio.entity.AbstractCharAsyncEntityConsumer

completed, failed, getContent, streamStart

Methods inherited from class org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

consume, setCharset, streamEnd, updateCapacity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hc.core5.http.nio.AsyncDataConsumer

consume, streamEnd, updateCapacity

Constructor Details

CharSequenceAsyncEntityConsumer

public CharSequenceAsyncEntityConsumer(int bufSize,
 int capacityIncrement,
 CharCodingConfig charCodingConfig,
 Function<CharSequence,T> transformation)

CharSequenceAsyncEntityConsumer

public CharSequenceAsyncEntityConsumer(int capacityIncrement,
 Function<CharSequence,T> transformation)

CharSequenceAsyncEntityConsumer

public CharSequenceAsyncEntityConsumer(CharCodingConfig charCodingConfig,
 Function<CharSequence,T> transformation)

CharSequenceAsyncEntityConsumer

public CharSequenceAsyncEntityConsumer(Function<CharSequence,T> transformation)

Method Details

streamStart

protected final void streamStart(ContentType contentType)
                          throws HttpException,
IOException

Description copied from class: AbstractCharAsyncEntityConsumer

Triggered to signal beginning of entity content stream.

Specified by:

streamStart in class AbstractCharAsyncEntityConsumer<T>

Parameters:

contentType - the entity content type

Throws:

HttpException - in case of an HTTP protocol violation.

IOException - in case of an I/O error.

capacityIncrement

protected int capacityIncrement()

Description copied from class: AbstractCharDataConsumer

Triggered to obtain the capacity increment.

Specified by:

capacityIncrement in class AbstractCharDataConsumer

Returns:

the number of bytes this consumer is prepared to process.

data

protected final void data(CharBuffer src,
 boolean endOfStream)

Description copied from class: AbstractCharDataConsumer

Triggered to pass incoming data packet to the data consumer.

Specified by:

data in class AbstractCharDataConsumer

Parameters:

src - the data packet.

endOfStream - flag indicating whether this data packet is the last in the data stream.

generateContent

public T generateContent()

Description copied from class: AbstractCharAsyncEntityConsumer

Triggered to generate entity representation.

Specified by:

generateContent in class AbstractCharAsyncEntityConsumer<T>

Returns:

the entity content

releaseResources

public void releaseResources()