Package org.apache.http.entity

Class AbstractHttpEntity

java.lang.Object
org.apache.http.entity.AbstractHttpEntity
All Implemented Interfaces:
HttpEntity
Direct Known Subclasses:
BasicHttpEntity, ByteArrayEntity, EntityTemplate, FileEntity, InputStreamEntity, SerializableEntity, StringEntity
public abstract class AbstractHttpEntity
extends Object
implements HttpEntity
Abstract base class for entities. Provides the commonly used attributes for streamed and self-contained implementations of HttpEntity.
Since:
4.0
Version:
$Revision: 496070 $
Author:
Oleg Kalnichevski

  • Field Details

    • contentType

      protected Header contentType
      The Content-Type header. Returned by getContentType, unless that method is overridden.

    • contentEncoding

      protected Header contentEncoding
      The Content-Encoding header. Returned by getContentEncoding, unless that method is overridden.

    • chunked

      protected boolean chunked
      The 'chunked' flag. Returned by isChunked, unless that method is overridden.

  • Constructor Details

    • AbstractHttpEntity

      protected AbstractHttpEntity()
      Protected default constructor. The attributes of the created object remain null and false, respectively.

  • Method Details

    • getContentType

      public Header getContentType()
      Obtains the Content-Type header. The default implementation returns the value of the contentType attribute.
      Specified by:
      getContentType in interface HttpEntity
      Returns:
      the Content-Type header, or null

    • getContentEncoding

      public Header getContentEncoding()
      Obtains the Content-Encoding header. The default implementation returns the value of the contentEncoding attribute.
      Specified by:
      getContentEncoding in interface HttpEntity
      Returns:
      the Content-Encoding header, or null

    • isChunked

      public boolean isChunked()
      Obtains the 'chunked' flag. The default implementation returns the value of the chunked attribute.
      Specified by:
      isChunked in interface HttpEntity
      Returns:
      the 'chunked' flag

    • setContentType

      public void setContentType​(Header contentType)
      Specifies the Content-Type header. The default implementation sets the value of the contentType attribute.
      Parameters:
      contentType - the new Content-Encoding header, or null to unset

    • setContentType

      public void setContentType​(String ctString)
      Specifies the Content-Type header, as a string. The default implementation calls setContentType(Header).
      Parameters:
      ctString - the new Content-Type header, or null to unset

    • setContentEncoding

      public void setContentEncoding​(Header contentEncoding)
      Specifies the Content-Encoding header. The default implementation sets the value of the contentEncoding attribute.
      Parameters:
      contentEncoding - the new Content-Encoding header, or null to unset

    • setContentEncoding

      public void setContentEncoding​(String ceString)
      Specifies the Content-Encoding header, as a string. The default implementation calls setContentEncoding(Header).
      Parameters:
      ceString - the new Content-Encoding header, or null to unset

    • setChunked

      public void setChunked​(boolean b)
      Specifies the 'chunked' flag. The default implementation sets the value of the chunked attribute.
      Parameters:
      b - the new 'chunked' flag

    • consumeContent

      public void consumeContent() throws IOException, UnsupportedOperationException
      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
      Throws:
      IOException - in case of an I/O problem
      UnsupportedOperationException - if a streaming subclass does not override this method