PathEntityProducer (aliyun-http-apache 0.2.0-beta API)

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

所有已实现的接口:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder
```
public final class PathEntityProducer
extends Object
implements AsyncEntityProducer
```
AsyncEntityProducer implementation that generates a data stream from the content at a Path.

从以下版本开始:

5.2

构造器概要

构造器
构造器和说明
`PathEntityProducer(Path file, ContentType contentType, boolean chunked, OpenOption... openOptions)`
`PathEntityProducer(Path file, ContentType contentType, OpenOption... openOptions)`
`PathEntityProducer(Path file, int bufferSize, ContentType contentType, boolean chunked, OpenOption... openOptions)`
`PathEntityProducer(Path file, OpenOption... openOptions)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`available()` Returns the number of bytes immediately available for output.
`void`	`failed(Exception cause)` Triggered to signal a failure in data generation.
`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.
`Exception`	`getException()`
`Set<String>`	`getTrailerNames()` Preliminary declaration of trailing headers.
`boolean`	`isChunked()` Returns chunked transfer hint for this entity.
`boolean`	`isRepeatable()` Determines whether the producer can consistently produce the same content after invocation of `ResourceHolder.releaseResources()`.
`void`	`produce(DataStreamChannel dataStreamChannel)` Triggered to signal the ability of the underlying data channel to accept more data.
`void`	`releaseResources()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - PathEntityProducer
```
public PathEntityProducer(Path file,
                          ContentType contentType,
                          boolean chunked,
                          OpenOption... openOptions)
                   throws IOException
```
    抛出:
    
    IOException
  - PathEntityProducer
```
public PathEntityProducer(Path file,
                          ContentType contentType,
                          OpenOption... openOptions)
                   throws IOException
```
    抛出:
    
    IOException
  - PathEntityProducer
```
public PathEntityProducer(Path file,
                          int bufferSize,
                          ContentType contentType,
                          boolean chunked,
                          OpenOption... openOptions)
                   throws IOException
```
    抛出:
    
    IOException
  - PathEntityProducer
```
public PathEntityProducer(Path file,
                          OpenOption... openOptions)
                   throws IOException
```
    抛出:
    
    IOException
- 方法详细资料
  - available
```
public int available()
```
    从接口复制的说明: 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.
    
    指定者:
    
    available 在接口中 AsyncDataProducer
    
    返回:
    
    the number of bytes immediately available for output
  - failed
```
public void failed(Exception cause)
```
    从接口复制的说明: AsyncEntityProducer
    
    Triggered to signal a failure in data generation.
    
    指定者:
    
    failed 在接口中 AsyncEntityProducer
    
    参数:
    
    cause - the cause of the failure.
  - getContentEncoding
```
public String getContentEncoding()
```
    从接口复制的说明: EntityDetails
    
    Returns content encoding of the entity, if known.
    
    指定者:
    
    getContentEncoding 在接口中 EntityDetails
  - getContentLength
```
public long getContentLength()
```
    从接口复制的说明: EntityDetails
    
    Returns length of the entity, if known.
    
    指定者:
    
    getContentLength 在接口中 EntityDetails
  - getContentType
```
public String getContentType()
```
    从接口复制的说明: EntityDetails
    
    Returns content type of the entity, if known.
    
    指定者:
    
    getContentType 在接口中 EntityDetails
  - getException
```
public Exception getException()
```
  - getTrailerNames
```
public Set<String> getTrailerNames()
```
    从接口复制的说明: EntityDetails
    
    Preliminary declaration of trailing headers.
    
    指定者:
    
    getTrailerNames 在接口中 EntityDetails
  - isChunked
```
public boolean isChunked()
```
    从接口复制的说明: EntityDetails
    
    Returns chunked transfer hint for this entity.
    The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
    
    指定者:
    
    isChunked 在接口中 EntityDetails
  - isRepeatable
```
public boolean isRepeatable()
```
    从接口复制的说明: AsyncEntityProducer
    
    Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().
    
    指定者:
    
    isRepeatable 在接口中 AsyncEntityProducer
  - produce
```
public void produce(DataStreamChannel dataStreamChannel)
             throws IOException
```
    从接口复制的说明: 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.
    
    指定者:
    
    produce 在接口中 AsyncDataProducer
    
    参数:
    
    dataStreamChannel - the data channel capable to accepting more data.
    
    抛出:
    
    IOException
  - releaseResources
```
public void releaseResources()
```
    指定者:
    
    releaseResources 在接口中 ResourceHolder

类 PathEntityProducer

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

PathEntityProducer

PathEntityProducer

PathEntityProducer

PathEntityProducer

方法详细资料

available

failed

getContentEncoding

getContentLength

getContentType

getException

getTrailerNames

isChunked

isRepeatable

produce

releaseResources