org.mule.transport.file.transformers
Class FileToString

java.lang.Object
  org.mule.transformer.AbstractTransformer
      org.mule.transformer.simple.SerializableToByteArray
          org.mule.transformer.simple.ObjectToByteArray
              org.mule.transport.file.transformers.FileToByteArray
                  org.mule.transport.file.transformers.FileToString

All Implemented Interfaces:

org.mule.api.AnnotatedObject, org.mule.api.context.MuleContextAware, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.NameableObject, org.mule.api.NamedObject, org.mule.api.processor.MessageProcessor, org.mule.api.transformer.Converter, org.mule.api.transformer.DiscoverableTransformer, org.mule.api.transformer.Transformer, org.mule.endpoint.EndpointAware

public class FileToString
extends FileToByteArray

FileToString reads file contents into a string.

Field Summary

Fields inherited from class org.mule.transformer.AbstractTransformer

encoding, endpoint, logger, mimeType, MULE_MESSAGE_DATA_TYPE, muleContext, name, returnType, sourceTypes

Fields inherited from interface org.mule.api.transformer.Converter

DEFAULT_PRIORITY_WEIGHTING, MAX_PRIORITY_WEIGHTING, MIN_PRIORITY_WEIGHTING

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

FileToString()

Method Summary

Object

doTransform(Object src, String encoding) Simple implementation which relies on FileToByteArray to get a byte[] from the file beeing parsed and then transform it to a String with the correct encoding.

Methods inherited from class org.mule.transformer.simple.SerializableToByteArray

getPriorityWeighting, isAcceptMuleMessage, setAcceptMuleMessage, setPriorityWeighting

Methods inherited from class org.mule.transformer.AbstractTransformer

dispose, generateTransformerName, getAnnotation, getAnnotations, getEncoding, getEncoding, getEndpoint, getMimeType, getName, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, initialise, isAcceptNull, isAllowNullReturn, isConsumed, isIgnoreBadInput, isSourceDataTypeSupported, isSourceDataTypeSupported, isSourceTypeSupported, isSourceTypeSupported, process, registerSourceType, registerSourceType, setAllowNullReturn, setAnnotations, setEncoding, setEndpoint, setIgnoreBadInput, setMimeType, setMuleContext, setName, setReturnClass, setReturnDataType, toString, transform, transform, unregisterSourceType, unregisterSourceType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transformer.Transformer

getEncoding, getEndpoint, getMimeType, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, isAcceptNull, isIgnoreBadInput, isSourceDataTypeSupported, isSourceTypeSupported, setReturnClass, setReturnDataType, transform, transform

Methods inherited from interface org.mule.api.processor.MessageProcessor

process

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.NameableObject

setName

Methods inherited from interface org.mule.api.NamedObject

getName

Methods inherited from interface org.mule.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.endpoint.EndpointAware

setEndpoint

Constructor Detail

FileToString

public FileToString()

Method Detail

doTransform

public Object doTransform(Object src,
                          String encoding)
                   throws org.mule.api.transformer.TransformerException

Simple implementation which relies on FileToByteArray to get a byte[] from the file beeing parsed and then transform it to a String with the correct encoding. If the encoding isn't supported simply throw an exception, good tranformation or no transformation at all. NOTE: if a byte[] is passed in as a source object this transformer accepts it and tries the usual transformation.

Overrides:

doTransform in class FileToByteArray

Throws:

org.mule.api.transformer.TransformerException