Package com.persequor.extension.configuration

Annotation Interface PropertyMetadata

@Target({TYPE,FIELD}) @Retention(RUNTIME) public @interface PropertyMetadata
Use this annotation to decide if the property should be shown in the UI and a description to what it does.

Can also be used on a class to set the default inherited visibility for all properties in the class.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of the property that will be shown in

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    PropertySensitivity
    sensitive
    Indicates if the property is sensitive.
    PropertyVisibility[]
    visibility
    Defines visibility for the property in the UI.

  • Element Details

    • description

      String description
      Description of the property that will be shown in
      Returns:
      visibility of the property.

    • visibility

      PropertyVisibility[] visibility
      Defines visibility for the property in the UI. If none is defined at property level, DEFAULT means it will fall back to config class level. If neither the property nor the config class sets this visibility flag, it means the property is going to be visible.
      Returns:
      visibility of the property.
      Default:
      {DEFAULT}

    • sensitive

      PropertySensitivity sensitive
      Indicates if the property is sensitive.

      This is usually used for keys, tokens etc. that should be masked in the UI editor.

      Currently, this is only an informative marker, it does not enforce anything when saving or loading the property.

      If set on a class, it will be inherited by all properties in the class. If the class has the value set to DEFAULT and the property does not have this set, it will fall back to NOT_SENSITIVE.

      Returns:
      the sensitivity of the property.W
      Default:
      DEFAULT