Package com.storedobject.core

Class FileContent

java.lang.Object

com.storedobject.core.FileContent

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Runnable

public class FileContent
extends Object
implements ContentProducer

Constructor Summary

Constructors

Constructor	Description
FileContent(File file, String contentType)

Method Summary

Modifier and Type	Method	Description
InputStream	getContent()	Retrieves the content as an InputStream.
final String	getContentType()
Throwable	getError()	Get the current error (set via ContentProducer.abort(Throwable)).
File	getFile()	Retrieves the file associated with this instance.
String	getFileExtension()	Retrieves the file extension associated with the content.
String	getFileName()	Retrieves the name of the file associated with the content.
TransactionManager	getTransactionManager()	Retrieves the transaction manager associated with this object.
void	produce()	Certain types of content may have to be produced.
void	setFileName(String fileName)
void	setTransactionManager(TransactionManager tm)	Sets the transaction manager for this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.ContentProducer

abort, execute, extractContent, getEntity, getStreamData, getStreamDataProvider, getSystemEntity, ready, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Constructor Details

FileContent

public FileContent(File file,
 String contentType)

Method Details

produce

public void produce()

Description copied from interface: ContentProducer

Certain types of content may have to be produced. This method is used to do that.

Specified by:

produce in interface ContentProducer

getContent

public InputStream getContent()
                       throws Exception

Description copied from interface: ContentProducer

Retrieves the content as an InputStream.

Note: This may not invoke ContentProducer.produce() and it may just return the content if it is already available. It is implementation-dependent.

Specified by:

getContent in interface ContentProducer

Returns:

an InputStream representing the content. This may be null if the content is not yet available.

Throws:

Exception - if there is an error during content retrieval

getFileExtension

public String getFileExtension()

Description copied from interface: ContentProducer

Retrieves the file extension associated with the content.

Specified by:

getFileExtension in interface ContentProducer

Returns:

a String representing the file extension, or an empty string if no extension is available.

getFileName

public String getFileName()

Description copied from interface: ContentProducer

Retrieves the name of the file associated with the content.

Specified by:

getFileName in interface ContentProducer

Returns:

a String representing the name of the file, or null if the file name is unavailable.

setFileName

public void setFileName(String fileName)

getContentType

public final String getContentType()

Specified by:

getContentType in interface ContentType

setTransactionManager

public void setTransactionManager(TransactionManager tm)

Description copied from interface: RequiresTransactionManager

Sets the transaction manager for this object. The transaction manager is responsible for managing transaction boundaries.

Specified by:

setTransactionManager in interface RequiresTransactionManager

Parameters:

tm - the transaction manager to be set

getTransactionManager

public TransactionManager getTransactionManager()

Description copied from interface: RequiresTransactionManager

Retrieves the transaction manager associated with this object.

Specified by:

getTransactionManager in interface ContentProducer

Specified by:

getTransactionManager in interface RequiresTransactionManager

Returns:

the transaction manager responsible for managing transaction boundaries

getError

public Throwable getError()

Description copied from interface: ContentProducer

Get the current error (set via ContentProducer.abort(Throwable)).

Specified by:

getError in interface ContentProducer

Returns:

Current error, if any.

getFile

public File getFile()

Retrieves the file associated with this instance.

Returns:

the file object that this instance represents