Index (ph-config 12.0.0 API)

A C D E F G H I M O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractConfigurationSource - Class in com.helger.config.source: Abstract base class for any configuration source.
AbstractConfigurationSource(EConfigSourceType, int) - Constructor for class com.helger.config.source.AbstractConfigurationSource: Constructor
AbstractConfigurationSourceResource - Class in com.helger.config.source.resource: Abstract implementation of IConfigurationSource for file based configuration sources.
AbstractConfigurationSourceResource(int, IReadableResource) - Constructor for class com.helger.config.source.resource.AbstractConfigurationSourceResource
addConfigurationSource(IConfigurationSource) - Method in class com.helger.config.source.MultiConfigurationValueProvider: Add a configuration source.
addConfigurationSource(IConfigurationValueProvider, int) - Method in class com.helger.config.source.MultiConfigurationValueProvider: Add a configuration value provider and a priority.
APPLICATION - Enum constant in enum class com.helger.config.source.EConfigSourceType: A configuration value from any other source inside the application.
APPLICATION_PROPERTIES_NAME - Static variable in class com.helger.config.ConfigFactory
APPLICATION_PROPERTIES_PRIORITY - Static variable in class com.helger.config.ConfigFactory

C

com.helger.config - package com.helger.config
com.helger.config.fallback - package com.helger.config.fallback
com.helger.config.source - package com.helger.config.source
com.helger.config.source.appl - package com.helger.config.source.appl
com.helger.config.source.envvar - package com.helger.config.source.envvar
com.helger.config.source.resource - package com.helger.config.source.resource
com.helger.config.source.resource.properties - package com.helger.config.source.resource.properties
com.helger.config.source.resource.type - package com.helger.config.source.resource.type
com.helger.config.source.sysprop - package com.helger.config.source.sysprop
com.helger.config.value - package com.helger.config.value
Config - Class in com.helger.config: Default implementation of IConfig.
Config(IConfigurationValueProvider) - Constructor for class com.helger.config.Config: Constructor
CONFIG_SOURCE_TYPE - Static variable in class com.helger.config.source.resource.AbstractConfigurationSourceResource
ConfigFactory - Class in com.helger.config: Factory for creating IConfig objects.
ConfigurationSourceEnvVar - Class in com.helger.config.source.envvar: Default implementation of IConfigurationSource for environment variables.
ConfigurationSourceEnvVar() - Constructor for class com.helger.config.source.envvar.ConfigurationSourceEnvVar
ConfigurationSourceEnvVar(int) - Constructor for class com.helger.config.source.envvar.ConfigurationSourceEnvVar
ConfigurationSourceFunction - Class in com.helger.config.source.appl: Default implementation of IConfigurationSource for application based configuration sources.
ConfigurationSourceFunction(int, UnaryOperator<String>) - Constructor for class com.helger.config.source.appl.ConfigurationSourceFunction: Constructor
ConfigurationSourceFunction(UnaryOperator<String>) - Constructor for class com.helger.config.source.appl.ConfigurationSourceFunction: Constructor with default priority
ConfigurationSourceProperties - Class in com.helger.config.source.resource.properties: Implementation of IConfigurationSource for properties file based configuration sources.
ConfigurationSourceProperties(int, IReadableResource) - Constructor for class com.helger.config.source.resource.properties.ConfigurationSourceProperties: Constructor with default charset
ConfigurationSourceProperties(int, IReadableResource, Charset) - Constructor for class com.helger.config.source.resource.properties.ConfigurationSourceProperties: Constructor
ConfigurationSourceProperties(IReadableResource) - Constructor for class com.helger.config.source.resource.properties.ConfigurationSourceProperties: Constructor with default priority and default charset
ConfigurationSourceProperties(IReadableResource, Charset) - Constructor for class com.helger.config.source.resource.properties.ConfigurationSourceProperties: Constructor with default priority
ConfigurationSourceResourceTypeRegistry - Class in com.helger.config.source.resource.type: Global registry mapping from a file extension to a factory to read these configuration sources.
ConfigurationSourceSystemProperty - Class in com.helger.config.source.sysprop: Default implementation of IConfigurationSource for system properties.
ConfigurationSourceSystemProperty() - Constructor for class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
ConfigurationSourceSystemProperty(int) - Constructor for class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
ConfiguredValue - Class in com.helger.config.value: This class represents a resolved configuration value.
ConfiguredValue(IConfigurationSource, String) - Constructor for class com.helger.config.value.ConfiguredValue
ConfigWithFallback - Class in com.helger.config.fallback: The default implementation of IConfigWithFallback.
ConfigWithFallback(IConfigurationValueProvider) - Constructor for class com.helger.config.fallback.ConfigWithFallback
create(IConfigurationValueProvider) - Static method in class com.helger.config.Config
createDefaultResourceProviderChain() - Static method in class com.helger.config.ConfigFactory
createDefaultValueProvider() - Static method in class com.helger.config.ConfigFactory: Create a configuration value provider, with the following configuration sources: Query system properties - names are takes "as are" - priority 400. Environment variables.
createForAllOccurrances(ClassLoader, String, Function<URL, IConfigurationSource>, boolean) - Static method in class com.helger.config.source.MultiConfigurationValueProvider: Load all classpath elements and files with the same name.
createForClassPath(ClassLoader, String, Function<URL, IConfigurationSource>) - Static method in class com.helger.config.source.MultiConfigurationValueProvider: Load all classpath elements with the same name.
createValueProviderSystemOnly() - Static method in class com.helger.config.ConfigFactory: Create a configuration value provider, with the following configuration sources: Query system properties - names are takes "as are" - priority 400. Environment variables.

