Module io.annot8.core
Package io.annot8.core.settings

Annotation Type Parameter


  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface Parameter
    Declares a parameter within a settings class.

    This should be set on the get method for a parameter, and it may generally be assumed that there is a corresponding set method.

    All parameters must have a default value of some description, and therefore no parameters are required.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String description
      A description of this parameter
      String key
      The configuration key associated with this parameter

    • Element Detail

      • key

        String key
        The configuration key associated with this parameter
        Returns:
        the key

      • description

        String description
        A description of this parameter
        Returns:
        description