A B C D E F G H I L M N O P R S T V

A

AbstractBasicConfigurationHelper<T> - Class in net.obvj.confectory.helper

An abstract Configuration Helper object providing common infrastructure for concrete implementations.

AbstractBasicConfigurationHelper() - Constructor for class net.obvj.confectory.helper.AbstractBasicConfigurationHelper

AbstractBeanMapper<T> - Class in net.obvj.confectory.mapper

An abstract Mapper for implementations intended to load the contents of an InputStream into user-defined beans.

AbstractBeanMapper() - Constructor for class net.obvj.confectory.mapper.AbstractBeanMapper

AbstractNullValueProvider - Class in net.obvj.confectory.helper.nullvalue

An abstract NullValueProvider with common methods implemented.

AbstractNullValueProvider() - Constructor for class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

AbstractSource<T> - Class in net.obvj.confectory.source

An abstract configuration source, with common infrastructure.

add(Configuration<?>) - Method in class net.obvj.confectory.ConfigurationContainer

Adds the specified Configuration to this container.

addAll(ConfigurationContainer) - Method in class net.obvj.confectory.ConfigurationContainer

Copies all of the Configuration objects from another container to this container.

apply(InputStream) - Method in interface net.obvj.confectory.mapper.Mapper

Applies this Mapper into the given input.

apply(InputStream) - Method in class net.obvj.confectory.mapper.PropertiesMapper

apply(InputStream) - Method in class net.obvj.confectory.mapper.StringMapper

B

BasicConfigurationHelper<T> - Class in net.obvj.confectory.helper

A basic, abstract Configuration Helper object providing common infrastructure for concrete implementations.

BeanConfigurationHelper<T> - Class in net.obvj.confectory.helper

A Configuration Helper implementation for user-defined beans.

BeanConfigurationHelper(T) - Constructor for class net.obvj.confectory.helper.BeanConfigurationHelper

Builds a new Configuration Helper instance with a specific source.

build() - Method in class net.obvj.confectory.ConfigurationBuilder

Builds the target Configuration.

builder() - Static method in class net.obvj.confectory.Configuration

Creates a new configuration builder.

C

ClasspathFileSource<T> - Class in net.obvj.confectory.source

A specialized configuration source implementation for loading a local file resource from the classpath.

ClasspathFileSource(String) - Constructor for class net.obvj.confectory.source.ClasspathFileSource

Builds a new configuration source for specific local file resource in the classpath.

classpathFileSource(String) - Static method in class net.obvj.confectory.source.SourceFactory

Creates a new ClasspathFileSource for loading a local file resource from the Java classpath.

clear() - Method in class net.obvj.confectory.ConfigurationContainer

Removes all of the Configuration objects from this container.

compare(Configuration<?>, Configuration<?>) - Method in class net.obvj.confectory.util.ConfigurationComparator

Compares two Configuration objects for precedence.

Confectory - Class in net.obvj.confectory

A Facade for common operations in the Confectory project.

ConfectorySettings - Class in net.obvj.confectory.settings

An object that defines the global settings for the Confectory project.

Configuration<T> - Class in net.obvj.confectory

An immutable object that contains configuration data from a specific source, as well as related metadata.

ConfigurationBuilder<T> - Class in net.obvj.confectory

A mutable object that supports the creation of immutable Configuration objects.

ConfigurationBuilder() - Constructor for class net.obvj.confectory.ConfigurationBuilder

Creates a new, empty ConfigurationBuilder.

ConfigurationBuilder(Configuration<T>) - Constructor for class net.obvj.confectory.ConfigurationBuilder

Creates a new ConfigurationBuilder filled with the attributes of an existing base Configuration.

ConfigurationComparator - Class in net.obvj.confectory.util

A comparison function for Configuration objects.

ConfigurationComparator() - Constructor for class net.obvj.confectory.util.ConfigurationComparator

ConfigurationContainer - Class in net.obvj.confectory

An object that holds multiple Configuration objects and retrieves configuration data seamlessly, by namespace and key.

