AbstractCharAsyncEntityProducer (Apache HttpComponents Core HTTP/1.1 5.1 API)

java.lang.Object
- org.apache.hc.core5.http.nio.entity.AbstractCharAsyncEntityProducer

All Implemented Interfaces:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder

Direct Known Subclasses:

StringAsyncEntityProducer
```
@Contract(threading=SAFE_CONDITIONAL)
public abstract class AbstractCharAsyncEntityProducer
extends Object
implements AsyncEntityProducer
```
Abstract text entity content producer.

Since:

5.0

Constructor Summary

Constructors
Constructor and Description
`AbstractCharAsyncEntityProducer(int bufferSize, int fragmentSizeHint, ContentType contentType)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`available()` Returns the number of bytes immediately available for output.
`protected abstract int`	`availableData()` Returns the number of bytes immediately available for output.
`String`	`getContentEncoding()` Returns content encoding of the entity, if known.
`long`	`getContentLength()` Returns length of the entity, if known.
`String`	`getContentType()` Returns content type of the entity, if known.
`Set<String>`	`getTrailerNames()` Preliminary declaration of trailing headers.
`boolean`	`isChunked()` Returns chunked transfer hint for this entity.
`void`	`produce(DataStreamChannel channel)` Triggered to signal the ability of the underlying data channel to accept more data.
`protected abstract void`	`produceData(StreamChannel<CharBuffer> channel)` Triggered to signal the ability of the underlying char channel to accept more data.
`void`	`releaseResources()`

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.AsyncEntityProducer
failed, isRepeatable

- Constructor Detail
  - AbstractCharAsyncEntityProducer
```
public AbstractCharAsyncEntityProducer(int bufferSize,
                               int fragmentSizeHint,
                               ContentType contentType)
```
- Method Detail
  - availableData
```
protected abstract int availableData()
```
    Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.
    
    Returns:
    the number of bytes immediately available for output
  - produceData
```
protected abstract void produceData(StreamChannel<CharBuffer> channel)
                             throws IOException
```
    Triggered to signal the ability of the underlying char channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.
    StreamChannel passed to this method is threading-safe.
    
    Parameters:
    channel - the data channel capable to accepting more data.
    
    Throws:
    
    IOException
  - getContentType
```
public final String getContentType()
```
    Description copied from interface: EntityDetails
    
    Returns content type of the entity, if known.
    
    Specified by:
    
    getContentType in interface EntityDetails
  - getContentEncoding
```
public String getContentEncoding()
```
    Description copied from interface: EntityDetails
    
    Returns content encoding of the entity, if known.
    
    Specified by:
    
    getContentEncoding in interface EntityDetails
  - getContentLength
```
public long getContentLength()
```
    Description copied from interface: EntityDetails
    
    Returns length of the entity, if known.
    
    Specified by:
    
    getContentLength in interface EntityDetails
  - isChunked
```
public boolean isChunked()
```
    Description copied from interface: EntityDetails
    
    Returns chunked transfer hint for this entity.
    The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
    
    Specified by:
    
    isChunked in interface EntityDetails
  - getTrailerNames
```
public Set<String> getTrailerNames()
```
    Description copied from interface: EntityDetails
    
    Preliminary declaration of trailing headers.
    
    Specified by:
    
    getTrailerNames in interface EntityDetails
  - available
```
public final int available()
```
    Description copied from interface: AsyncDataProducer
    
    Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.
    
    Specified by:
    
    available in interface AsyncDataProducer
    
    Returns:
    the number of bytes immediately available for output
  - produce
```
public final void produce(DataStreamChannel channel)
                   throws IOException
```
    Description copied from interface: AsyncDataProducer
    
    Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.
    
    Specified by:
    
    produce in interface AsyncDataProducer
    
    Parameters:
    channel - the data channel capable to accepting more data.
    
    Throws:
    
    IOException
  - releaseResources
```
public void releaseResources()
```
    Specified by:
    
    releaseResources in interface ResourceHolder

Class AbstractCharAsyncEntityProducer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCharAsyncEntityProducer

Method Detail

availableData

produceData

getContentType

getContentEncoding

getContentLength

isChunked

getTrailerNames

available

produce

releaseResources