Package org.nuiton.config
Interface ApplicationConfigProvider
-
public interface ApplicationConfigProvider
Provider of aApplicationConfig
. Each library of application which useApplicationConfig
should implements this and add the provider available via theServiceLoader
mecanism. Using such provider offers a nice way to find out what options can be loaded in a application. It also offers a simply way to generate application config report for documentation.- Since:
- 1.4.8
- Author:
- Tony Chemit - dev@tchemit.fr
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConfigActionDef[]
getActions()
Returns all actions offered by the configuration.String
getDescription(Locale locale)
Returns the localized description of the configuration.String
getName()
Returns the name of the provided application config.ConfigOptionDef[]
getOptions()
Returns all options offered by the configuration.
-
-
-
Method Detail
-
getName
String getName()
Returns the name of the provided application config. This should be the name of the library or application which offers the configuration.- Returns:
- the name of the provided application config
-
getDescription
String getDescription(Locale locale)
Returns the localized description of the configuration.- Parameters:
locale
- locale used to render description- Returns:
- the localized description of the configuration
-
getOptions
ConfigOptionDef[] getOptions()
Returns all options offered by the configuration.- Returns:
- all options offered by the configuration
- See Also:
ConfigOptionDef
-
getActions
ConfigActionDef[] getActions()
Returns all actions offered by the configuration.- Returns:
- all actions offered by the configuration.
- See Also:
ConfigActionDef
-
-