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 EntityTemplate  

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

All Implemented Interfaces:

org.apache.http.HttpEntity

---

public class EntityTemplate

extends AbstractHttpEntity

Entity that delegates the process of content generation to an abstract content producer.

Since:

4.0

Version:

$Revision: 408072 $

---

Field Summary
private  ContentProducer	contentproducer

 

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

chunked, contentEncoding, contentType

 

Constructor Summary

EntityTemplate(ContentProducer contentproducer)

 

Method Summary
void	consumeContent()           Does not consume anything.
java.io.InputStream	getContent()           Creates a new InputStream object of the entity.
long	getContentLength()           Tells the length of the content, if known.
boolean	isRepeatable()           Tells if the entity is capable to produce its data more than once.
boolean	isStreaming()           Tells whether this entity depends on an underlying stream.
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

contentproducer

private final ContentProducer contentproducer

Constructor Detail

EntityTemplate

public EntityTemplate(ContentProducer contentproducer)

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()

Description copied from interface: org.apache.http.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 55 will throw an exception if this method is called multiple times.

---

isRepeatable

public boolean isRepeatable()

Description copied from interface: org.apache.http.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.

---

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

---