D

DEFAULT_OUTDATED_NOTIFIER - Static variable in class com.helger.config.fallback.ConfigWithFallback: The default implementation that just logs a warning.
DEFAULT_REPLACE_VARIABLES - Static variable in class com.helger.config.Config: For backwards compatibility reason, variable replacement is enabled by default since v11.0.2.
DEFAULT_REPLACEMENT_CHAR - Static variable in class com.helger.config.source.envvar.EnvVarHelper
DEFAULT_UNRESOLVED_VARIABLE_PROVIDER - Static variable in class com.helger.config.Config
DEFAULT_USE_ONLY_INTIIALIZED_CONFIG_SOURCES - Static variable in class com.helger.config.source.MultiConfigurationValueProvider
DEFAULT_USE_VARIABLE_DEFAULT_VALUES - Static variable in class com.helger.config.Config: By default the usage of variable default is allowed.
DefaultConfigurationSourceResourceTypeRegistrarSPI - Class in com.helger.config.source.resource.type: The default SPI implementation that registers the properties resource type
DefaultConfigurationSourceResourceTypeRegistrarSPI() - Constructor for class com.helger.config.source.resource.type.DefaultConfigurationSourceResourceTypeRegistrarSPI

E

EConfigSourceType - Enum Class in com.helger.config.source: Defines the type of configuration sources and the respective default priority.
ENVIRONMENT_VARIABLE - Enum constant in enum class com.helger.config.source.EConfigSourceType: A configuration value from an environment variable.
EnvVarHelper - Class in com.helger.config.source.envvar: Helper functions for environment variables
equals(Object) - Method in class com.helger.config.source.AbstractConfigurationSource
equals(Object) - Method in class com.helger.config.source.appl.ConfigurationSourceFunction
equals(Object) - Method in class com.helger.config.source.resource.AbstractConfigurationSourceResource
equals(Object) - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties

F

FILE_EXT - Static variable in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
forEachConfigurationValueProvider(IConfigurationValueProviderWithPriorityCallback) - Method in class com.helger.config.Config
forEachConfigurationValueProvider(IConfigurationValueProviderWithPriorityCallback) - Method in interface com.helger.config.IConfig: Enumerate all contained configuration value provider.
forEachConfigurationValueProvider(IConfigurationValueProviderWithPriorityCallback) - Method in class com.helger.config.source.MultiConfigurationValueProvider: Scan through all added configuration sources and invoke the callback.
forEachConfigurationValueProviderRecursive(IConfigurationValueProvider, IConfigurationValueProviderWithPriorityCallback) - Static method in class com.helger.config.Config

