public interface Config
Resolves the property value by searching through all configured
ConfigSources. If the same property is specified in multiple
ConfigSources, the value in the ConfigSource with the highest
ordinal will be used.
If multiple ConfigSources are specified with
the same ordinal, the ConfigSource.getName() will be used for sorting.
The config objects produced via the injection model
@Inject Configare guaranteed to be serializable, while the programmatically created ones are not required to be serializable.
If one or more converters are registered for a class of a requested value then one of the registered converters
which has the highest priority is used to convert the string value retrieved from config sources.
The highest priority means the highest priority number.
For more information about converters, see Converter
ConfigProvider:
public void doSomething(
Config cfg = ConfigProvider.getConfig();
String archiveUrl = cfg.getString("my.project.archive.endpoint", String.class);
Integer archivePort = cfg.getValue("my.project.archive.port", Integer.class);
It is also possible to inject the Config if a DI container is available:
public class MyService {
@Inject
private Config config;
}
See getValue(String, Class) and getOptionalValue(String, Class) for accessing a configured value.
Configured values can also be accessed via injection.
See ConfigProperty for more information.
| Modifier and Type | Method and Description |
|---|---|
java.lang.Iterable<ConfigSource> |
getConfigSources() |
<T> java.util.Optional<T> |
getOptionalValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property value with the specified type for the
specified property name from the underlying
ConfigSources. |
java.lang.Iterable<java.lang.String> |
getPropertyNames()
Return a collection of property names.
|
<T> T |
getValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property value with the specified type for the
specified property name from the underlying
ConfigSources. |
<T> T getValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
ConfigSources.
If this method gets used very often then consider to locally store the configured value.T - The property typepropertyName - The configuration propertyName.propertyType - The type into which the resolve property value should get convertedjava.lang.IllegalArgumentException - if the property cannot be converted to the specified type.java.util.NoSuchElementException - if the property isn't present in the configuration.<T> java.util.Optional<T> getOptionalValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
ConfigSources.
If this method is used very often then consider to locally store the configured value.T - The property typepropertyName - The configuration propertyName.propertyType - The type into which the resolve property value should be convertedjava.lang.IllegalArgumentException - if the property cannot be converted to the specified type.java.lang.Iterable<java.lang.String> getPropertyNames()
java.lang.Iterable<ConfigSource> getConfigSources()
configsources sorted with descending ordinal and ConfigSource name