Contact Us 1-800-596-4880
  1. Homepage
  2. Mule Runtime (3.7)
  3. Developing
  4. Transformers
  5. Creating Custom Transformers

  6. Payload Annotation

@Payload Annotation

Mule Runtime Engine versions 3.5, 3.6, and 3.7 reached End of Life on or before January 25, 2020. For more information, contact your Customer Success Manager to determine how you can migrate to the latest Mule version.

A parameter injection annotation that can be used on component entry points and transformer methods defined using the @Transformer annotation, this annotation controls how the current message payload is passed into a method by performing automatic transformation of the message payload to match the annotated parameter type. For example, if you are expecting an XML document, this can be injected into a component entry point and automatically converted into a org.wc3.dom.Document.

public class MyComponent {
    public Object process(@Payload Document doc) {
        // do stuff
    }
}

Annotated Component Methods

Note that when using Annotations on component methods, all parameters need to be annotated for the method to be invoked. You will almost always be using the @Payload annotation to mark the message payload parameter.