Package com.storedobject.ui

Class Content

java.lang.Object

com.storedobject.ui.Content

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Runnable

Direct Known Subclasses:

PDFContent

public class Content
extends Object
implements ContentProducer

Content coming from an InputStream that can be viewed or downloaded (via Device.view(String, ContentProducer) or Device.download(ContentProducer)).

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Content(InputStream content, String mimeType, String fileExtension)	Constructor.

Method Summary

Modifier and Type	Method	Description
final InputStream	getContent()	Retrieves the content as an InputStream.
final String	getContentType()
final String	getFileExtension()	Retrieves the file extension associated with the content.
String	getFileName()	Retrieves the name of the file associated with the content.
final void	produce()	Certain types of content may have to be produced.
void	setTransactionManager(TransactionManager transactionManager)	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, getError, getStreamData, getStreamDataProvider, getSystemEntity, getTransactionManager, 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

Content

public Content(InputStream content,
 String mimeType,
 String fileExtension)

Constructor.

Parameters:

content - Content.

mimeType - Content type.

fileExtension - File extension.

Method Details

produce

public final 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 final InputStream getContent()

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.

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.

getContentType

public final String getContentType()

Specified by:

getContentType in interface ContentType

getFileExtension

public final 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.

setTransactionManager

public void setTransactionManager(TransactionManager transactionManager)

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:

transactionManager - the transaction manager to be set