Package org.apache.http.entity

Class EntityTemplate

java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.EntityTemplate
All Implemented Interfaces:
HttpEntity
public class EntityTemplate
extends AbstractHttpEntity
Entity that delegates the process of content generation to an abstract content producer.
Since:
4.0
Version:
$Revision: 496070 $
Author:
Oleg Kalnichevski

  • Constructor Details

    • EntityTemplate

      public EntityTemplate​(ContentProducer contentproducer)

  • Method Details

    • getContentLength

      public long getContentLength()
      Description copied from interface: HttpEntity
      Tells the length of the content, if known.
      Returns:
      the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

    • getContent

      public InputStream getContent()
      Description copied from interface: HttpEntity
      Creates a new InputStream object of the entity. It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.
      Returns:
      a new input stream that returns the entity data.

    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: HttpEntity
      Tells if the entity is capable to produce its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.
      Returns:
      true if the entity is repeatable, false otherwise.

    • writeTo

      public void writeTo​(OutputStream outstream) throws IOException
      Description copied from interface: HttpEntity
      Writes the entity content to the output stream.
      Parameters:
      outstream - the output stream to write entity content to
      Throws:
      IOException - if an I/O error occurs

    • isStreaming

      public boolean isStreaming()
      Description copied from interface: HttpEntity
      Tells whether this entity depends on an underlying stream. Streamed entities should return true until the content has been consumed, false afterwards. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
      The content of a streamed entity is consumed when the stream returned by getContent has been read to EOF, or after consumeContent has been called. If a streamed entity can not detect whether the stream has been read to EOF, it should return true until consumeContent is called.
      Returns:
      true if the entity content is streamed and not yet consumed, false otherwise

    • consumeContent

      public void consumeContent() throws IOException
      Description copied from class: AbstractHttpEntity
      Does not consume anything. The default implementation does nothing if isStreaming returns false, and throws an exception if it returns true. This removes the burden of implementing an empty method for non-streaming entities.
      Specified by:
      consumeContent in interface HttpEntity
      Overrides:
      consumeContent in class AbstractHttpEntity
      Throws:
      IOException - in case of an I/O problem