public interface

FileContentDecoder

implements ContentDecoder
org.apache.http.nio.FileContentDecoder
Known Indirect Subclasses

Class Overview

A content decoder capable of transferring data directly to a FileChannel

Summary

Public Methods
abstract long transfer(FileChannel dst, long position, long count)
Transfers a portion of entity content from the underlying network channel into the given file channel.
[Expand]
Inherited Methods
From interface org.apache.http.nio.ContentDecoder

Public Methods

public abstract long transfer (FileChannel dst, long position, long count)

Transfers a portion of entity content from the underlying network channel into the given file channel.
Warning: Many implementations cannot write beyond the length of the file. If the position exceeds the channel's size, some implementations may throw an IOException.

Parameters
dst the target FileChannel to transfer data into.
position The position within the file at which the transfer is to begin; must be non-negative. Must be less than or equal to the size of the file
count The maximum number of bytes to be transferred; must be non-negative
Returns
  • The number of bytes, possibly zero, that were actually transferred
Throws
if some I/O error occurs.
IOException