DefaultEventBuilder (Mule Core 4.0.0-BETA.4 API)

java.lang.Object
- org.mule.runtime.core.message.DefaultEventBuilder

All Implemented Interfaces:: Event.Builder

public class DefaultEventBuilder
extends Object
implements Event.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultEventBuilder.EventImplementation
EventImplementation represents any data event occurring in the Mule environment.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultEventBuilder.EventImplementation` `EventImplementation` represents any data event occurring in the Mule environment.

Constructor Summary

Constructors
Constructor and Description
`DefaultEventBuilder(Event event)`
`DefaultEventBuilder(EventContext messageContext)`
`DefaultEventBuilder(EventContext messageContext, Event event)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Event.Builder`	`addVariable(String key, Object value)` Add a variable.
`Event.Builder`	`addVariable(String key, Object value, org.mule.runtime.api.metadata.DataType dataType)` Add a variable.
`Event`	`build()` Build a new `Event` based on the state configured in the `Event.Builder`.
`Event.Builder`	`correlationId(String correlationId)` Set correlationId overriding the correlationId from `EventContext.getCorrelationId()` that came from the source system or that was configured in the connector source.
`Event.Builder`	`disableNotifications()` Disables the firing of notifications when processing the produced event.
`Event.Builder`	`error(org.mule.runtime.api.message.Error error)` Sets an error related to the produced event.
`Event.Builder`	`flow(FlowConstruct flow)`
`Event.Builder`	`groupCorrelation(GroupCorrelation correlation)` Sets the group correlation information to the produced event.
`Event.Builder`	`message(org.mule.runtime.api.message.Message message)` Set the `Message` to construct `Event` with.
`Event.Builder`	`parameters(Map<String,Object> parameters)` Set a map of parameters to be consumed within a `ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain`.
`Event.Builder`	`properties(Map<String,Object> properties)` Set a map of properties to be consumed within a `ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain`.
`Event.Builder`	`removeParameter(String key)` Remove a parameter.
`Event.Builder`	`removeVariable(String key)` Remove a variable.
`Event.Builder`	`replyToDestination(Object replyToDestination)`
`Event.Builder`	`replyToHandler(ReplyToHandler replyToHandler)`
`Event.Builder`	`session(MuleSession session)`
`Event.Builder`	`variables(Map<String,Object> flowVariables)` Set a map of variables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultEventBuilder
```
public DefaultEventBuilder(EventContext messageContext)
```
  - DefaultEventBuilder
```
public DefaultEventBuilder(Event event)
```
  - DefaultEventBuilder
```
public DefaultEventBuilder(EventContext messageContext,
                           Event event)
```
- Method Detail
  - message
```
public Event.Builder message(org.mule.runtime.api.message.Message message)
```
    Description copied from interface: Event.Builder
    
    Set the Message to construct Event with.
    
    Specified by:
    
    message in interface Event.Builder
    
    Parameters:
    
    message - the message instance.
    
    Returns:
    
    the builder instance
  - variables
```
public Event.Builder variables(Map<String,Object> flowVariables)
```
    Description copied from interface: Event.Builder
    
    Set a map of variables. Any existing variables added to the builder will be removed.
    
    Specified by:
    
    variables in interface Event.Builder
    
    Parameters:
    
    flowVariables - variables to be set.
    
    Returns:
    
    the builder instance
  - addVariable
```
public Event.Builder addVariable(String key,
                                 Object value)
```
    Description copied from interface: Event.Builder
    
    Add a variable.
    
    Specified by:
    
    addVariable in interface Event.Builder
    
    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 Event.Builder addVariable(String key,
                                 Object value,
                                 org.mule.runtime.api.metadata.DataType dataType)
```
    Description copied from interface: Event.Builder
    
    Add a variable.
    
    Specified by:
    
    addVariable in interface Event.Builder
    
    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
  - removeVariable
```
public Event.Builder removeVariable(String key)
```
    Description copied from interface: Event.Builder
    
    Remove a variable.
    
    Specified by:
    
    removeVariable in interface Event.Builder
    
    Parameters:
    
    key - the variable key.
    
    Returns:
    
    the builder instance
  - properties
```
public Event.Builder properties(Map<String,Object> properties)
```
    Description copied from interface: Event.Builder
    
    Set a map of properties to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.
    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 Event.Builder
    
    Parameters:
    
    properties - properties to be set.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Event.Builder.parameters(Map)
  - parameters
```
public Event.Builder parameters(Map<String,Object> parameters)
```
    Description copied from interface: Event.Builder
    
    Set a map of parameters to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.
    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 Event.Builder
    
    Parameters:
    
    parameters - parameters to be set.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Event.Builder.properties(Map)
  - removeParameter
```
public Event.Builder removeParameter(String key)
```
    Description copied from interface: Event.Builder
    
    Remove a parameter.
    
    Specified by:
    
    removeParameter in interface Event.Builder
    
    Parameters:
    
    key - the parameter key.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Event.Builder.parameters(Map)
  - correlationId
```
public Event.Builder correlationId(String correlationId)
```
    Description copied from interface: Event.Builder
    
    Set correlationId overriding the correlationId from EventContext.getCorrelationId() that came from the source system or that was configured in the connector source. This is only used to support transports and should not be used otherwise.
    
    Specified by:
    
    correlationId in interface Event.Builder
    
    Parameters:
    
    correlationId - to override existing correlationId
    
    Returns:
    
    the builder instance
  - groupCorrelation
```
public Event.Builder groupCorrelation(GroupCorrelation correlation)
```
    Description copied from interface: Event.Builder
    
    Sets the group correlation information to the produced event.
    
    Specified by:
    
    groupCorrelation in interface Event.Builder
    
    Parameters:
    
    correlation - the object containing the group correlation information to set on the produced event
    
    Returns:
    
    the builder instance
  - error
```
public Event.Builder error(org.mule.runtime.api.message.Error error)
```
    Description copied from interface: Event.Builder
    
    Sets an error related to the produced event.
    
    Specified by:
    
    error in interface Event.Builder
    
    Parameters:
    
    error - the error associated with the produced event
    
    Returns:
    
    the builder instance
  - flow
```
public Event.Builder flow(FlowConstruct flow)
```
    Specified by:
    
    flow in interface Event.Builder
    
    Returns:
    
    the builder instance
  - replyToHandler
```
public Event.Builder replyToHandler(ReplyToHandler replyToHandler)
```
    Specified by:
    
    replyToHandler in interface Event.Builder
    
    Returns:
    
    the builder instance
  - replyToDestination
```
public Event.Builder replyToDestination(Object replyToDestination)
```
    Specified by:
    
    replyToDestination in interface Event.Builder
    
    Returns:
    
    the builder instance
  - session
```
public Event.Builder session(MuleSession session)
```
    Specified by:
    
    session in interface Event.Builder
    
    Returns:
    
    the builder instance
  - disableNotifications
```
public Event.Builder disableNotifications()
```
    Description copied from interface: Event.Builder
    
    Disables the firing of notifications when processing the produced event.
    
    Specified by:
    
    disableNotifications in interface Event.Builder
  - build
```
public Event build()
```
    Description copied from interface: Event.Builder
    
    Build a new Event based on the state configured in the Event.Builder.
    
    Specified by:
    
    build in interface Event.Builder
    
    Returns:
    
    new Event instance.

Class DefaultEventBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultEventBuilder

DefaultEventBuilder

DefaultEventBuilder

Method Detail

message

variables

addVariable

addVariable

removeVariable

properties

parameters

removeParameter

correlationId

groupCorrelation

error

flow

replyToHandler

replyToDestination

session

disableNotifications

build