org.apache.http.entity
Class FileEntity

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

All Implemented Interfaces:

Cloneable, HttpEntity

public class FileEntity
extends AbstractHttpEntity
implements Cloneable

An entity whose content is retrieved from a file.

Since:

4.0

Field Summary

protected File

file

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

chunked, contentEncoding, contentType

Constructor Summary

FileEntity(File file, String contentType)

Method Summary

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
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 that this entity is not streaming.
void	writeTo(OutputStream outstream) Writes the entity content to the output stream.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final File file

Constructor Detail

FileEntity

public FileEntity(File file,
                  String contentType)

Method Detail

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.

Specified by:

isRepeatable in interface HttpEntity

Returns:

true if the entity is repeatable, false otherwise.

getContentLength

public long getContentLength()

Description copied from interface: HttpEntity

Tells the length of the content, if known.

Specified by:

getContentLength in interface HttpEntity

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

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.

Specified by:

getContent in interface HttpEntity

Returns:

a new input stream that returns the entity data.

Throws:

IOException - if the stream could not be created

writeTo

public void writeTo(OutputStream outstream)
             throws IOException

Description copied from interface: HttpEntity

Writes the entity content to the output stream.

Specified by:

writeTo in interface HttpEntity

Parameters:

outstream - the output stream to write entity content to

Throws:

IOException - if an I/O error occurs

isStreaming

public boolean isStreaming()

Tells that this entity is not streaming.

Specified by:

isStreaming in interface HttpEntity

Returns:

false

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: Object

Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.

Classes which wish to support cloning must specify that they implement the Cloneable interface, since the implementation checks for this.

Overrides:

clone in class Object

Returns:

Object a shallow copy of this object.

Throws:

CloneNotSupportedException - if the receiver's class does not implement the interface Cloneable.