Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ entity overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.http.entity
Class BasicHttpEntity  

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

All Implemented Interfaces:

org.apache.http.HttpEntity

---

public class BasicHttpEntity

extends AbstractHttpEntity

A generic streamed entity being received on a connection.

Since:

4.0

Version:

$Revision: 385289 $

---

Field Summary
private  java.io.InputStream	content
private  boolean	contentObtained
private  long	length

 

Fields inherited from class org.apache.http.entity.AbstractHttpEntity

chunked, contentEncoding, contentType

 

Constructor Summary

BasicHttpEntity()           Creates a new basic entity.

 

Method Summary
void	consumeContent()           Does not consume anything.
java.io.InputStream	getContent()           Obtains the content, once only.
long	getContentLength()           Tells the length of the content, if known.
boolean	isRepeatable()           Tells that this entity is not repeatable.
boolean	isStreaming()           Tells whether this entity depends on an underlying stream.
void	setContent(java.io.InputStream instream)           Specifies the content.
void	setContentLength(long len)           Specifies the length of the content.
void	writeTo(java.io.OutputStream outstream)           Writes the entity content to the output stream.

 

Methods inherited from class org.apache.http.entity.AbstractHttpEntity

getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

content

private java.io.InputStream content

---

contentObtained

private boolean contentObtained

---

length

private long length

Constructor Detail

BasicHttpEntity

public BasicHttpEntity()

Creates a new basic entity. The content is initially missing, the content length is set to a negative number.

Method Detail

getContentLength

public long getContentLength()

Description copied from interface: org.apache.http.HttpEntity

Tells the length of the content, if known.

---

getContent

public java.io.InputStream getContent()
                               throws java.lang.IllegalStateException

Obtains the content, once only.

---

isRepeatable

public boolean isRepeatable()

Tells that this entity is not repeatable.

---

setContentLength

public void setContentLength(long len)

Specifies the length of the content.

---

setContent

public void setContent(java.io.InputStream instream)

Specifies the content.

---

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException

Description copied from interface: org.apache.http.HttpEntity

Writes the entity content to the output stream.

---

isStreaming

public boolean isStreaming()

Description copied from interface: org.apache.http.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 55 has been read to EOF, or after consumeContent 55 has been called. If a streamed entity can not detect whether the stream has been read to EOF, it should return true until consumeContent 55 is called.

---

consumeContent

public void consumeContent()
                    throws java.io.IOException

Description copied from class: AbstractHttpEntity

Does not consume anything. The default implementation does nothing if isStreaming 55 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 org.apache.http.HttpEntity

Overrides:

consumeContent in class AbstractHttpEntity

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> http >> [ entity overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---