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

A

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

AbstractConfigurationMerger<T> - Class in net.obvj.confectory.merger

A abstract ConfigurationMerger that contains common infrastructure logic for the merging of two Configuration objects, delegating the actual combination to a concrete implementation.

AbstractConfigurationMerger() - Constructor for class net.obvj.confectory.merger.AbstractConfigurationMerger

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

An abstract Mapper that defines a template of how to parse the contents of a valid INI Source (e.g.: file, URL), and delegates the final object type population to a concrete implementation.

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

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.

add(Configuration<T>) - Method in class net.obvj.confectory.TypeSafeConfigurationContainer

Adds the specified Configuration to this container.

add(Object, Object) - Method in interface net.obvj.confectory.util.JsonProvider

Appends the specified element to the end of the specified JSON array.

add(Object, Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

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

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

append(String) - Method in class net.obvj.confectory.util.JsonPathExpression

Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given expression.

appendChild(String) - Method in class net.obvj.confectory.util.JsonPathExpression

Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given child element name.

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

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

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

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

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.PropertiesToObjectMapper

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

arrayContains(Object, Object) - Method in interface net.obvj.confectory.util.JsonProvider

Checks if the specified JSON array contains the specified element.

arrayContains(Object, Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

B

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

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

bean(T) - Method in class net.obvj.confectory.ConfigurationBuilder

[Optional] Defines a preset bean for the new Configuration.

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

A Configuration Helper implementation for user-defined beans.

BeanConfigurationHelper(T) - Constructor for class net.obvj.confectory.internal.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.

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

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 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.

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.internal.helper

An abstraction for objects that retrieve data from previously loaded Configuration objects.

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

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

configurationHelper(JSONObject) - Method in class net.obvj.confectory.mapper.INIToJSONObjectMapper

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

configurationHelper(JSONObject) - Method in class net.obvj.confectory.mapper.JSONObjectMapper

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

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

configurationMerger() - Method in class net.obvj.confectory.internal.helper.BeanConfigurationHelper

configurationMerger() - Method in interface net.obvj.confectory.internal.helper.ConfigurationHelper

Creates the applicable ConfigurationMerger object for the type associated with this ConfigurationHelper.

configurationMerger() - Method in class net.obvj.confectory.internal.helper.JsonSmartConfigurationHelper

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

configurationMerger() - Method in class net.obvj.confectory.internal.helper.PropertiesConfigurationHelper

ConfigurationMerger<T> - Interface in net.obvj.confectory.merger

Base abstraction for merging two Configuration objects of the same type <T>.

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.

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

A dummy Mapper for use with a preset configuration bean and other internal purposes.

DummyMapper(Function<T, ConfigurationHelper<T>>) - Constructor for class net.obvj.confectory.mapper.DummyMapper

Creates a dummy Mapper with a ConfigurationHelper factory function.

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

A dummy Source for internal purposes.

DummySource() - Constructor for class net.obvj.confectory.source.DummySource

Builds a dummy source.

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

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

Marks the new Configuration as eager.

entrySet(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Returns a Set view of the mappings contained in the specified JSON object.

entrySet(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

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.

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

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.

forEachElementInArray(Object, Consumer<? super Object>) - Method in interface net.obvj.confectory.util.JsonProvider

Performs the given action for each element of the specified JSON array until all entries have been processed.

forEachElementInArray(Object, Consumer<? super Object>) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

G

GenericJsonConfigurationHelper<J> - Class in net.obvj.confectory.internal.helper

A generic Configuration Helper that retrieves data from a JSON document, with JSONPath capabilities.

GenericJSONConfigurationMerger<T> - Class in net.obvj.confectory.merger

A generic ConfigurationMerger that combines two Configuration objects of type JSON.

GenericJSONConfigurationMerger(JsonProvider) - Constructor for class net.obvj.confectory.merger.GenericJSONConfigurationMerger

Creates a new JSON Configuration Merger for a specific provider.

GenericJSONConfigurationMerger(JsonProvider, Map<String, String>) - Constructor for class net.obvj.confectory.merger.GenericJSONConfigurationMerger

Creates a new JSON Configuration Merger for a specific provider and a preset map of distinct keys.

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

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

Returns the object associated with the specified key.

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

get(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the object associated with the specified @code jsonPath} in the JSON document in context.

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

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

get(Object, String) - Method in interface net.obvj.confectory.util.JsonProvider

Returns the value to which the specified key is mapped in the specified JSON object; or null if the JSON does not contain the specified key.

get(Object, String) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

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

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

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

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

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

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

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

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

Returns the highest-precedence mapped bean inside this container.

getBean(String) - Method in class net.obvj.confectory.TypeSafeConfigurationContainer

Returns the highest-precedence mapped bean associated with the specified namespace inside this container.

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

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

Returns the Boolean object associated with the specified key in the default namespace (or in all namespaces depending on the DataFetchStrategy in scope).

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

Returns the Boolean object associated with the specified key in the specified namespace.

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

Returns the Boolean object associated with the specified key.

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

getBoolean(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Boolean object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to boolean.

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

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.

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

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

Returns the Double object associated with the specified key in the default namespace (or in all namespaces depending on the DataFetchStrategy in scope).

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

Returns the Double object associated with the specified key in the specified namespace.

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

Returns the Double object associated with the specified key.

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

getDouble(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Double object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to double.

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

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

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

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

Returns the Integer object associated with the specified key in the default namespace (or in all namespaces depending on the DataFetchStrategy in scope).

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

Returns the Integer object associated with the specified key in the specified namespace.

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

Returns the Integer object associated with the specified key.

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

getInteger(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Integer object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to int.

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

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

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

Returns the Long object associated with the specified key in the default namespace (or in all namespaces depending on the DataFetchStrategy in scope).

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

Returns the Long object associated with the specified key in the specified namespace.

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

Returns the Long object associated with the specified key.

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

getLong(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Long object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to long.

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

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

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

Returns the Boolean object associated with the specified key, throwing an exception if not found.

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

getMandatoryBoolean(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Boolean object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to boolean.

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

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

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

Returns the Double object associated with the specified key, throwing an exception if not found.

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

getMandatoryDouble(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Double object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to double.

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

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

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

Returns the Integer object associated with the specified key, throwing an exception if not found.

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

getMandatoryInteger(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Integer object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to int.

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

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

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

Returns the Long object associated with the specified key, throwing an exception if not found.

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

getMandatoryLong(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the Long object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element that can be mapped to long.

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

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

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

Returns the String object associated with the specified key, throwing an exception if not found.

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

getMandatoryString(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the String object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element.

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

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

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.

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.

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

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

Returns the String object associated with the specified key in the default namespace (or in all namespaces depending on the DataFetchStrategy in scope).

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

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

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

Returns the String object associated with the specified key.

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

getString(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper

Returns the String object associated with the specified jsonPath in the JsonNode in context, provided that the expression returns a single element.

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

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

H

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

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

hashCode() - Method in class net.obvj.confectory.util.JsonPathExpression

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.

INIToJSONObjectMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads the contents of a valid INI Source (e.g.: file, URL) as a JSONObject.

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

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

A specialized Mapper that loads the contents of a valid INI Source (e.g.: file, URL) into a POJO (Plain-Old Java Object).

INIToObjectMapper(Class<T>) - Constructor for class net.obvj.confectory.mapper.INIToObjectMapper

Builds a new INIToObjectMapper with the specified target type.

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

Returns true if this container contains no Configuration objects.

isEmpty() - Method in class net.obvj.confectory.TypeSafeConfigurationContainer

Returns true if this container contains no Configuration objects.

isEmpty(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Checks if the specified JSON object contains no data.

isEmpty(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

isJsonArray(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Checks if the specified object is a JSON array for this provider.

isJsonArray(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

isJsonObject(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Checks if the specified object is a JSON object for this provider.

isJsonObject(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

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

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

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

Returns a flag indicating whether this Configuration is lazy, i.e., not loaded until needed.

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.

isTransient(Field) - Static method in class net.obvj.confectory.util.ReflectionUtils

Evaluates if the specified field is marked transient.

J

JSONObjectConfigurationMerger - Class in net.obvj.confectory.merger

A specialized ConfigurationMerger that combines two Configuration objects of type JSONObject (using json-smart implementation) into a single one.

JSONObjectConfigurationMerger() - Constructor for class net.obvj.confectory.merger.JSONObjectConfigurationMerger

Creates a new JSON Configuration Merger for JSONObject using json-smart implementation.

JSONObjectConfigurationMerger(Map<String, String>) - Constructor for class net.obvj.confectory.merger.JSONObjectConfigurationMerger

Creates a new JSON Configuration Merger for JSONObject using json-smart implementation with a preset map of distinct keys.

JSONObjectMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads the contents of a valid JSON Source (e.g.: file, URL) as a JSONObject (json-smart JSON implementation).

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

JsonPathExpression - Class in net.obvj.confectory.util

An immutable object that represents a compiled JsonPath expression.

JsonPathExpression(String) - Constructor for class net.obvj.confectory.util.JsonPathExpression

Creates a compiled JsonPathExpression from the specified expression.

JsonProvider - Interface in net.obvj.confectory.util

An abstraction that represents a JSON provider (for example: Jackson, Gson, etc.)

JsonSmartConfigurationHelper - Class in net.obvj.confectory.internal.helper

A specialized Configuration Helper that retrieves data from net.minidev's (json-smart) JSONObject, with JSONPath capabilities.

JsonSmartConfigurationHelper(JSONObject) - Constructor for class net.obvj.confectory.internal.helper.JsonSmartConfigurationHelper

Creates a new helper for the given JSONObject.

JsonSmartJsonProvider - Class in net.obvj.confectory.util

A specialized JsonProvider implementation for json-smart.

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

L

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

Marks the new Configuration as lazy.

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.DummySource

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 a mapped bean containing 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 a mapped bean containing the retrieved data.

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

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

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.

merge(Configuration<T>) - Method in class net.obvj.confectory.Configuration

Combines this Configuration with another one, producing a new Configuration, with the following characteristics: The resulting Configuration will receive all the elements from both Configuration objects In case of conflicting keys, the values at the highest-precedence Configuration will be selected The metadata of the highest-precedence Configuration (namespace and precedence) will be applied to the new Configuration Note: The other Configuration must be of the same type as the current one.

merge(Configuration<T>, Configuration<T>) - Method in class net.obvj.confectory.merger.AbstractConfigurationMerger

merge(Configuration<T>, Configuration<T>) - Method in interface net.obvj.confectory.merger.ConfigurationMerger

Combines two Configuration objects into a new Configuration with the following characteristics: The resulting object will receive all the elements of the input Configuration objects In case of conflicting keys, the values at the highest-precedence Configuration will be selected The metadata of the highest-precedence Configuration (namespace and precedence) will be applied to the new Configuration

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.internal.helper - package net.obvj.confectory.internal.helper

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

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.merger - package net.obvj.confectory.merger

This package contains the ConfigurationMerger 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.

newInstance(T, Mapper<T>) - Static method in interface net.obvj.confectory.internal.helper.ConfigurationHelper

Creates a new ConfigurationHelper for the given Mapper.

newJsonArray() - Method in interface net.obvj.confectory.util.JsonProvider

Creates a provider-specific JSON array.

newJsonArray(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Creates a new provider-specific JSON array with the elements of a preset JSON array.

newJsonArray() - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

newJsonArray(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

newJsonObject() - Method in interface net.obvj.confectory.util.JsonProvider

Creates a provider-specific JSON object.

newJsonObject(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Creates a new provider-specific JSON object with the contents of a preset JSON object.

newJsonObject() - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

newJsonObject(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

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

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

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

Builds a NullConfigurationHelper.

NullConfigurationHelper(ConfigurationHelper<T>) - Constructor for class net.obvj.confectory.internal.helper.NullConfigurationHelper

Builds a NullConfigurationHelper with a reference to the original/expected ConfigurationHelper.

O

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

Marks the new Configuration as optional.

P

parse(Class<T>, String) - Static method in class net.obvj.confectory.util.ParseFactory

Parses the contents of a string into the specified type.

ParseFactory - Class in net.obvj.confectory.util

A class that contains built-in parsers from string into common object types, typically for Reflection purposes.

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.internal.helper

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

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

Builds a new dedicated instance from a specific Properties object.

PropertiesConfigurationMerger - Class in net.obvj.confectory.merger

A specialized ConfigurationMerger that combines two Configuration objects of type Properties into a single one.

PropertiesConfigurationMerger() - Constructor for class net.obvj.confectory.merger.PropertiesConfigurationMerger

PropertiesMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads the contents of a Source (e.g.: file, URL) as Properties (a table of key-value pairs).

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

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

A specialized Mapper that loads the contents of a Source (e.g.: file, URL) in the Properties format (a sequence of key-value pairs) and converts it into a POJO (Plain-Old Java Object).

PropertiesToObjectMapper(Class<T>) - Constructor for class net.obvj.confectory.mapper.PropertiesToObjectMapper

Builds a new Properties Mapper with the specified target type.

Property - Annotation Type in net.obvj.confectory.util

Marker annotation that can be used to indicate that an object field shall be associated with the property key defined by the annotation value.

put(Object, String, Object) - Method in interface net.obvj.confectory.util.JsonProvider

Associates the specified value with the specified key in the specified JSON object.

put(Object, String, Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

putIfAbsent(Object, String, Object) - Method in interface net.obvj.confectory.util.JsonProvider

Associates the specified value with the specified key in the specified JSON object, provided that the specified key is not already associated with a value in the JSON.

putIfAbsent(Object, String, Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

R

ReflectionUtils - Class in net.obvj.confectory.util

Common methods for working with reflections.

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.

ROOT - Static variable in class net.obvj.confectory.util.JsonPathExpression

A pre-compiled JsonPathExpression that represents the root element of a JSON document ('$').

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.

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

Returns an object containing global settings for the Confectory project.

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

Returns the number of Configuration objects in this container.

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

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

size() - Method in class net.obvj.confectory.TypeSafeConfigurationContainer

Returns the number of Configuration objects in this container.

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

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.

stream(Object) - Method in interface net.obvj.confectory.util.JsonProvider

Returns a sequential Stream with the specified JSON array as its source.

stream(Object) - Method in class net.obvj.confectory.util.JsonSmartJsonProvider

StringMapper - Class in net.obvj.confectory.mapper

A specialized Mapper that loads the contents of a Source (e.g.: file, URL) as a String using the JVM default Charset, 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

toString() - Method in class net.obvj.confectory.util.JsonPathExpression

Returns the string representation of this JsonPathExpression, in the bracket-notation.

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

An object that holds multiple Configuration objects of the same generic type <T> and selects the highest-precedence available ones.

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

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

U

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

Creates a new URLSource for loading contents of a URL.

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

A specialized configuration source implementation that loads contents from a URL, that can be a local file or a Web resource.

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

Builds a new configuration source for a specific URL.

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 J L M N O P R S T U V