org.mule.runtime.core.transformer

Class CompositeConverter

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.transformer.CompositeConverter

All Implemented Interfaces:

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

public class CompositeConverter
extends org.mule.runtime.api.meta.AbstractAnnotatedObject
implements Converter, MuleContextAware

Composes many converters to behave as a single one.

When transform(Object) is called each converter in the same order they are included in the composition. The output of a given converter is the input of the next composed converter.

Nested Class Summary

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

ReactiveProcessor.ProcessingType

Field Summary

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

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

DEFAULT_PRIORITY_WEIGHTING, MAX_PRIORITY_WEIGHTING, MIN_PRIORITY_WEIGHTING

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

PHASE_NAME

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

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
CompositeConverter(Converter... converters) Create a new conversion chain using the specified converters

Method Summary

Modifier and Type	Method and Description
void	dispose()
LinkedList<Converter>	getConverters()
String	getName()
int	getPriorityWeighting() If two or more discoverable transformers are equal, this value can be used to select the correct one
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
void	initialise()
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
Event	process(Event event) Invokes the MessageProcessor.
void	setMuleContext(MuleContext context)
void	setName(String name)
void	setPriorityWeighting(int weighting) If 2 or more discoverable transformers are equal, this value can be used to select the correct one
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 class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.api.transformer.Converter

getProcessingType

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

CompositeConverter

public CompositeConverter(Converter... converters)

Create a new conversion chain using the specified converters

Parameters:

converters - List of converters using to build the chain

Method Detail

isSourceDataTypeSupported

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

Description copied from interface: Transformer

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

Specified by:

isSourceDataTypeSupported in interface Transformer

Parameters:

dataType - The DataType to check for compatibility

Returns:

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

getSourceDataTypes

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

Description copied from interface: Transformer

Returns an unmodifiable list of Source types registered on this transformer

Specified by:

getSourceDataTypes in interface Transformer

Returns:

an unmodifiable list of Source types registered on this transformer

isAcceptNull

public boolean isAcceptNull()

Description copied from interface: Transformer

Does this transformer allow null input?

Specified by:

isAcceptNull in interface Transformer

Returns:

true if this transformer can accept null input

isIgnoreBadInput

public boolean isIgnoreBadInput()

Description copied from interface: Transformer

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.

Specified by:

isIgnoreBadInput in interface Transformer

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

public Object transform(Object src)
                 throws TransformerException

Description copied from interface: Transformer

Transforms the supplied data and returns the result

Specified by:

transform in interface Transformer

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

public Object transform(Object src,
                        Charset encoding)
                 throws TransformerException

Description copied from interface: Transformer

Transforms the supplied data and returns the result

Specified by:

transform in interface Transformer

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

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

Description copied from interface: Transformer

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

Specified by:

setReturnDataType in interface Transformer

Parameters:

type - the expected return type for this transformer

getReturnDataType

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

Description copied from interface: Transformer

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.

Specified by:

getReturnDataType in interface Transformer

Returns:

the excepted return type for this transformer

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

process

public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Processor

Invokes the MessageProcessor.

Specified by:

process in interface Processor

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

org.mule.runtime.api.exception.MuleException

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Parameters:

context - the Mule node.

setName

public void setName(String name)

Specified by:

setName in interface org.mule.runtime.api.meta.NameableObject

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

getPriorityWeighting

public int getPriorityWeighting()

Description copied from interface: Converter

If two or more discoverable transformers are equal, this value can be used to select the correct one

Specified by:

getPriorityWeighting in interface Converter

Returns:

the priority weighting for this transformer. This is a value between Converter.MIN_PRIORITY_WEIGHTING and Converter.MAX_PRIORITY_WEIGHTING.

setPriorityWeighting

public void setPriorityWeighting(int weighting)

Description copied from interface: Converter

If 2 or more discoverable transformers are equal, this value can be used to select the correct one

Specified by:

setPriorityWeighting in interface Converter

Parameters:

weighting - the priority weighting for this transformer. This is a value between Converter.MIN_PRIORITY_WEIGHTING and Converter.MAX_PRIORITY_WEIGHTING.

getConverters

public LinkedList<Converter> getConverters()