View Javadoc

1   /*
2    * $Id: Payload.java 20321 2010-11-24 15:21:24Z dfeist $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.api.annotations.param;
12  
13  import org.mule.api.annotations.meta.Evaluator;
14  
15  import java.lang.annotation.Documented;
16  import java.lang.annotation.ElementType;
17  import java.lang.annotation.Retention;
18  import java.lang.annotation.RetentionPolicy;
19  import java.lang.annotation.Target;
20  
21  /**
22   * Used on components, this annotation marks the method parameter that will be used to pass in the message payload. Note that
23   * the parameter type will be used to do any auto conversions using transformers available inside the Mule container. Mule has
24   * a number of standard transformers for dealing with common Java types such as XML documents, streams, byte arrays, strings, etc.
25   * It is also very easy for users to define their own using the {@link org.mule.api.annotations.Transformer} annotation. 
26   *
27   * @see org.mule.api.annotations.Transformer
28   */
29  @Target(ElementType.PARAMETER)
30  @Retention(RetentionPolicy.RUNTIME)
31  @Documented
32  @Evaluator("payload")
33  public @interface Payload
34  {
35  }