Index (Configuration 0.8.0 API)

A B C D E F G H I K L M N O R S W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractChildConfigurationDecorator<C extends Configuration> - Class in io.confound.config: Wrapper configuration that forwards calls to the decorated configuration, falling back to an optional parent configuration.
AbstractChildConfigurationDecorator() - Constructor for class io.confound.config.AbstractChildConfigurationDecorator
AbstractConfiguration - Class in io.confound.config: Abstract configuration implementation.
AbstractConfiguration() - Constructor for class io.confound.config.AbstractConfiguration
AbstractConfigurationDecorator - Class in io.confound.config: Abstract wrapper configuration that forwards calls to the decorated configuration.
AbstractConfigurationDecorator(Configuration) - Constructor for class io.confound.config.AbstractConfigurationDecorator: Wrapped configuration constructor.
AbstractConfigurationManager - Class in io.confound.config: A configuration manager that knows how to load a configuration by parsing some document from an input stream.
AbstractConfigurationManager(boolean) - Constructor for class io.confound.config.AbstractConfigurationManager: Constructor.
AbstractObjectConfiguration - Class in io.confound.config: Abstract configuration implementation for which the underlying storage is based on general objects.
AbstractObjectConfiguration() - Constructor for class io.confound.config.AbstractObjectConfiguration
AbstractStringConfiguration - Class in io.confound.config: Abstract configuration implementation for which the underlying storage is based solely on strings.
AbstractStringConfiguration() - Constructor for class io.confound.config.AbstractStringConfiguration

B

BaseChildConfigurationDecorator<C extends Configuration> - Class in io.confound.config: A base wrapper configuration that forwards calls to the decorated configuration, falling back to a parent configuration.
BaseChildConfigurationDecorator(C) - Constructor for class io.confound.config.BaseChildConfigurationDecorator: Wrapped configuration constructor.
BaseChildConfigurationDecorator(C, C) - Constructor for class io.confound.config.BaseChildConfigurationDecorator: Wrapped configuration and parent configuration constructor.
BaseConfiguration<T> - Class in io.confound.config: Abstract configuration implementation providing common base functionality.
BaseConfiguration() - Constructor for class io.confound.config.BaseConfiguration

C

check(boolean) - Static method in interface io.confound.config.Configuration: Checks whether a configuration condition is correct, and throws a ConfigurationException if not.
check(boolean, String, Object...) - Static method in interface io.confound.config.Configuration: Checks whether a configuration condition is correct, and throws a ConfigurationException if not.
ChildConfigurationDecorator - Class in io.confound.config: A wrapper configuration that forwards calls to the decorated configuration, falling back to a parent configuration.
ChildConfigurationDecorator(Configuration, Configuration) - Constructor for class io.confound.config.ChildConfigurationDecorator: Wrapped configuration and parent configuration constructor.
Configuration - Interface in io.confound.config: Access to configuration values.
ConfigurationException - Exception in io.confound.config: An unchecked illegal state exception to indicate that the system is not configured correctly for some operation.
ConfigurationException() - Constructor for exception io.confound.config.ConfigurationException: No-argument constructor.
ConfigurationException(String) - Constructor for exception io.confound.config.ConfigurationException: Message constructor.
ConfigurationException(String, Throwable) - Constructor for exception io.confound.config.ConfigurationException: Message and cause constructor.
ConfigurationException(Throwable) - Constructor for exception io.confound.config.ConfigurationException: Cause constructor.
ConfigurationManager - Interface in io.confound.config: A strategy for retrieving and storing configurations.
convertValue(Optional<Object>, Class<O>) - Method in class io.confound.config.AbstractObjectConfiguration: Converts a configuration value from its actual type in the underlying storage to the requested type.
convertValue(Optional<T>, Class<C>) - Method in class io.confound.config.BaseConfiguration: Converts a configuration value from its actual type in the underlying storage to the requested type.
createMissingConfigurationKeyException(String) - Method in interface io.confound.config.Configuration: Creates an exception indicating that a given configuration key could not be found.

D

decorateKey(String) - Method in class io.confound.config.AbstractConfigurationDecorator: Transforms the key appropriately before it is passed to the decorated configuration.
decorateKey(String) - Method in class io.confound.config.SubConfiguration
decorateKey(String) - Method in class io.confound.config.SuperConfiguration
dereferenceString(String) - Method in class io.confound.config.AbstractStringConfiguration: Evaluates and replaces any references in the given string.

E

empty() - Static method in interface io.confound.config.Configuration
EmptyConfiguration - Class in io.confound.config: A configuration implementation that contains no definitions.
EmptyConfiguration() - Constructor for class io.confound.config.EmptyConfiguration: This class cannot be publicly instantiated; only by subclasses.

