to top

Interfaces
- ContentLengthStrategy
- ContentProducer
Classes

Summary: Fields | Protected Ctors | Methods | Inherited Methods | [Expand All]

Since: API Level 1

public abstract class

AbstractHttpEntity

extends Object
implements HttpEntity

java.lang.Object
↳	org.apache.http.entity.AbstractHttpEntity

Known Direct Subclasses

BasicHttpEntity, ByteArrayEntity, EntityTemplate, FileEntity, InputStreamEntity, SerializableEntity, StringEntity

Known Indirect Subclasses

UrlEncodedFormEntity

Class Overview

Abstract base class for entities. Provides the commonly used attributes for streamed and self-contained implementations of HttpEntity.

Summary

Fields
protected boolean	chunked	The 'chunked' flag.
protected Header	contentEncoding	The Content-Encoding header.
protected Header	contentType	The Content-Type header.

Protected Constructors
	AbstractHttpEntity() Protected default constructor.

Public Methods
void	consumeContent() Does not consume anything.
Header	getContentEncoding() Obtains the Content-Encoding header.
Header	getContentType() Obtains the Content-Type header.
boolean	isChunked() Obtains the 'chunked' flag.
void	setChunked(boolean b) Specifies the 'chunked' flag.
void	setContentEncoding(String ceString) Specifies the Content-Encoding header, as a string.
void	setContentEncoding(Header contentEncoding) Specifies the Content-Encoding header.
void	setContentType(Header contentType) Specifies the Content-Type header.
void	setContentType(String ctString) Specifies the Content-Type header, as a string.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.HttpEntity

abstract void	consumeContent() TODO: The name of this method is misnomer.
abstract InputStream	getContent() Creates a new InputStream object of the entity.
abstract Header	getContentEncoding() Obtains the Content-Encoding header, if known.
abstract long	getContentLength() Tells the length of the content, if known.
abstract Header	getContentType() Obtains the Content-Type header, if known.
abstract boolean	isChunked() Tells about chunked encoding for this entity.
abstract boolean	isRepeatable() Tells if the entity is capable to produce its data more than once.
abstract boolean	isStreaming() Tells whether this entity depends on an underlying stream.
abstract void	writeTo(OutputStream outstream) Writes the entity content to the output stream.

Fields

protected boolean chunked

Since: API Level 1

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

protected Header contentEncoding

Since: API Level 1

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

protected Header contentType

Since: API Level 1

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

Protected Constructors

protected AbstractHttpEntity ()

Since: API Level 1

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

Public Methods

public void consumeContent ()

Since: API Level 1

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.

Throws

IOException	in case of an I/O problem
UnsupportedOperationException	if a streaming subclass does not override this method

public Header getContentEncoding ()

Since: API Level 1

Obtains the Content-Encoding header. The default implementation returns the value of the contentEncoding attribute.

Returns

the Content-Encoding header, or null

public Header getContentType ()

Since: API Level 1

Obtains the Content-Type header. The default implementation returns the value of the contentType attribute.

Returns

the Content-Type header, or null

public boolean isChunked ()

Since: API Level 1

Obtains the 'chunked' flag. The default implementation returns the value of the chunked attribute.

Returns

the 'chunked' flag

public void setChunked (boolean b)

Since: API Level 1

Specifies the 'chunked' flag. The default implementation sets the value of the chunked attribute.

Parameters

b	the new 'chunked' flag

public void setContentEncoding (String ceString)

Since: API Level 1

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

public void setContentEncoding (Header contentEncoding)

Since: API Level 1

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

public void setContentType (Header contentType)

Since: API Level 1

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

public void setContentType (String ctString)

Since: API Level 1

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

Results

Interfaces

Classes

AbstractHttpEntity

Class Overview

Summary

Fields

protected boolean chunked

protected Header contentEncoding

protected Header contentType

Protected Constructors

protected AbstractHttpEntity ()

Public Methods

public void consumeContent ()

Throws

public Header getContentEncoding ()

Returns

public Header getContentType ()

Returns

public boolean isChunked ()

Returns

public void setChunked (boolean b)

Parameters

public void setContentEncoding (String ceString)

Parameters

public void setContentEncoding (Header contentEncoding)

Parameters

public void setContentType (Header contentType)

Parameters

public void setContentType (String ctString)

Parameters