org.codehaus.httpcache4j.payload

Class FilePayload

java.lang.Object

org.codehaus.httpcache4j.payload.FilePayload

All Implemented Interfaces:

Payload

public class FilePayload
extends Object
implements Payload

Payload that accepts a file with mimetype.

Author:

Erlend Hamnaberg

Constructor Summary

Constructors

Constructor and Description
FilePayload(File file, MIMEType mimeType) Constructs a File payload

Method Summary

Methods

Modifier and Type	Method and Description
File	getFile()
InputStream	getInputStream() Returns the input stream of the payload.
MIMEType	getMimeType() Return the mime-type of the payload.
boolean	isAvailable() Returns true if the payload is available, IE.
long	length() Returns the length of the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePayload

public FilePayload(File file,
           MIMEType mimeType)

Constructs a File payload

Parameters:

file - the file to use, may not be null.

mimeType - the mime type of the file, may not be null.

Method Detail

getMimeType

public MIMEType getMimeType()

Description copied from interface: Payload

Return the mime-type of the payload.

Specified by:

getMimeType in interface Payload

Returns:

the mime-type

getInputStream

public InputStream getInputStream()

Description copied from interface: Payload

Returns the input stream of the payload. This stream MUST be closed when you are done with it.

Specified by:

getInputStream in interface Payload

Returns:

the inputstream of the payload, may return null if the payload is not available.

isAvailable

public boolean isAvailable()

Description copied from interface: Payload

Returns true if the payload is available, IE. If the stream can be read from.

Specified by:

isAvailable in interface Payload

Returns:

true if the payload is available. false if not.

length

public long length()

Description copied from interface: Payload

Returns the length of the stream. If the payload is used in a HTTPResponse, this is the value of the Content-Length header. If the payload is used in a request, it can be set, or calculated based on the type.

Specified by:

length in interface Payload

Returns:

-1 if the length cannot be calculated or set. Otherwise the expected length of the stream.

getFile

public File getFile()