org.apache.http.nio
Interface ContentDecoder

All Known Implementing Classes:
AbstractContentDecoder

public interface ContentDecoder

Abstract HTTP content decoder. HTTP content decoders can be used to read entity content from the underlying channel in small chunks and apply the required coding transformation.

Author:
Oleg Kalnichevski

Method Summary
 boolean isCompleted()
          Returns true if the entity has been received in its entirety.
 int read(java.nio.ByteBuffer dst)
          Reads a portion of content from the underlying channel
 

Method Detail

read

public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException
Reads a portion of content from the underlying channel

Parameters:
dst - The buffer into which entity content is to be transferred
Returns:
The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream
Throws:
java.io.IOException - if I/O error occurs while reading content

isCompleted

public boolean isCompleted()
Returns true if the entity has been received in its entirety.

Returns:
true if all the content has been consumed, false otherwise.


Copyright © 2005-2007 Apache Software Foundation. All Rights Reserved.