Package org.apache.ignite.configuration.annotation

Annotation Interface PublicName

@Target(FIELD) @Retention(RUNTIME) @Documented public @interface PublicName
This annotation allows defining configuration property name that is otherwise impossible to define in configuration schema. For example, if it matches a keyword of the Java language, or if it results in name conflicts in generated Configuration/View classes.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    legacyNames
    An array of old deprecated names for the configuration.
    String
    value
    Public configuration property name.

  • Element Details

    • value

      String value
      Public configuration property name. This name, if present, is used to store this configuration in configuration storage and to render the configuration to the user. Empty string means that public name matches the schema field name.
      Default:
      ""

    • legacyNames

      String[] legacyNames
      An array of old deprecated names for the configuration. Any of these names should be accounted for when parsing configuration from any source, but avoided when showing to the user or saving to the configuration storage. These names should also be deleted from the corresponding configuration storage upon encountering.
      Default:
      {}