Package org.opentcs.configuration

Annotation Type ConfigurationEntry

@Target(METHOD)
@Retention(RUNTIME)
@Documented
public @interface ConfigurationEntry
Marks an interface's method that provides a configuration value.

  • Required Element Summary

    Required Elements 
    Modifier and Type Required Element Description
    java.lang.String[] description
    Returns a list of paragraphs describing what the key/value configures.
    java.lang.String type
    Returns a description for the data type of this configuration key's values.

  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    ConfigurationEntry.ChangesApplied changesApplied
    Indicates when changes to the configuration entry's value are applied.
    java.lang.String orderKey
    Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).

  • Element Details

    • type

      java.lang.String type
      Returns a description for the data type of this configuration key's values.
      Returns:
      A description for the data type of this configuration key's values.

    • description

      java.lang.String[] description
      Returns a list of paragraphs describing what the key/value configures.
      Returns:
      A list of paragraphs describing what the key/value configures.

    • changesApplied

      ConfigurationEntry.ChangesApplied changesApplied
      Indicates when changes to the configuration entry's value are applied.
      Returns:
      A value indicating when changes to the configuration entry's value are applied.
      Default:
      org.opentcs.configuration.ConfigurationEntry.ChangesApplied.UNSPECIFIED

    • orderKey

      java.lang.String orderKey
      Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).
      Returns:
      The optional ordering key that this entry belongs to (for grouping/sorting of entries).
      Default:
      ""