Class DefaultTemplateProcessingResult

java.lang.Object

com.flowable.template.engine.impl.processor.DefaultTemplateProcessingResult

All Implemented Interfaces:

TemplateProcessingResult

public class DefaultTemplateProcessingResult
extends Object
implements TemplateProcessingResult

The default template processing result, holding the processed content as well as the template definition and variation used to process the result.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	bytes
protected org.flowable.content.api.ContentItem	contentItem
protected String	documentName
protected String	mimeType
protected String	processedContent
protected TemplateHolder	templateHolder

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultTemplateProcessingResult(TemplateHolder templateHolder, String processedContent)
	DefaultTemplateProcessingResult(TemplateHolder templateHolder, String processedContent, org.flowable.content.api.ContentItem contentItem, byte[] bytes)
protected	DefaultTemplateProcessingResult(TemplateHolder templateHolder, String processedContent, org.flowable.content.api.ContentItem contentItem, String mimeType, String documentName, byte[] bytes)

Method Summary

Modifier and Type	Method	Description
static DefaultTemplateProcessingResult	document(TemplateHolder templateHolder, String documentName, String mimeType, byte[] contentBytes)
static DefaultTemplateProcessingResult	document(TemplateHolder templateHolder, org.flowable.content.api.ContentItem document, byte[] bytes)
byte[]	getBytes()
org.flowable.content.api.ContentItem	getContentItem()	If the processed result is stored as a content item document, this will return it.
String	getDocumentName()	Returns the document name with the appropriate extension applied (e.g.
InputStream	getInputStream()	Returns the processed result as an InputStream.
String	getMimeType()	Returns the mime type of the produced document (e.g.
String	getProcessedContent()	Returns the processed content as a string (in case the content is processed directly).
TemplateHolder	getTemplateHolder()	Returns the template holder containing all information like template definition and variation which was used to produce the result.
void	setBytes(byte[] bytes)
void	setContentItem(org.flowable.content.api.ContentItem contentItem)
void	setDocumentName(String documentName)
void	setMimeType(String mimeType)
void	setProcessedContent(String processedContent)
void	setTemplateHolder(TemplateHolder templateHolder)

Methods inherited from class Object

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

Field Details

templateHolder

protected TemplateHolder templateHolder

processedContent

protected String processedContent

contentItem

protected org.flowable.content.api.ContentItem contentItem

bytes

protected byte[] bytes

mimeType

protected String mimeType

documentName

protected String documentName

Constructor Details

DefaultTemplateProcessingResult

public DefaultTemplateProcessingResult(TemplateHolder templateHolder,
 String processedContent)

DefaultTemplateProcessingResult

public DefaultTemplateProcessingResult(TemplateHolder templateHolder,
 String processedContent,
 org.flowable.content.api.ContentItem contentItem,
 byte[] bytes)

DefaultTemplateProcessingResult

protected DefaultTemplateProcessingResult(TemplateHolder templateHolder,
 String processedContent,
 org.flowable.content.api.ContentItem contentItem,
 String mimeType,
 String documentName,
 byte[] bytes)

Method Details

document

public static DefaultTemplateProcessingResult document(TemplateHolder templateHolder,
 org.flowable.content.api.ContentItem document,
 byte[] bytes)

document

public static DefaultTemplateProcessingResult document(TemplateHolder templateHolder,
 String documentName,
 String mimeType,
 byte[] contentBytes)

getTemplateHolder

public TemplateHolder getTemplateHolder()

Description copied from interface: TemplateProcessingResult

Returns the template holder containing all information like template definition and variation which was used to produce the result.

Specified by:

getTemplateHolder in interface TemplateProcessingResult

setTemplateHolder

public void setTemplateHolder(TemplateHolder templateHolder)

getProcessedContent

public String getProcessedContent()

Description copied from interface: TemplateProcessingResult

Returns the processed content as a string (in case the content is processed directly).

Specified by:

getProcessedContent in interface TemplateProcessingResult

setProcessedContent

public void setProcessedContent(String processedContent)

getInputStream

public InputStream getInputStream()

Description copied from interface: TemplateProcessingResult

Returns the processed result as an InputStream. Callers are responsible for closing the stream.

Specified by:

getInputStream in interface TemplateProcessingResult

getContentItem

public org.flowable.content.api.ContentItem getContentItem()

Description copied from interface: TemplateProcessingResult

If the processed result is stored as a content item document, this will return it.

Specified by:

getContentItem in interface TemplateProcessingResult

setContentItem

public void setContentItem(org.flowable.content.api.ContentItem contentItem)

getBytes

public byte[] getBytes()

setBytes

public void setBytes(byte[] bytes)

getMimeType

public String getMimeType()

Description copied from interface: TemplateProcessingResult

Returns the mime type of the produced document (e.g. "application/pdf"), or null if this result is not a document.

Specified by:

getMimeType in interface TemplateProcessingResult

setMimeType

public void setMimeType(String mimeType)

getDocumentName

public String getDocumentName()

Description copied from interface: TemplateProcessingResult

Returns the document name with the appropriate extension applied (e.g. "myDoc.docx"), or null if this result is not a document.

Specified by:

getDocumentName in interface TemplateProcessingResult

setDocumentName

public void setDocumentName(String documentName)