Interface ConfigOptionProvider

  • All Known Subinterfaces:
    MagicService

    @NonNullByDefault
    public interface ConfigOptionProvider
    The ConfigOptionProvider can be implemented and registered as an OSGi service to provide ConfigDescriptions options.
    Author:
    Chris Jackson - Initial contribution, Kai Kreuzer - added support for contexts
    • Method Detail

      • getParameterOptions

        default @Nullable Collection<ParameterOption> getParameterOptions​(URI uri,
                                                                          String param,
                                                                          @Nullable String context,
                                                                          @Nullable Locale locale)
        Provides a collection of ParameterOptionss.
        Parameters:
        uri - the uri of the config description
        param - the parameter name for which the requested options shall be returned
        context - the defined context of the parameter
        locale - the locale in which the result is expected
        Returns:
        the configuration options provided by this provider if any or null otherwise