ConfigurationContainer(Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer

Builds a new ConfigurationContainer with an arbitrary number of preset Configuration objects to be registered.

ConfigurationContainer(DataFetchStrategy, Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer

Builds a new ConfigurationContainer with a custom DataFetchStrategy and an arbitrary number of preset Configuration objects.

ConfigurationContainer(NullValueProvider, Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer

Builds a new ConfigurationContainer with a custom NullValueProvider and an arbitrary number of preset Configuration objects.

ConfigurationContainer(DataFetchStrategy, NullValueProvider, Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer

Builds a new ConfigurationContainer with custom DataFetchStrategy and NullValueProvider and an arbitrary number of preset Configuration objects.

ConfigurationDataRetriever<T> - Interface in net.obvj.confectory

A base interface for objects that retrieve configuration data.

ConfigurationException - Exception in net.obvj.confectory

A specialized runtime exception for generic configuration handling.

ConfigurationException(String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationException

Constructs a new exception with the specified detail message.

ConfigurationException(Throwable, String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationException

Constructs a new exception with the specified detail message and cause.

ConfigurationException(Throwable) - Constructor for exception net.obvj.confectory.ConfigurationException

Constructs a new exception with the specified cause.

ConfigurationHelper<T> - Interface in net.obvj.confectory.helper

A base interface for Configuration Helper objects providing methods for retrieving configuration data from different source types.

configurationHelper(T) - Method in class net.obvj.confectory.mapper.AbstractBeanMapper

configurationHelper(T) - Method in interface net.obvj.confectory.mapper.Mapper

Creates a new ConfigurationHelper instance recommended by this Mapper.

configurationHelper(Properties) - Method in class net.obvj.confectory.mapper.PropertiesMapper

ConfigurationMetadataRetriever<T> - Interface in net.obvj.confectory

A base interface for objects that retrieve configuration metadata, such as Source, Mapper, and other attributes.

ConfigurationSourceException - Exception in net.obvj.confectory

A specialized runtime exception to indicate a failure to load a configuration from the Source.

ConfigurationSourceException(String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationSourceException

Constructs a new exception with the specified detail message.

ConfigurationSourceException(Throwable, String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationSourceException

Constructs a new exception with the specified detail message and cause.

ConfigurationSourceException(Throwable) - Constructor for exception net.obvj.confectory.ConfigurationSourceException

Constructs a new exception with the specified cause.

container() - Static method in class net.obvj.confectory.Confectory

Retrieves a ConfigurationContainer instance that can be accessed statically for holding global configuration data.

D

DataFetchStrategy - Enum in net.obvj.confectory

Enumerates the supported data-fetch strategies for use with a ConfigurationContainer.

DynamicSource<T> - Class in net.obvj.confectory.source

A dynamic Source implementation which applies a different loading strategy contingent on the path contents.

DynamicSource(String) - Constructor for class net.obvj.confectory.source.DynamicSource

Builds a new dynamic configuration source from a specific path.

dynamicSource(String) - Static method in class net.obvj.confectory.source.SourceFactory

Creates a new DynamicSource.

E

equals(Object) - Method in class net.obvj.confectory.Configuration

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class net.obvj.confectory.source.AbstractSource

Indicates whether some other object is "equal to" this one.

Exceptions - Class in net.obvj.confectory.util

Shorthands creating exceptions with a formatted message.

expandEnvironmentVariables(String) - Static method in class net.obvj.confectory.util.StringUtils

Replaces all the occurrences of system environment variables placed between "${" and "}" with their matching values from the given source string.

F

FileSource<T> - Class in net.obvj.confectory.source

A specialized configuration source implementation for loading a local file from the file system.

FileSource(String) - Constructor for class net.obvj.confectory.source.FileSource

Builds a new configuration source for specific local file from the file system.

fileSource(String) - Static method in class net.obvj.confectory.source.SourceFactory

Creates a new FileSource for loading a local file from the file system.

G

getBean() - Method in class net.obvj.confectory.Configuration

getBean() - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the target configuration object used by this data retriever, typically for manual handling and/or troubleshooting purposes.

getBean() - Method in class net.obvj.confectory.helper.BasicConfigurationHelper

getBean() - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getBooleanProperty(String) - Method in class net.obvj.confectory.Configuration

getBooleanProperty(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the boolean value associated with the specified key in the default namespace.

getBooleanProperty(String, String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the boolean value associated with the specified key in the specified namespace.

getBooleanProperty(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the boolean value associated with the specified key.

getBooleanProperty(String) - Method in class net.obvj.confectory.helper.BasicConfigurationHelper

getBooleanProperty(String) - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getBooleanValue() - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

getBooleanValue() - Method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns false.

getDataFetchStrategy() - Method in class net.obvj.confectory.ConfigurationContainer

Returns the DataFetchStrategy associated with this container.

getDefaultDataFetchStrategy() - Method in class net.obvj.confectory.settings.ConfectorySettings

Returns the DataFetchStrategy to be applied by default when no specific strategy is defined.

getDefaultNullValueProvider() - Method in class net.obvj.confectory.settings.ConfectorySettings

Returns the NullValueProvider to be applied by default when no such provider specified at Configuration level.

getDoubleProperty(String) - Method in class net.obvj.confectory.Configuration

getDoubleProperty(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the double value associated with the specified key in the default namespace.

getDoubleProperty(String, String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the double value associated with the specified key in the specified namespace.

getDoubleProperty(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the double value associated with the specified key.

getDoubleProperty(String) - Method in class net.obvj.confectory.helper.BasicConfigurationHelper

getDoubleProperty(String) - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getDoubleValue() - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

getDoubleValue() - Method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns 0.0.

getHelper() - Method in class net.obvj.confectory.Configuration

Returns the ConfigurationHelper associated with this Configuration.

getInstance() - Static method in class net.obvj.confectory.settings.ConfectorySettings

getIntProperty(String) - Method in class net.obvj.confectory.Configuration

getIntProperty(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the int value associated with the specified key in the default namespace.

getIntProperty(String, String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the int value associated with the specified key in the specified namespace.

getIntProperty(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the int value associated with the specified key.

getIntProperty(String) - Method in class net.obvj.confectory.helper.BasicConfigurationHelper

getIntProperty(String) - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getIntValue() - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

getIntValue() - Method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns 0.

getLongProperty(String) - Method in class net.obvj.confectory.Configuration

getLongProperty(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the long value associated with the specified key in the default namespace.

getLongProperty(String, String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the long value associated with the specified key in the specified namespace.

getLongProperty(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the long value associated with the specified key.

getLongProperty(String) - Method in class net.obvj.confectory.helper.BasicConfigurationHelper

getLongProperty(String) - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getLongValue() - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

getLongValue() - Method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns 0L.

getMapper() - Method in class net.obvj.confectory.Configuration

getMapper() - Method in class net.obvj.confectory.ConfigurationBuilder

getMapper() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns the Mapper object associated with this Configuration.

getNamespace() - Method in class net.obvj.confectory.Configuration

getNamespace() - Method in class net.obvj.confectory.ConfigurationBuilder

getNamespace() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns the namespace defined for this Configuration object.

getNamespaces() - Method in class net.obvj.confectory.ConfigurationContainer

Returns all of the namespaces defined inside this container.

getNullValueProvider() - Method in class net.obvj.confectory.Configuration

getNullValueProvider() - Method in class net.obvj.confectory.ConfigurationBuilder

getNullValueProvider() - Method in class net.obvj.confectory.ConfigurationContainer

Returns the NullValueProvider associated with this container.

getNullValueProvider() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns the NullValueProvider associated with this Configuration.

getPrecedence() - Method in class net.obvj.confectory.Configuration

getPrecedence() - Method in class net.obvj.confectory.ConfigurationBuilder

getPrecedence() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns the precedence value defined for this Configuration object.

getSource() - Method in class net.obvj.confectory.Configuration

getSource() - Method in class net.obvj.confectory.ConfigurationBuilder

getSource() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns the Source object associated with this Configuration.

getStringProperty(String) - Method in class net.obvj.confectory.Configuration

getStringProperty(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the String value associated with the specified key in the default namespace.

getStringProperty(String, String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the String value associated with the specified key in the specified namespace.

getStringProperty(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever

Returns the String value associated with the specified key.

getStringProperty(String) - Method in class net.obvj.confectory.helper.BeanConfigurationHelper

getStringProperty(String) - Method in class net.obvj.confectory.helper.NullConfigurationHelper

getStringProperty(String) - Method in class net.obvj.confectory.helper.PropertiesConfigurationHelper

getStringValue() - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

getStringValue() - Method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns an empty String.

H

hashCode() - Method in class net.obvj.confectory.Configuration

hashCode() - Method in class net.obvj.confectory.source.AbstractSource

I

illegalArgument(String, Object...) - Static method in class net.obvj.confectory.util.Exceptions

Creates an IllegalArgumentException with a formatted message.

illegalArgument(Throwable, String, Object...) - Static method in class net.obvj.confectory.util.Exceptions

Creates an IllegalArgumentException with a cause and a formatted message.

illegalState(String, Object...) - Static method in class net.obvj.confectory.util.Exceptions

Creates an IllegalStateException with a formatted message.

illegalState(Throwable, String, Object...) - Static method in class net.obvj.confectory.util.Exceptions

Creates an IllegalStateException with a cause and a formatted message.

instance() - Static method in class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

Returns pre-built, shared instance for this NullValueProvider.

isNull(boolean) - Method in class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

isNull(int) - Method in class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

isNull(long) - Method in class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

isNull(double) - Method in class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

isNull(String) - Method in class net.obvj.confectory.helper.nullvalue.AbstractNullValueProvider

isNull(boolean) - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

Checks if the boolean is equal to NullValueProvider.getBooleanValue().

isNull(int) - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

Checks if the int is equal to NullValueProvider.getIntValue().

isNull(long) - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

Checks if the long is equal to NullValueProvider.getLongValue().

isNull(double) - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

Checks if the double is equal to NullValueProvider.getDoubleValue().

isNull(String) - Method in interface net.obvj.confectory.helper.nullvalue.NullValueProvider

Checks if the String is equal to NullValueProvider.getStringValue().

isOptional() - Method in class net.obvj.confectory.Configuration

isOptional() - Method in class net.obvj.confectory.ConfigurationBuilder

isOptional() - Method in interface net.obvj.confectory.ConfigurationMetadataRetriever

Returns a flag indicating whether this Configuration is optional.

L

load(Mapper<T>, boolean) - Method in class net.obvj.confectory.source.AbstractSource

load(Mapper<T>) - Method in class net.obvj.confectory.source.ClasspathFileSource

load(Mapper<T>) - Method in class net.obvj.confectory.source.DynamicSource

load(Mapper<T>) - Method in class net.obvj.confectory.source.FileSource

load(Mapper<T>) - Method in interface net.obvj.confectory.source.Source

Applies a specific configuration loading strategy and returns the retrieved data, throwing an exception if the operation fails.

load(Mapper<T>, boolean) - Method in interface net.obvj.confectory.source.Source

Applies a specific configuration loading strategy and returns an Optional, possibly containing the retrieved data.

load(Mapper<T>) - Method in class net.obvj.confectory.source.StringSource

M

mapper(Mapper<T>) - Method in class net.obvj.confectory.ConfigurationBuilder

Defines the Mapper of the new Configuration.

Mapper<T> - Interface in net.obvj.confectory.mapper

The base interface for a configuration mapper.

N

namespace(String) - Method in class net.obvj.confectory.ConfigurationBuilder

Declares a namespace to be assigned to the new Configuration object.

net.obvj.confectory - package net.obvj.confectory

The main package.

net.obvj.confectory.helper - package net.obvj.confectory.helper

This package contains classes that support data retrieval for supported Configuration formats.

net.obvj.confectory.helper.nullvalue - package net.obvj.confectory.helper.nullvalue

This package contains classes that support custom null-value handling for Configuration data.

net.obvj.confectory.mapper - package net.obvj.confectory.mapper

This package groups the Mapper interface and its implementations, as well as auxiliary classes.

net.obvj.confectory.settings - package net.obvj.confectory.settings

Classes for settings that are particularly related to the Confectory project.

net.obvj.confectory.source - package net.obvj.confectory.source

This package groups the Source interface and its implementations, as well as auxiliary classes.

net.obvj.confectory.util - package net.obvj.confectory.util

Utility classes in general.

NullConfigurationHelper<T> - Class in net.obvj.confectory.helper

A "no-op" Configuration Helper object for situations where an optional Configuration object is not available.

NullConfigurationHelper() - Constructor for class net.obvj.confectory.helper.NullConfigurationHelper

nullValueProvider(NullValueProvider) - Method in class net.obvj.confectory.ConfigurationBuilder

Defines an optional NullValueProvider to be used when keys are not found.

NullValueProvider - Interface in net.obvj.confectory.helper.nullvalue

An object that provides "logic-nulls" for Java types (especially primitive ones) when a configuration key is not found.

O

optional() - Method in class net.obvj.confectory.ConfigurationBuilder

Marks the new Configuration as optional.

P

precedence(int) - Method in class net.obvj.confectory.ConfigurationBuilder

Defines the level of precedence of the new Configuration compared to similar objects in the same namespace.

PropertiesConfigurationHelper - Class in net.obvj.confectory.helper

A specialized Configuration Helper that retrieves data from a Properties object.

PropertiesConfigurationHelper(Properties) - Constructor for class net.obvj.confectory.helper.PropertiesConfigurationHelper

Builds a new dedicated instance from a specific Properties object.

PropertiesMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads Properties from an InputStream.

PropertiesMapper() - Constructor for class net.obvj.confectory.mapper.PropertiesMapper

R

required() - Method in class net.obvj.confectory.ConfigurationBuilder

Marks the new Configuration as required (default).

reset() - Method in class net.obvj.confectory.settings.ConfectorySettings

Resets Confectory configuration.

S

setDataFetchStrategy(DataFetchStrategy) - Method in class net.obvj.confectory.ConfigurationContainer

Defines a custom DataFetchStrategy for this container.

setDefaultDataFetchStrategy(DataFetchStrategy) - Method in class net.obvj.confectory.settings.ConfectorySettings

Defines the DataFetchStrategy to be applied by default when no specific strategy is defined.

setDefaultNullValueProvider(NullValueProvider) - Method in class net.obvj.confectory.settings.ConfectorySettings

Defines the NullValueProvider to be applied by default when no such provider specified at Configuration level.

setNullValueProvider(NullValueProvider) - Method in class net.obvj.confectory.ConfigurationContainer

Defines a custom NullValueProvider for this container.

setNullValueProvider(NullValueProvider) - Method in class net.obvj.confectory.helper.AbstractBasicConfigurationHelper

setNullValueProvider(NullValueProvider) - Method in interface net.obvj.confectory.helper.ConfigurationHelper

Defines a NullValueProvider for invalid keys.

settings() - Static method in class net.obvj.confectory.Confectory

Returns an object containing global settings for the Confectory project.

size(String) - Method in class net.obvj.confectory.ConfigurationContainer

Returns the number of Configuration objects associated with the specified namespace in this container.

source(Source<T>) - Method in class net.obvj.confectory.ConfigurationBuilder

Defines the Source of the new Configuration.

source(String) - Method in class net.obvj.confectory.ConfigurationBuilder

Defines a DynamicSource with the specified path for the new Configuration.

Source<T> - Interface in net.obvj.confectory.source

The base interface for a configuration source.

SourceFactory - Class in net.obvj.confectory.source

A factory of core Source implementations.

StandardNullValueProvider - Class in net.obvj.confectory.helper.nullvalue

An object that provides "smart-nulls" for Java types (specially primitive ones) when a configuration key is not found.

StandardNullValueProvider() - Constructor for class net.obvj.confectory.helper.nullvalue.StandardNullValueProvider

StringMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads the contents of an InputStream as String, typically for testing/troubleshooting or manual handling purposes.

StringMapper() - Constructor for class net.obvj.confectory.mapper.StringMapper

stringSource(String) - Static method in class net.obvj.confectory.source.SourceFactory

Creates a new StringSource for loading contents of a String.

StringSource<T> - Class in net.obvj.confectory.source

A specialized Source that loads the contents of a String.

StringSource(String) - Constructor for class net.obvj.confectory.source.StringSource

Builds a new configuration source from the specified string.

StringUtils - Class in net.obvj.confectory.util

Common methods for working with strings.

T

toString() - Method in class net.obvj.confectory.Configuration

toString() - Method in class net.obvj.confectory.source.AbstractSource

V

valueOf(String) - Static method in enum net.obvj.confectory.DataFetchStrategy

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.obvj.confectory.DataFetchStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P R S T V