Class AbstractFilePayloadTransformer<T>

java.lang.Object

org.springframework.integration.file.transformer.AbstractFilePayloadTransformer<T>

Type Parameters:

T - the expected payload type.

All Implemented Interfaces:

Aware, BeanFactoryAware, GenericTransformer<Message<?>, Message<?>>, Transformer

Direct Known Subclasses:

FileToByteArrayTransformer, FileToStringTransformer

public abstract class AbstractFilePayloadTransformer<T>
extends Object
implements Transformer, BeanFactoryAware

Base class for transformers that convert a File payload.

Author:

Mark Fisher, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected final Log	logger

Constructor Summary

Constructors

Constructor	Description
AbstractFilePayloadTransformer()

Method Summary

Modifier and Type	Method	Description
protected MessageBuilderFactory	getMessageBuilderFactory()
void	setBeanFactory(BeanFactory beanFactory)
void	setDeleteFiles(boolean deleteFiles)	Specify whether to delete the File after transformation.
final Message<?>	transform(Message<?> message)
protected abstract T	transformFile(File file)	Subclasses must implement this method to transform the File contents.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final Log logger

Constructor Details

AbstractFilePayloadTransformer

public AbstractFilePayloadTransformer()

Method Details

setDeleteFiles

public void setDeleteFiles(boolean deleteFiles)

Specify whether to delete the File after transformation. Default is false.

Parameters:

deleteFiles - true to delete the file.

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getMessageBuilderFactory

protected MessageBuilderFactory getMessageBuilderFactory()

transform

public final Message<?> transform(Message<?> message)

Specified by:

transform in interface GenericTransformer<Message<?>, Message<?>>

Specified by:

transform in interface Transformer

transformFile

protected abstract T transformFile(File file)
                            throws IOException

Subclasses must implement this method to transform the File contents.

Parameters:

file - The file.

Returns:

The result of the transformation.

Throws:

IOException - Any IOException.