org.mule.runtime.core.api.transformer

Interface Transformer

All Superinterfaces:

org.mule.runtime.api.lifecycle.Disposable, Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Initialisable, MuleContextAware, org.mule.runtime.api.meta.NameableObject, org.mule.runtime.api.meta.NamedObject, Processor, ReactiveProcessor

All Known Subinterfaces:

Converter, DiscoverableTransformer, MessageTransformer

All Known Implementing Classes:

AbstractCompressionTransformer, AbstractDiscoverableTransformer, AbstractEncryptionTransformer, AbstractExpressionTransformer, AbstractMessageTransformer, AbstractTransformer, AutoTransformer, Base64Decoder, Base64Encoder, BeanBuilderTransformer, BeanToMap, ByteArrayToHexString, ByteArrayToMuleMessage, ByteArrayToObject, ByteArrayToSerializable, CompositeConverter, CursorIteratorProviderToIterator, CursorStreamProviderToInputStream, DataHandlerToInputStreamTransformer, DecryptionTransformer, EncryptionTransformer, ExpressionTransformer, GetBeanProperty, GZipCompressTransformer, GZipUncompressTransformer, HexStringToByteArray, InputStreamToByteArray, LocalDateToDate, MapLookup, MapToBean, MuleMessageToByteArray, NumberToString, ObjectArrayToString, ObjectToByteArray, ObjectToInputStream, ObjectToOutputHandler, ObjectToString, ParseTemplateTransformer, PropertyEditorTextToValueTransformer, PropertyEditorValueToTextTransformer, SerializableToByteArray, SetPayloadTransformer, StringAppendTransformer, StringToBoolean, StringToCharsetTransformer, StringToEnum, StringToMediaTypeTransformer, StringToNumber, StringToObjectArray, TransformerChain, TransformerTemplate, XmlEntityDecoder, XmlEntityEncoder

public interface Transformer
extends Processor, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.meta.NameableObject, MuleContextAware

Transformer can be chained together to covert message payloads from one object type to another.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

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

PHASE_NAME

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

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
default ReactiveProcessor.ProcessingType	getProcessingType() In order for Mule to determine the best way to execute different processors based on the chosen ProcessingStrategy it needs to know the type of work the message processor will be performing and if it is ReactiveProcessor.ProcessingType.BLOCKING, ReactiveProcessor.ProcessingType.CPU_INTENSIVE intensive or neither (ReactiveProcessor.ProcessingType.CPU_LITE).
org.mule.runtime.api.metadata.DataType	getReturnDataType() Specifies the return type of the result after this transformer has been executed.
List<org.mule.runtime.api.metadata.DataType>	getSourceDataTypes() Returns an unmodifiable list of Source types registered on this transformer
boolean	isAcceptNull() Does this transformer allow null input?
boolean	isIgnoreBadInput() By default, Mule will throw an exception if a transformer is invoked with a source object that is not compatible with the transformer.
boolean	isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType) Determines if a particular source class can be handled by this transformer
void	setReturnDataType(org.mule.runtime.api.metadata.DataType type) Sets the expected return type for the transformed data.
Object	transform(Object src) Transforms the supplied data and returns the result
Object	transform(Object src, Charset encoding) Transforms the supplied data and returns the result

Methods inherited from interface org.mule.runtime.core.api.processor.Processor

apply, process

Methods inherited from interface java.util.function.Function

andThen, compose, identity

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

initialise

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

dispose

Methods inherited from interface org.mule.runtime.api.meta.NameableObject

setName

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

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

setMuleContext

Method Detail

isSourceDataTypeSupported

boolean isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType)

Determines if a particular source class can be handled by this transformer

Parameters:

dataType - The DataType to check for compatibility

Returns:

true if the transformer supports this type of class or false otherwise

Since:

3.0.0

getSourceDataTypes

List<org.mule.runtime.api.metadata.DataType> getSourceDataTypes()

Returns an unmodifiable list of Source types registered on this transformer

Returns:

an unmodifiable list of Source types registered on this transformer

Since:

3.0.0

isAcceptNull

boolean isAcceptNull()

Does this transformer allow null input?

Returns:

true if this transformer can accept null input

isIgnoreBadInput

boolean isIgnoreBadInput()

By default, Mule will throw an exception if a transformer is invoked with a source object that is not compatible with the transformer. Since transformers are often chained, it is useful to be able to ignore a transformer in the chain and move to the next one.

Returns:

true if the transformer can be ignored if the current source type is not supported, false if an exception should be throw due to an incompatible source type being passed in.

transform

Object transform(Object src)
          throws TransformerException

Transforms the supplied data and returns the result

Parameters:

src - the data to transform

Returns:

the transformed data

Throws:

TransformerException - if a error occurs transforming the data or if the expected returnClass isn't the same as the transformed data

transform

Object transform(Object src,
                 Charset encoding)
          throws TransformerException

Transforms the supplied data and returns the result

Parameters:

src - the data to transform

encoding - the encoding to use by this transformer. many transformations will not need encoding unless dealing with text so you only need to use this method if yo wish to customize the encoding

Returns:

the transformed data

Throws:

TransformerException - if a error occurs transforming the data or if the expected returnClass isn't the same as the transformed data

setReturnDataType

void setReturnDataType(org.mule.runtime.api.metadata.DataType type)

Sets the expected return type for the transformed data. If the transformed data is not of this class type a TransformerException will be thrown.

Parameters:

type - the expected return type for this transformer

Since:

3.0.0

getReturnDataType

org.mule.runtime.api.metadata.DataType getReturnDataType()

Specifies the return type of the result after this transformer has been executed. Mule will use this to validate the return type but also allow users to perform automatic transformations based on the source type of the object to transform and this return type.

Returns:

the excepted return type for this transformer

Since:

3.0.0

getProcessingType

default ReactiveProcessor.ProcessingType getProcessingType()

Description copied from interface: ReactiveProcessor

In order for Mule to determine the best way to execute different processors based on the chosen ProcessingStrategy it needs to know the type of work the message processor will be performing and if it is ReactiveProcessor.ProcessingType.BLOCKING, ReactiveProcessor.ProcessingType.CPU_INTENSIVE intensive or neither (ReactiveProcessor.ProcessingType.CPU_LITE).

Specified by:

getProcessingType in interface ReactiveProcessor

Returns:

the processing type for this processor.