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 java.lang.Object
implements AsyncEntityProducer
```
Abstract text entity content producer.

Since:

5.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class AbstractCharAsyncEntityProducer.State

Field Summary

Fields
Modifier and Type	Field	Description
`private java.nio.ByteBuffer`	`bytebuf`
`private java.nio.charset.CharsetEncoder`	`charsetEncoder`
`private ContentType`	`contentType`
`private static java.nio.CharBuffer`	`EMPTY`
`private int`	`fragmentSizeHint`
`private AbstractCharAsyncEntityProducer.State`	`state`

Constructor Summary

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	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.
`private void`	`flush(StreamChannel<java.nio.ByteBuffer> channel)`
`java.lang.String`	`getContentEncoding()`	Returns content encoding of the entity, if known.
`long`	`getContentLength()`	Returns length of the entity, if known.
`java.lang.String`	`getContentType()`	Returns content type of the entity, if known.
`java.util.Set<java.lang.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<java.nio.CharBuffer> channel)`	Triggered to signal the ability of the underlying char channel to accept more data.
`void`	`releaseResources()`
`(package private) void`	`streamEnd(StreamChannel<java.nio.ByteBuffer> channel)`
`(package private) int`	`writeData(StreamChannel<java.nio.ByteBuffer> channel, java.nio.CharBuffer src)`

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

- Field Detail
  - EMPTY
```
private static final java.nio.CharBuffer EMPTY
```
  - bytebuf
```
private final java.nio.ByteBuffer bytebuf
```
  - fragmentSizeHint
```
private final int fragmentSizeHint
```
  - contentType
```
private final ContentType contentType
```
  - charsetEncoder
```
private final java.nio.charset.CharsetEncoder charsetEncoder
```
  - state
```
private volatile AbstractCharAsyncEntityProducer.State state
```
- Constructor Detail
  - AbstractCharAsyncEntityProducer
```
public AbstractCharAsyncEntityProducer(int bufferSize,
                                       int fragmentSizeHint,
                                       ContentType contentType)
```
- Method Detail
  - flush
```
private void flush(StreamChannel<java.nio.ByteBuffer> channel)
            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeData
```
final int writeData(StreamChannel<java.nio.ByteBuffer> channel,
                    java.nio.CharBuffer src)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - streamEnd
```
final void streamEnd(StreamChannel<java.nio.ByteBuffer> channel)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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<java.nio.CharBuffer> channel)
                             throws java.io.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:
    
    java.io.IOException
  - getContentType
```
public final java.lang.String getContentType()
```
    Description copied from interface: EntityDetails
    
    Returns content type of the entity, if known.
    
    Specified by:
    
    getContentType in interface EntityDetails
  - getContentEncoding
```
public java.lang.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 java.util.Set<java.lang.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 java.io.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:
    
    java.io.IOException
  - releaseResources
```
public void releaseResources()
```
    Specified by:
    
    releaseResources in interface ResourceHolder

Class AbstractCharAsyncEntityProducer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

bytebuf

fragmentSizeHint

contentType

charsetEncoder

state

Constructor Detail

AbstractCharAsyncEntityProducer

Method Detail

flush

writeData

streamEnd

availableData

produceData

getContentType

getContentEncoding

getContentLength

isChunked

getTrailerNames

available

produce

releaseResources