Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.annotation

Annotation Interface Alias

@MinMuleVersion("4.1") @Target({TYPE,FIELD,PARAMETER,METHOD}) @Retention(RUNTIME) @Documented public @interface Alias
Defines an alias for a Java type. Implementations of the extensions API can use this annotation in many ways, but in general terms it's useful to allow a Java type to have a name which makes sense from a coding point of view while maintaining a user friendly name in the places where the extensions API exposes such type
Since:
1.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    An optional description to further describe the annotated member

  • Element Details

    • value

      String value
      Returns:
      The alias of the annotated member

    • description

      String description
      An optional description to further describe the annotated member
      Returns:
      a nullable String
      Default:
      ""