Annotation Type SettingsClass



  • @Documented
    @Retention(RUNTIME)
    @Target(TYPE)
    @Repeatable(SettingsClasses.class)
    public @interface SettingsClass
    Specify which class is to be used for settings by a component.

    Note that whilst from a configuration perspective the annotation is inherited (ie you can configure the parent, from a Java perspective is it not - the settings class applues to the class they are defined on)

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      Class<? extends Settings> value
      The class used by this component to hold it's settings
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean optional
      Is the content required for the component to function?
    • Element Detail

      • value

        Class<? extends Settings> value
        The class used by this component to hold it's settings
        Returns:
        settings class
      • optional

        boolean optional
        Is the content required for the component to function?
        Returns:
        true if optional, default is false
        Default:
        false