F

findBoolean(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findBoolean(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findBoolean(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a Boolean configuration value that may not be present.
findBoolean(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a Boolean configuration value that may not be present.
findBoolean(String) - Method in interface io.confound.config.Configuration: Retrieves a Boolean configuration value that may not be present.
findBoolean(String) - Method in class io.confound.config.EmptyConfiguration
findCollection(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findCollection(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findCollection(String) - Method in interface io.confound.config.Configuration: Retrieves a collection of objects that may not be present, converting the underlying group of objects to a Collection if necessary.
findCollection(String, Class<E>) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findCollection(String, Class<E>) - Method in class io.confound.config.AbstractConfigurationDecorator
findCollection(String, Class<E>) - Method in class io.confound.config.BaseConfiguration: Retrieves a collection that may not be present, containing objects of the the requested type, converting the underlying group of objects to a Collection and converting each object to the correct type as necessary.
findCollection(String, Class<E>) - Method in interface io.confound.config.Configuration: Retrieves a collection that may not be present, containing objects of the the requested type, converting the underlying group of objects to a Collection and converting each object to the correct type as necessary.
findCollection(String, Class<E>) - Method in class io.confound.config.EmptyConfiguration
findConfigurationValue(String) - Method in class io.confound.config.AbstractStringConfiguration: Tries to retrieves a general configuration value from the underlying storage.
findConfigurationValue(String) - Method in class io.confound.config.BaseConfiguration: Tries to retrieves a general configuration value from the underlying storage.
findConfigurationValueImpl(String) - Method in class io.confound.config.BaseConfiguration: Implementation to retrieves a general configuration value that may not be present from the underlying storage.
findConfigurationValueImpl(String) - Method in class io.confound.config.ObjectMapConfiguration: Implementation to retrieves a general configuration value that may not be present from the underlying storage.
findConfigurationValueImpl(String) - Method in class io.confound.config.StringMapConfiguration: Implementation to retrieves a general configuration value that may not be present from the underlying storage.
findDouble(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findDouble(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findDouble(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a floating point configuration value that may not be present.
findDouble(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a floating point configuration value that may not be present.
findDouble(String) - Method in interface io.confound.config.Configuration: Retrieves a floating point configuration value that may not be present.
findDouble(String) - Method in class io.confound.config.EmptyConfiguration
findInt(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findInt(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findInt(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves an integer configuration value that may not be present.
findInt(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves an integer configuration value that may not be present.
findInt(String) - Method in interface io.confound.config.Configuration: Retrieves an integer configuration value that may not be present.
findInt(String) - Method in class io.confound.config.EmptyConfiguration
findLong(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findLong(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findLong(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a long integer configuration value that may not be present.
findLong(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a long integer configuration value that may not be present.
findLong(String) - Method in interface io.confound.config.Configuration: Retrieves a long integer configuration value that may not be present.
findLong(String) - Method in class io.confound.config.EmptyConfiguration
findObject(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findObject(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findObject(String) - Method in interface io.confound.config.Configuration: Retrieves a general configuration object that may not be present.
findObject(String, Class<O>) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findObject(String, Class<O>) - Method in class io.confound.config.AbstractConfigurationDecorator
findObject(String, Class<O>) - Method in class io.confound.config.AbstractStringConfiguration
findObject(String, Class<O>) - Method in class io.confound.config.BaseConfiguration: Retrieves a general configuration object that may not be present as the requested type, converting it as necessary.
findObject(String, Class<O>) - Method in interface io.confound.config.Configuration: Retrieves a general configuration object that may not be present as the requested type, converting it as necessary.
findObject(String, Class<T>) - Method in class io.confound.config.EmptyConfiguration
findPath(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findPath(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findPath(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a path configuration value that may not be present.
findPath(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a path configuration value that may not be present.
findPath(String) - Method in interface io.confound.config.Configuration: Retrieves a path configuration value that may not be present.
findPath(String) - Method in class io.confound.config.EmptyConfiguration
findSection(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findSection(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findSection(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a section that may not be present.
findSection(String) - Method in interface io.confound.config.Configuration: Retrieves a section that may not be present.
findSection(String) - Method in class io.confound.config.EmptyConfiguration
findSection(String) - Method in class io.confound.config.StringMapConfiguration: Retrieves a section that may not be present.
findString(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findString(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findString(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a string configuration value that may not be present.
findString(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a string configuration value that may not be present.
findString(String) - Method in interface io.confound.config.Configuration: Retrieves a string configuration value that may not be present.
findString(String) - Method in class io.confound.config.EmptyConfiguration
findUri(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
findUri(String) - Method in class io.confound.config.AbstractConfigurationDecorator
findUri(String) - Method in class io.confound.config.AbstractObjectConfiguration: Retrieves a URI configuration value that may not be present.
findUri(String) - Method in class io.confound.config.AbstractStringConfiguration: Retrieves a URI configuration value that may not be present.
findUri(String) - Method in interface io.confound.config.Configuration: Retrieves a URI configuration value that may not be present.
findUri(String) - Method in class io.confound.config.EmptyConfiguration

G

getBoolean(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getBoolean(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getBoolean(String) - Method in interface io.confound.config.Configuration: Retrieves a Boolean configuration value.
getCollection(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getCollection(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getCollection(String) - Method in interface io.confound.config.Configuration: Retrieves a collection of objects, converting the underlying group of objects to a Collection if necessary.
getCollection(String, Class<E>) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getCollection(String, Class<E>) - Method in class io.confound.config.AbstractConfigurationDecorator
getCollection(String, Class<E>) - Method in interface io.confound.config.Configuration: Retrieves a collection, containing objects of the the requested type, converting the underlying group of objects to a Collection and converting each object to the correct type as necessary.
getConfiguration() - Method in class io.confound.config.AbstractChildConfigurationDecorator: Returns the wrapped configuration.
getConfiguration() - Method in class io.confound.config.AbstractConfigurationDecorator: Returns the wrapped configuration.
getConfiguration() - Method in class io.confound.config.BaseChildConfigurationDecorator
getConfiguration() - Method in class io.confound.config.ManagedConfiguration
getConfigurationManager() - Method in class io.confound.config.ManagedConfiguration
getDouble(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getDouble(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getDouble(String) - Method in interface io.confound.config.Configuration: Retrieves a floating point configuration value.
getInt(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getInt(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getInt(String) - Method in interface io.confound.config.Configuration: Retrieves an integer configuration value.
getKey() - Method in exception io.confound.config.MissingConfigurationKeyException
getLong(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getLong(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getLong(String) - Method in interface io.confound.config.Configuration: Retrieves a long integer configuration value.
getObject(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getObject(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getObject(String) - Method in interface io.confound.config.Configuration: Retrieves a general configuration object.
getObject(String, Class<O>) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getObject(String, Class<O>) - Method in class io.confound.config.AbstractConfigurationDecorator
getObject(String, Class<O>) - Method in interface io.confound.config.Configuration: Retrieves a general configuration object as the requested type, converting it as necessary.
getParentConfiguration() - Method in class io.confound.config.AbstractChildConfigurationDecorator
getParentConfiguration() - Method in class io.confound.config.BaseChildConfigurationDecorator
getParentConfiguration() - Method in class io.confound.config.ManagedConfiguration
getPath(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getPath(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getPath(String) - Method in interface io.confound.config.Configuration: Retrieves a path configuration value.
getSection(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getSection(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getSection(String) - Method in interface io.confound.config.Configuration: Retrieves a section by its key.
getSectionRoot() - Method in interface io.confound.config.Section: Returns the root configuration containing this section.
getSectionType() - Method in interface io.confound.config.Section
getString(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getString(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getString(String) - Method in interface io.confound.config.Configuration: Retrieves a string configuration value.
getUri(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator
getUri(String) - Method in class io.confound.config.AbstractConfigurationDecorator
getUri(String) - Method in interface io.confound.config.Configuration: Retrieves a URI configuration value.

H

hasConfigurationValue(String) - Method in class io.confound.config.AbstractChildConfigurationDecorator: Determines whether a configuration of some type exists for the given configuration key.
hasConfigurationValue(String) - Method in class io.confound.config.AbstractConfigurationDecorator
hasConfigurationValue(String) - Method in class io.confound.config.BaseConfiguration: Determines whether a configuration of some type exists for the given configuration key.
hasConfigurationValue(String) - Method in interface io.confound.config.Configuration: Determines whether a configuration of some type exists for the given configuration key.
hasConfigurationValue(String) - Method in class io.confound.config.EmptyConfiguration
hasConfigurationValueImpl(String) - Method in class io.confound.config.BaseConfiguration: Determines whether a configuration value is present in the underlying storage.
hasConfigurationValueImpl(String) - Method in class io.confound.config.ObjectMapConfiguration: Determines whether a configuration value is present in the underlying storage.
hasConfigurationValueImpl(String) - Method in class io.confound.config.StringMapConfiguration: Determines whether a configuration value is present in the underlying storage.

I

INSTANCE - Static variable in class io.confound.config.EmptyConfiguration: The singleton instance of an empty configuration.
invalidate() - Method in interface io.confound.config.ConfigurationManager: Invalidates any cached information about the managed configuration.
invalidate() - Method in class io.confound.config.ManagedConfiguration: Invalidates the managed configuration so that it will be lazily reloaded when next requested.
io.confound.config - package io.confound.config
isRequired() - Method in class io.confound.config.AbstractConfigurationManager
isRequired() - Method in interface io.confound.config.ConfigurationManager: Returns whether this configuration manager requires a configuration to be determined.
isStale(Configuration) - Method in interface io.confound.config.ConfigurationManager: Determines whether the currently managed configuration is stale.
isStale(Configuration) - Method in class io.confound.config.ManagedConfiguration: Determines if the current configuration stale.

K

KEY_SEGMENT_SEPARATOR - Static variable in interface io.confound.config.Configuration: The delimiter separating segments of a compound key, such as foo.bar.
KEY_SEGMENTS_PATTERN - Static variable in interface io.confound.config.Configuration: The pattern for splitting out the segments of a compound key.

L

loadConfiguration() - Method in interface io.confound.config.ConfigurationManager: Loads a configuration.

M

ManagedConfiguration - Class in io.confound.config: A configuration that wraps manages a cached configuration, reloading when needed.
ManagedConfiguration(ConfigurationManager) - Constructor for class io.confound.config.ManagedConfiguration: Configuration manager constructor.
ManagedConfiguration(ConfigurationManager, Configuration) - Constructor for class io.confound.config.ManagedConfiguration: Configuration manager and parent configuration constructor.
MissingConfigurationKeyException - Exception in io.confound.config: A configuration exception indicating that a configuration key was not found.
MissingConfigurationKeyException(String) - Constructor for exception io.confound.config.MissingConfigurationKeyException: Key constructor.
MissingConfigurationKeyException(String, String) - Constructor for exception io.confound.config.MissingConfigurationKeyException: Message and key constructor.
MissingConfigurationKeyException(String, String, Throwable) - Constructor for exception io.confound.config.MissingConfigurationKeyException: Message, key, and cause constructor.
MissingConfigurationKeyException(String, Throwable) - Constructor for exception io.confound.config.MissingConfigurationKeyException: Cause constructor.

N

normalizeKey(String) - Method in class io.confound.config.BaseConfiguration: Normalizes a requested key if required by this implementation.

O

ObjectMapConfiguration - Class in io.confound.config: Configuration implementation backed by a Map with values stored as objects.
ObjectMapConfiguration(Map<String, ?>) - Constructor for class io.confound.config.ObjectMapConfiguration: Map constructor.
or(Optional<T>, Supplier<Optional<T>>) - Static method in class io.confound.config.AbstractConfiguration: Returns another another optional from a supplier if the given optional is not present.

R

reload() - Method in class io.confound.config.ManagedConfiguration: Reloads the managed configuration.
requireConfiguration(Optional<T>, String) - Method in interface io.confound.config.Configuration: Retrieves a required configuration from an Optional, throwing a MissingConfigurationKeyException if the configuration key was not present.
resolvePath(Path) - Method in interface io.confound.config.Configuration: Resolves the given path as appropriate.

S

saveConfiguration(Configuration) - Method in interface io.confound.config.ConfigurationManager: Saves the configuration.
Section - Interface in io.confound.config: A section of a configuration that divides part of the configuration and possibly indicates some classification.
StringMapConfiguration - Class in io.confound.config: Configuration implementation backed by a Map with string values.
StringMapConfiguration(Map<String, String>) - Constructor for class io.confound.config.StringMapConfiguration: Map constructor.
subConfiguration(String) - Method in interface io.confound.config.Configuration: Returns a subset of this configuration representing a subtree of the keyspace with the given key prefix.
SubConfiguration - Class in io.confound.config: A configuration that decorates another configuration, providing a view of a subtree of the keyspace with some key prefix.
SubConfiguration(Configuration, String) - Constructor for class io.confound.config.SubConfiguration: Wrapped configuration constructor.
superConfiguration(String) - Method in interface io.confound.config.Configuration: Returns a superset of this configuration representing a broader keyspace with the given key prefix.
SuperConfiguration - Class in io.confound.config: A configuration that decorates another configuration, providing a view of a parent tree of the keyspace.
SuperConfiguration(Configuration, String) - Constructor for class io.confound.config.SuperConfiguration: Wrapped configuration constructor.

W

withFallback(Configuration) - Method in interface io.confound.config.Configuration: Returns a configuration equivalent to this configuration but that will fall back to a specified parent configuration if a value is not present.
withFallback(Configuration, Optional<Configuration>) - Static method in interface io.confound.config.Configuration: Utility method that returns a configuration equivalent to the given configuration but that will fall back to an optional parent configuration if a value is not present.

A B C D E F G H I K L M N O R S W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form