Module org.mule.sdk.api
Package org.mule.sdk.api.annotation.param.display

Annotation Interface DisplayName

@Target({PARAMETER,FIELD,METHOD,TYPE}) @Retention(RUNTIME) @Documented @MinMuleVersion("4.5.0") @DoNotEnforceMinMuleVersion public @interface DisplayName
Allows to specify a custom label for the element and/or field to be used in the UI. If a value is not specified, the name is inferred from the annotated element's name.

Use this annotation to override the default inferred nickname for a Parameter, an operation, an operation's parameter, Source, Configuration and ConnectionProvider.

Since:
1.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    The value is a short name for the annotated element.

  • Element Details

    • value

      String value
      The value is a short name for the annotated element. If this value is not specified it will be inferred from the annotated element name.
      Default:
      ""