Annotation Type Setting


  • @Inherited
    @Documented
    @Target(METHOD)
    @Retention(RUNTIME)
    public @interface Setting
    Annotation that should be applied to a method that takes a single Setting as a parameter. The parameter of this method should be of the same type as the type of the associated org.n52.faroe.SettingDefinition. It is needed to apply the Configurable annotation to a class with a method annotated with this annotations for the SettingsManager to recognize it. Example usage:
     @Setting(MiscellaneousSettingDefinitions.TOKEN_SEPERATOR_KEY)
     public void setTokenSeperator(String separator) {
         this.separator = separator;
     }
     
    Since:
    1.0.0
    See Also:
    Configurable
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      The key of the setting.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean required
      If this setting is required.
    • Element Detail

      • value

        String value
        The key of the setting.
        Returns:
        the key
      • required

        boolean required
        If this setting is required.
        Returns:
        if it is required
        Default:
        true