G

getAllConfigItems() - Method in class com.helger.config.source.envvar.ConfigurationSourceEnvVar
getAllConfigItems() - Method in interface com.helger.config.source.IIterableConfigurationSource
getAllConfigItems() - Method in interface com.helger.config.source.resource.IConfigurationSourceResource
getAllConfigItems() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
getAllConfigItems() - Method in class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
getAllConfiguredValues() - Method in interface com.helger.config.source.IIterableConfigurationSource
getAsBigDecimalOrFallback(String, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getAsBigDecimalOrFallback(String, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the configuration value as a BigDecimal based on the primary or the alternative keys.
getAsCharArrayOrFallback(String, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getAsCharArrayOrFallback(String, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the configuration value as a char array based on the primary or the alternative keys.
getAsIntOrFallback(String, int, int, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getAsIntOrFallback(String, int, int, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the configuration value as a int based on the primary or the alternative keys.
getAsLongOrFallback(String, long, long, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getAsLongOrFallback(String, long, long, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the configuration value as a long based on the primary or the alternative keys.
getAsStringOrFallback(String, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getAsStringOrFallback(String, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the configuration value as a String based on the primary or the alternative keys.
getCharset() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
getClone() - Method in class com.helger.config.source.MultiConfigurationValueProvider: Return a deep clone of this MultiConfigurationValueProvider.
getConfigurationSource() - Method in class com.helger.config.value.ConfiguredValue
getConfigurationSourceCount() - Method in class com.helger.config.source.MultiConfigurationValueProvider
getConfigurationValue(String) - Method in class com.helger.config.source.appl.ConfigurationSourceFunction
getConfigurationValue(String) - Method in class com.helger.config.source.envvar.ConfigurationSourceEnvVar
getConfigurationValue(String) - Method in class com.helger.config.source.MultiConfigurationValueProvider
getConfigurationValue(String) - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
getConfigurationValue(String) - Method in class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
getConfigurationValue(String) - Method in interface com.helger.config.value.IConfigurationValueProvider: Get the configuration value with the provided key.
getConfigurationValueProvider() - Method in class com.helger.config.Config
getConfiguredValue(String) - Method in class com.helger.config.Config
getConfiguredValue(String) - Method in interface com.helger.config.IConfig: Get the configured value, which is the combination of the matching configuration source and the value, for the provided key.
getConfiguredValueOrFallback(String, String...) - Method in class com.helger.config.fallback.ConfigWithFallback
getConfiguredValueOrFallback(String, String...) - Method in interface com.helger.config.fallback.IConfigWithFallback: Get the ConfiguredValue based on the primary or the alternative keys.
getDefaultConfig() - Static method in class com.helger.config.ConfigFactory: Get the default IConfig instance.
getDefaultPriority() - Method in enum class com.helger.config.source.EConfigSourceType
getFactoryOfFileExtension(String) - Method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
getFactoryOfFileExtensionOrFallback(String, String) - Method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
getFoundKeyConsumer() - Method in class com.helger.config.Config
getFromIDOrNull(String) - Static method in enum class com.helger.config.source.EConfigSourceType
getID() - Method in enum class com.helger.config.source.EConfigSourceType
getInstance() - Static method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
getKeyNotFoundConsumer() - Method in class com.helger.config.Config
getOutdatedNotifier() - Method in class com.helger.config.fallback.ConfigWithFallback
getPriority() - Method in class com.helger.config.source.AbstractConfigurationSource
getPriority() - Method in interface com.helger.config.source.IConfigurationSource
getResource() - Method in class com.helger.config.source.resource.AbstractConfigurationSourceResource
getResource() - Method in interface com.helger.config.source.resource.IConfigurationSourceResource
getResourceBasedConfigurationValueProviderCount() - Method in interface com.helger.config.IConfig: Count all configuration sources that implement IConfigurationSourceResource
getSourceType() - Method in class com.helger.config.source.AbstractConfigurationSource
getSourceType() - Method in interface com.helger.config.source.IConfigurationSource
getSystemConfig() - Static method in class com.helger.config.ConfigFactory: Get a special IConfig instance that is only intended to be used to setup other config instances.
getUnifiedSysEnvName(String, char) - Static method in class com.helger.config.source.envvar.EnvVarHelper: Get a unified system environment variable name from the provided property name.
getUnresolvedVariableProvider() - Method in class com.helger.config.Config
getValue() - Method in class com.helger.config.value.ConfiguredValue
getValue(String) - Method in class com.helger.config.Config
getValueProvider() - Method in class com.helger.config.source.appl.ConfigurationSourceFunction

H

hashCode() - Method in class com.helger.config.source.AbstractConfigurationSource
hashCode() - Method in class com.helger.config.source.appl.ConfigurationSourceFunction
hashCode() - Method in class com.helger.config.source.resource.AbstractConfigurationSourceResource
hashCode() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
hasTrailingWhitespace(String) - Static method in class com.helger.config.source.AbstractConfigurationSource

I

IConfig - Interface in com.helger.config: Read-only configuration
IConfigKeyOutdatedNotifier - Interface in com.helger.config.fallback: Sanity callback interface to notify about the usage of an outdated configuration key.
IConfigurationSource - Interface in com.helger.config.source: An abstract configuration source.
IConfigurationSourceResource - Interface in com.helger.config.source.resource: Specific configuration source based on a readable resource.
IConfigurationSourceResourceTypeRegistrarSPI - Interface in com.helger.config.source.resource.type: SPI interface to be implemented by other configuration source resource types
IConfigurationValueProvider - Interface in com.helger.config.value: A generic configuration value provider.
IConfigurationValueProviderWithPriorityCallback - Interface in com.helger.config.value: Callback interface for enumeration of available configuration value providers.
IConfigWithFallback - Interface in com.helger.config.fallback: This is an extended configuration interface that supports the resolution of configuration values from more then one key (e.g. for migration purposes).
IIterableConfigurationSource - Interface in com.helger.config.source: Interface for a configuration source that provides all its possible keys.
isInitializedAndUsable() - Method in class com.helger.config.source.appl.ConfigurationSourceFunction
isInitializedAndUsable() - Method in class com.helger.config.source.envvar.ConfigurationSourceEnvVar
isInitializedAndUsable() - Method in interface com.helger.config.source.IConfigurationSource
isInitializedAndUsable() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
isInitializedAndUsable() - Method in class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
isInstantiated() - Static method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
isReplaceVariables() - Method in class com.helger.config.Config
isSecretKey(String) - Static method in class com.helger.config.source.AbstractConfigurationSource
isUseOnlyInitializedConfigSources() - Method in class com.helger.config.source.MultiConfigurationValueProvider
isUseVariableDefaultValues() - Method in class com.helger.config.Config
isValidFirstChar(char) - Static method in class com.helger.config.source.envvar.EnvVarHelper: Check if the provided character is a valid first character for an environment variable.
isValidFollowingChar(char) - Static method in class com.helger.config.source.envvar.EnvVarHelper: Check if the provided character is a valid second or following character for an environment variable.

M

mapToStringIgnoreSecrets(Map<String, V>) - Static method in class com.helger.config.source.AbstractConfigurationSource
MultiConfigurationValueProvider - Class in com.helger.config.source: An implementation of IConfigurationValueProvider that supports multiple sources, ordered by priority, descending.
MultiConfigurationValueProvider() - Constructor for class com.helger.config.source.MultiConfigurationValueProvider: Default constructor without any configuration source.
MultiConfigurationValueProvider(IConfigurationSource...) - Constructor for class com.helger.config.source.MultiConfigurationValueProvider: Constructor with an array of existing configuration sources.
MultiConfigurationValueProvider(List<? extends IConfigurationSource>) - Constructor for class com.helger.config.source.MultiConfigurationValueProvider: Constructor with a list of existing configuration sources.

O

onConfigurationValueProvider(IConfigurationValueProvider, int) - Method in interface com.helger.config.value.IConfigurationValueProviderWithPriorityCallback: Invoked for a single configuration value provider.
Was renamed to "onConfigurationValueProvider" in v11
onOutdatedConfigurationKey(String, String) - Method in interface com.helger.config.fallback.IConfigKeyOutdatedNotifier: Called to indicate that an outdated configuration key was used.

P

PRIVATE_APPLICATION_PROPERTIES_NAME - Static variable in class com.helger.config.ConfigFactory
PRIVATE_APPLICATION_PROPERTIES_PRIORITY - Static variable in class com.helger.config.ConfigFactory

R

REFERENCE_PROPERTIES_NAME - Static variable in class com.helger.config.ConfigFactory
REFERENCE_PROPERTIES_PRIORITY - Static variable in class com.helger.config.ConfigFactory
register(String, Function<IReadableResource, AbstractConfigurationSourceResource>) - Method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
registerResourceType(ConfigurationSourceResourceTypeRegistry) - Method in class com.helger.config.source.resource.type.DefaultConfigurationSourceResourceTypeRegistrarSPI
registerResourceType(ConfigurationSourceResourceTypeRegistry) - Method in interface com.helger.config.source.resource.type.IConfigurationSourceResourceTypeRegistrarSPI: Register your configuration source resource type converters.
reinitialize() - Method in class com.helger.config.source.resource.type.ConfigurationSourceResourceTypeRegistry
reload() - Method in interface com.helger.config.source.resource.IConfigurationSourceResource: Try to reload the configuration source from the configured resource.
reload() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
reloadAllResourceBasedConfigurationValues() - Method in interface com.helger.config.IConfig: Reload the configuration from all resource based sources (the ones implementing IConfigurationSourceResource).
REPLACEMENT_CHAR_TO_SKIP - Static variable in class com.helger.config.source.envvar.EnvVarHelper
RESOURCE - Enum constant in enum class com.helger.config.source.EConfigSourceType: A configuration value from a file.

S

setFoundKeyConsumer(BiConsumer<String, ConfiguredValue>) - Method in class com.helger.config.Config
setKeyNotFoundConsumer(Consumer<String>) - Method in class com.helger.config.Config
setOutdatedNotifier(IConfigKeyOutdatedNotifier) - Method in class com.helger.config.fallback.ConfigWithFallback: Set the outdated key notifier to be invoked when an old configuration key was used.
setReplaceVariables(boolean) - Method in class com.helger.config.Config: Enable or disable the replacement of variables in configuration values.
setUnresolvedVariableProvider(UnaryOperator<String>) - Method in class com.helger.config.Config: Set the handler to be invoked when a variable could not be resolved.
setUseOnlyInitializedConfigSources(boolean) - Method in class com.helger.config.source.MultiConfigurationValueProvider: Enable or disable the usage of only initialized configuration sources.
setUseVariableDefaultValues(boolean) - Method in class com.helger.config.Config: Enable or disable the usage of default values in variables of configuration values.
SOURCE_TYPE - Static variable in class com.helger.config.source.appl.ConfigurationSourceFunction
SOURCE_TYPE - Static variable in class com.helger.config.source.envvar.ConfigurationSourceEnvVar
SOURCE_TYPE - Static variable in class com.helger.config.source.sysprop.ConfigurationSourceSystemProperty
SYSTEM_PROPERTY - Enum constant in enum class com.helger.config.source.EConfigSourceType: A configuration values from a system property.

T

toString() - Method in class com.helger.config.Config
toString() - Method in class com.helger.config.fallback.ConfigWithFallback
toString() - Method in class com.helger.config.source.AbstractConfigurationSource
toString() - Method in class com.helger.config.source.appl.ConfigurationSourceFunction
toString() - Method in class com.helger.config.source.MultiConfigurationValueProvider
toString() - Method in class com.helger.config.source.resource.AbstractConfigurationSourceResource
toString() - Method in class com.helger.config.source.resource.properties.ConfigurationSourceProperties
toString() - Method in class com.helger.config.value.ConfiguredValue

V

valueOf(String) - Static method in enum class com.helger.config.source.EConfigSourceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.helger.config.source.EConfigSourceType: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I M O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values