org.mule.runtime.internal.event

Class DefaultInputEvent

java.lang.Object

org.mule.runtime.internal.event.DefaultInputEvent

All Implemented Interfaces:

InputEvent

public class DefaultInputEvent
extends Object
implements InputEvent

Default implementation for InputEvent.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DefaultInputEvent()
DefaultInputEvent(Event event)
DefaultInputEvent(InputEvent inputEvent)

Method Summary

Modifier and Type	Method and Description
InputEvent	addParameter(String key, Object value) Add a parameter.
InputEvent	addParameter(String key, Object value, DataType dataType) Add a parameter.
InputEvent	addVariable(String key, Object value) Add a variable.
InputEvent	addVariable(String key, Object value, DataType dataType) Add a variable.
InputEvent	error(Error error) Sets an error related to the produced event.
Optional<Error>	getError() When a mule component throws an error then an Error object gets generated with all the data associated to the error.
Message	getMessage() Returns the message payload for this event
Map<String,TypedValue<?>>	getParameters() Returns the parameters in the event
Map<String,TypedValue<?>>	getProperties() Returns the properties in the event
Map<String,TypedValue<?>>	getVariables() Returns the variables in the event
InputEvent	message(Message message) Set the Message to construct Event with.
InputEvent	parameters(Map<String,Object> parameters) Set a map of parameters to be consumed within a XML connector operation
InputEvent	properties(Map<String,Object> properties) Set a map of properties to be consumed within a XML connector operation
InputEvent	variables(Map<String,?> variables) Set a map of variables.

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.api.event.InputEvent

create, create, create

Constructor Detail

DefaultInputEvent

public DefaultInputEvent()

DefaultInputEvent

public DefaultInputEvent(Event event)

DefaultInputEvent

public DefaultInputEvent(InputEvent inputEvent)

Method Detail

message

public InputEvent message(Message message)

Description copied from interface: InputEvent

Set the Message to construct Event with.

Specified by:

message in interface InputEvent

Parameters:

message - the message instance.

Returns:

the builder instance

variables

public InputEvent variables(Map<String,?> variables)

Description copied from interface: InputEvent

Set a map of variables. Any existing variables added to the builder will be removed.

Specified by:

variables in interface InputEvent

Parameters:

variables - variables to be set.

Returns:

the builder instance

addVariable

public InputEvent addVariable(String key,
                              Object value)

Description copied from interface: InputEvent

Add a variable.

Specified by:

addVariable in interface InputEvent

Parameters:

key - the key of the variable to add.

value - the value of the variable to add. null values are supported.

Returns:

the builder instance.

addVariable

public InputEvent addVariable(String key,
                              Object value,
                              DataType dataType)

Description copied from interface: InputEvent

Add a variable.

Specified by:

addVariable in interface InputEvent

Parameters:

key - the key of the variable to add.

value - the value of the variable to add. null values are supported.

dataType - additional metadata about the value type.

Returns:

the builder instance

properties

public InputEvent properties(Map<String,Object> properties)

Description copied from interface: InputEvent

Set a map of properties to be consumed within a XML connector operation

For every module's being consumed in a Mule Application, when being macro expanded, these properties will be feed to it in a new and isolated Event, so that we can guarantee that for each invocation there's a real variable scoping for them.

Specified by:

properties in interface InputEvent

Parameters:

properties - properties to be set.

Returns:

the builder instance

See Also:

InputEvent.parameters(Map)

parameters

public InputEvent parameters(Map<String,Object> parameters)

Description copied from interface: InputEvent

Set a map of parameters to be consumed within a XML connector operation

For every module's being consumed in a Mule Application, when being macro expanded, these parameters will be feed to it in a new and isolated Event, so that we can guarantee that for each invocation there's a real variable scoping for them.

Specified by:

parameters in interface InputEvent

Parameters:

parameters - parameters to be set.

Returns:

the builder instance

See Also:

InputEvent.properties(Map)

addParameter

public InputEvent addParameter(String key,
                               Object value)

Description copied from interface: InputEvent

Add a parameter.

Specified by:

addParameter in interface InputEvent

Parameters:

key - the key of the parameter to add.

value - the value of the variable to add. null values are supported.

Returns:

the builder instance.

addParameter

public InputEvent addParameter(String key,
                               Object value,
                               DataType dataType)

Description copied from interface: InputEvent

Add a parameter.

Specified by:

addParameter in interface InputEvent

Parameters:

key - the key of the parameter to add.

value - the value of the parameter to add. null values are supported.

dataType - additional metadata about the value type.

Returns:

the builder instance

error

public InputEvent error(Error error)

Description copied from interface: InputEvent

Sets an error related to the produced event.

Specified by:

error in interface InputEvent

Parameters:

error - the error associated with the produced event

Returns:

the builder instance

getVariables

public Map<String,TypedValue<?>> getVariables()

Description copied from interface: InputEvent

Returns the variables in the event

Specified by:

getVariables in interface InputEvent

Returns:

a map of TypedValue containing the variable's names and values.

getParameters

public Map<String,TypedValue<?>> getParameters()

Description copied from interface: InputEvent

Returns the parameters in the event

Specified by:

getParameters in interface InputEvent

Returns:

a map of TypedValue containing the parameter's names and values.

getProperties

public Map<String,TypedValue<?>> getProperties()

Description copied from interface: InputEvent

Returns the properties in the event

Specified by:

getProperties in interface InputEvent

Returns:

a map of TypedValue containing the properties's names and values.

getMessage

public Message getMessage()

Description copied from interface: InputEvent

Returns the message payload for this event

Specified by:

getMessage in interface InputEvent

Returns:

the message payload for this event

getError

public Optional<Error> getError()

Description copied from interface: InputEvent

When a mule component throws an error then an Error object gets generated with all the data associated to the error. This field will only contain a value within the error handler defined to handle errors. After the error handler is executed the event error field will be cleared. If another flow is called from within the error handler the flow will still have access to the error field. To avoid losing the error field after the error handler the user can define a variable pointing to the error field.

Specified by:

getError in interface InputEvent

Returns:

an optional of the error associated with the event. Will be empty if there's no error associated with the event.