A B C D E F G H I J K L M N O P R S T U V X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractBeanMapper<T> - Class in net.obvj.confectory.mapper
-
An abstract
Mapperfor implementations intended to load the contents of anInputStreaminto user-defined beans. - AbstractBeanMapper() - Constructor for class net.obvj.confectory.mapper.AbstractBeanMapper
- AbstractConfigurationMerger<T> - Class in net.obvj.confectory.merger
-
An abstract
ConfigurationMergerthat contains common infrastructure logic for the merging of twoConfigurationobjects, 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
Mapperthat defines a template of how to parse the contents of a valid INISource(e.g.: file, URL). - 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
Configurationto this container. - add(Configuration<T>) - Method in class net.obvj.confectory.TypeSafeConfigurationContainer
-
Adds the specified
Configurationto this container. - addAll(ConfigurationContainer) - Method in class net.obvj.confectory.ConfigurationContainer
-
Copies all of the
Configurationobjects from another container to this container. - apply(InputStream) - Method in class net.obvj.confectory.mapper.DocumentMapper
- 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
Mapperinto 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
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(String) - Static method in class net.obvj.confectory.source.SourceFactory
-
Creates a new
ClasspathFileSourcefor loading a local file resource from the Java classpath. - 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.
- clear() - Method in class net.obvj.confectory.ConfigurationContainer
-
Removes all of the
Configurationobjects from this container. - clear() - Method in class net.obvj.confectory.TypeSafeConfigurationContainer
-
Removes all of the
Configurationobjects from this container. - compare(Configuration<?>, Configuration<?>) - Method in class net.obvj.confectory.util.ConfigurationComparator
-
Compares two
Configurationobjects for precedence. - compileXPath(String) - Static method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Compiles the given XPath expression.
- Confectory - Class in net.obvj.confectory
-
A Facade for common operations in the
Confectoryproject. - ConfectorySettings - Class in net.obvj.confectory.settings
-
An object that defines the global settings for the
Confectoryproject. - 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
Configurationobjects. - 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
ConfigurationBuilderfilled with the attributes of an existing baseConfiguration. - ConfigurationComparator - Class in net.obvj.confectory.util
-
A comparison function for
Configurationobjects. - ConfigurationComparator() - Constructor for class net.obvj.confectory.util.ConfigurationComparator
- ConfigurationContainer - Class in net.obvj.confectory
-
An object that holds multiple
Configurationobjects and retrieves configuration data seamlessly, by namespace and key. - ConfigurationContainer(Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer
-
Builds a new
ConfigurationContainerwith an arbitrary number of presetConfigurationobjects to be registered. - ConfigurationContainer(DataFetchStrategy, Configuration<?>...) - Constructor for class net.obvj.confectory.ConfigurationContainer
-
Builds a new
ConfigurationContainerwith a customDataFetchStrategyand an arbitrary number of presetConfigurationobjects. - 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) - Constructor for exception net.obvj.confectory.ConfigurationException
-
Constructs a new exception with the specified cause.
- ConfigurationException(Throwable, String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationException
-
Constructs a new exception with the specified detail message and cause.
- configurationHelper(Properties) - Method in class net.obvj.confectory.mapper.PropertiesMapper
- configurationHelper(JSONObject) - Method in class net.obvj.confectory.mapper.INIToJSONObjectMapper
- configurationHelper(JSONObject) - Method in class net.obvj.confectory.mapper.JSONObjectMapper
- configurationHelper(Document) - Method in class net.obvj.confectory.mapper.DocumentMapper
- configurationHelper(T) - Method in class net.obvj.confectory.mapper.AbstractBeanMapper
- configurationHelper(T) - Method in class net.obvj.confectory.mapper.DummyMapper
- configurationHelper(T) - Method in class net.obvj.confectory.mapper.INIToObjectMapper
- configurationHelper(T) - Method in interface net.obvj.confectory.mapper.Mapper
-
Creates a new
ConfigurationHelperinstance recommended by thisMapper. - configurationHelper(T) - Method in class net.obvj.confectory.mapper.PropertiesToObjectMapper
- ConfigurationHelper<T> - Interface in net.obvj.confectory.internal.helper
-
An abstraction for objects that retrieve data from previously loaded
Configurationobjects. - configurationMerger() - Method in class net.obvj.confectory.internal.helper.BeanConfigurationHelper
- configurationMerger() - Method in interface net.obvj.confectory.internal.helper.ConfigurationHelper
-
Creates the applicable
ConfigurationMergerobject for the type associated with thisConfigurationHelper. - configurationMerger() - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
- 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
Configurationobjects 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) - Constructor for exception net.obvj.confectory.ConfigurationSourceException
-
Constructs a new exception with the specified cause.
- ConfigurationSourceException(Throwable, String, Object...) - Constructor for exception net.obvj.confectory.ConfigurationSourceException
-
Constructs a new exception with the specified detail message and cause.
- CONSTRUCTOR_BASED - net.obvj.confectory.util.ObjectFactory
-
Constructor-based object factory.
- container() - Static method in class net.obvj.confectory.Confectory
-
Retrieves a
ConfigurationContainerinstance that can be accessed statically for holding global configuration data. - convert(String) - Method in interface net.obvj.confectory.util.TypeConverter
-
Converts the specified command line argument value to some domain object.
- converter() - Method in annotation type net.obvj.confectory.util.Property
-
An optional
TypeConverterto convert this property value into a strongly typed object.
D
- DataFetchStrategy - Enum in net.obvj.confectory
-
Enumerates the supported data-fetch strategies for use with a
ConfigurationContainer. - DateUtils - Class in net.obvj.confectory.util
-
Common methods for working with dates.
- defaultIfEmpty(String, Supplier<String>) - Static method in class net.obvj.confectory.util.StringUtils
-
Returns either the passed in string, or if the string is empty (
"") ornull, the value returned by the specified supplier. - documentBuilderFactory() - Static method in class net.obvj.confectory.util.XMLUtils
-
Obtain a new instance of a
DocumentBuilderFactorywhich is considered to be secure against XXE (XML External Entity) attacks. - DocumentConfigurationHelper - Class in net.obvj.confectory.internal.helper
-
A generic Configuration Helper that retrieves data from an XML
Documentusing XPath. - DocumentConfigurationHelper(Document) - Constructor for class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Creates a new helper for the given XML
Document. - DocumentMapper - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of a valid XMLSource(e.g.: file, URL) as a W3CDocument. - DocumentMapper() - Constructor for class net.obvj.confectory.mapper.DocumentMapper
- DummyMapper<T> - Class in net.obvj.confectory.mapper
-
A dummy
Mapperfor 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
Mapperwith aConfigurationHelperfactory function. - DummySource<T> - Class in net.obvj.confectory.source
-
A dummy
Sourcefor internal purposes. - DummySource() - Constructor for class net.obvj.confectory.source.DummySource
-
Builds a dummy source.
- dynamicSource(String) - Static method in class net.obvj.confectory.source.SourceFactory
-
Creates a new
DynamicSource. - DynamicSource<T> - Class in net.obvj.confectory.source
-
A dynamic
Sourceimplementation 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.
E
- eager() - Method in class net.obvj.confectory.ConfigurationBuilder
-
Marks the new
Configurationas eager. - 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
- FAST - net.obvj.confectory.util.ObjectFactory
-
A factory that builds objects by allocating an instance directly on the heap, without any constructor being called.
- fileSource(String) - Static method in class net.obvj.confectory.source.SourceFactory
-
Creates a new
FileSourcefor loading a local file from the file system. - 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.
- findFieldByPropertyKey(Class<?>, String) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Find a field matching the following criteria in the specified type, or
nullif no match found: the field is marked with the@Propertyannotation; and the annotation defines a property key which is equal to the one specified in the parameter - findFieldByPropertyKeyOrName(Class<?>, String) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Find a field matching any of the following criteria in the specified type, or
nullif no match found: the field is marked with the@Propertyannotation, and the annotation defines a custom name equal to the one specified in the parameter; or the field name is equal to the specifiednameparameter
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
ConfigurationMergerthat combines twoConfigurationobjects of type JSON. - GenericJsonConfigurationMerger(JsonProvider<T>) - Constructor for class net.obvj.confectory.merger.GenericJsonConfigurationMerger
-
Creates a new JSON Configuration Merger for a specific provider.
- 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.DocumentConfigurationHelper
-
Returns the
NodeListobject associated with the specified @{code XPath} in the XML document in context. - 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
- getAsString() - Method in class net.obvj.confectory.Configuration
- getAsString() - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns a string representation of the bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
- getAsString() - Method in class net.obvj.confectory.internal.helper.BeanConfigurationHelper
- getAsString() - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
- getAsString() - Method in class net.obvj.confectory.internal.helper.JsonSmartConfigurationHelper
- getAsString() - Method in class net.obvj.confectory.internal.helper.NullConfigurationHelper
- getAsString() - Method in class net.obvj.confectory.internal.helper.PropertiesConfigurationHelper
- 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.DocumentConfigurationHelper
- 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
Booleanobject associated with the specifiedkeyin the default namespace (or in all namespaces depending on theDataFetchStrategyin scope). - getBoolean(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Booleanobject associated with the specifiedkey. - getBoolean(String) - Method in class net.obvj.confectory.internal.helper.BasicConfigurationHelper
- getBoolean(String) - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Returns the
Booleanobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted toboolean. - getBoolean(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Booleanobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped toboolean. - getBoolean(String) - Method in class net.obvj.confectory.internal.helper.NullConfigurationHelper
- getBoolean(String, String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Booleanobject associated with the specifiedkeyin the specifiednamespace. - getDataFetchStrategy() - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
DataFetchStrategyassociated with this container. - getDataFetchStrategy() - Method in class net.obvj.confectory.settings.ConfectorySettings
-
Returns the
DataFetchStrategyto 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
Doubleobject associated with the specifiedkeyin the default namespace (or in all namespaces depending on theDataFetchStrategyin scope). - getDouble(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Doubleobject associated with the specifiedkey. - getDouble(String) - Method in class net.obvj.confectory.internal.helper.BasicConfigurationHelper
- getDouble(String) - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Returns the
Doubleobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted todouble. - getDouble(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Doubleobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped todouble. - getDouble(String) - Method in class net.obvj.confectory.internal.helper.NullConfigurationHelper
- getDouble(String, String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Doubleobject associated with the specifiedkeyin the specifiednamespace. - getInteger(String) - Method in class net.obvj.confectory.Configuration
- getInteger(String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Integerobject associated with the specifiedkeyin the default namespace (or in all namespaces depending on theDataFetchStrategyin scope). - getInteger(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Integerobject associated with the specifiedkey. - getInteger(String) - Method in class net.obvj.confectory.internal.helper.BasicConfigurationHelper
- getInteger(String) - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Returns the
Integerobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted toint. - getInteger(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Integerobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped toint. - getInteger(String) - Method in class net.obvj.confectory.internal.helper.NullConfigurationHelper
- getInteger(String, String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Integerobject associated with the specifiedkeyin the specifiednamespace. - getLong(String) - Method in class net.obvj.confectory.Configuration
- getLong(String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Longobject associated with the specifiedkeyin the default namespace (or in all namespaces depending on theDataFetchStrategyin scope). - getLong(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Longobject associated with the specifiedkey. - getLong(String) - Method in class net.obvj.confectory.internal.helper.BasicConfigurationHelper
- getLong(String) - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Returns the
Longobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted tolong. - getLong(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Longobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped tolong. - getLong(String) - Method in class net.obvj.confectory.internal.helper.NullConfigurationHelper
- getLong(String, String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Longobject associated with the specifiedkeyin the specifiednamespace. - getMandatoryBoolean(String) - Method in class net.obvj.confectory.Configuration
- getMandatoryBoolean(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Booleanobject associated with the specifiedkey, 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.DocumentConfigurationHelper
-
Returns the
Booleanobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted toboolean. - getMandatoryBoolean(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Booleanobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped toboolean. - 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
Doubleobject associated with the specifiedkey, 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.DocumentConfigurationHelper
-
Returns the
Doubleobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted todouble. - getMandatoryDouble(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Doubleobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped todouble. - 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
Integerobject associated with the specifiedkey, 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.DocumentConfigurationHelper
-
Returns the
Integerobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted toint. - getMandatoryInteger(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Integerobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped toint. - 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
Longobject associated with the specifiedkey, 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.DocumentConfigurationHelper
-
Returns the
Longobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element that can be converted tolong. - getMandatoryLong(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Longobject associated with the specifiedjsonPathin theJsonNodein context, provided that the expression returns a single element that can be mapped tolong. - 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
Stringobject associated with the specifiedkey, 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.DocumentConfigurationHelper
-
Returns the
Stringobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element. - getMandatoryString(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Stringobject associated with the specifiedjsonPathin theJsonNodein 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
Mapperobject associated with thisConfiguration. - 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
Configurationobject. - getNamespaces() - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns all of the namespaces defined inside this container.
- getObjectFactory() - Method in class net.obvj.confectory.settings.ConfectorySettings
- 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
Configurationobject. - getPropertyKey(Property) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Safely returns the property key defined in the
@Propertyannotation, or an empty string if the annotation is null. - getPropertyKeyOrFieldName(Property, Field) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Returns either the property key specified in the
@Propertyannotation or, if not present, the field name. - 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
Sourceobject associated with thisConfiguration. - getString(String) - Method in class net.obvj.confectory.Configuration
- getString(String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Stringobject associated with the specifiedkeyin the default namespace (or in all namespaces depending on theDataFetchStrategyin scope). - getString(String) - Method in interface net.obvj.confectory.ConfigurationDataRetriever
-
Returns the
Stringobject associated with the specifiedkey. - getString(String) - Method in class net.obvj.confectory.internal.helper.BeanConfigurationHelper
- getString(String) - Method in class net.obvj.confectory.internal.helper.DocumentConfigurationHelper
-
Returns the
Stringobject associated with the specifiedXPathexpression in the XML document in context, provided that the expression returns a single element. - getString(String) - Method in class net.obvj.confectory.internal.helper.GenericJsonConfigurationHelper
-
Returns the
Stringobject associated with the specifiedjsonPathin theJsonNodein 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
- getString(String, String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the
Stringobject associated with the specifiedkeyin the specifiednamespace.
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
IllegalArgumentExceptionwith a formatted message. - illegalArgument(Throwable, String, Object...) - Static method in class net.obvj.confectory.util.Exceptions
-
Creates an
IllegalArgumentExceptionwith a cause and a formatted message. - illegalState(String, Object...) - Static method in class net.obvj.confectory.util.Exceptions
-
Creates an
IllegalStateExceptionwith a formatted message. - illegalState(Throwable, String, Object...) - Static method in class net.obvj.confectory.util.Exceptions
-
Creates an
IllegalStateExceptionwith a cause and a formatted message. - INIToJSONObjectMapper - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of a valid INISourceas aJSONObject. - INIToJSONObjectMapper() - Constructor for class net.obvj.confectory.mapper.INIToJSONObjectMapper
- INIToObjectMapper<T> - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of a valid INISource(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
INIToObjectMapperwith the specified target type. - INIToObjectMapper(Class<T>, ObjectFactory) - Constructor for class net.obvj.confectory.mapper.INIToObjectMapper
-
Builds a new
INIToObjectMapperwith the specified target type and a custom object factory. - instance() - Static method in class net.obvj.confectory.settings.ConfectorySettings
- isEmpty() - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns
trueif this container contains noConfigurationobjects. - isEmpty() - Method in class net.obvj.confectory.TypeSafeConfigurationContainer
-
Returns
trueif this container contains noConfigurationobjects. - isFieldAnnotated(Field, String) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Returns
trueif the field is annotated with a Property annotation which key matches the specified name. - 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
Configurationis 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
Configurationis 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
ConfigurationMergerthat combines twoConfigurationobjects of typeJSONObject(usingjson-smartimplementation) into a single one. - JSONObjectConfigurationMerger() - Constructor for class net.obvj.confectory.merger.JSONObjectConfigurationMerger
-
Creates a new JSON Configuration Merger for
JSONObjectusingjson-smartimplementation. - JSONObjectMapper - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of a valid JSONSource(e.g.: file, URL) as aJSONObject(json-smartJSON implementation). - JSONObjectMapper() - Constructor for class net.obvj.confectory.mapper.JSONObjectMapper
- 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.
K
- key() - Method in annotation type net.obvj.confectory.util.Property
-
Defines the property key from the source file/URL to be associated with this field.
L
- lazy() - Method in class net.obvj.confectory.ConfigurationBuilder
-
Marks the new
Configurationas lazy. - LENIENT - net.obvj.confectory.DataFetchStrategy
-
Retrieves sorted data from all
Configurationobjects regardless of their namespaces when no namespace specified during data fetch. - LENIENT_UNSORTED - net.obvj.confectory.DataFetchStrategy
-
Retrieves unsorted data from all
Configurationobjects regardless of their namespaces when no namespace specified during data fetch. - 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>) - Method in class net.obvj.confectory.source.StringSource
- load(Mapper<T>) - Method in class net.obvj.confectory.source.URLSource
- load(Mapper<T>, boolean) - Method in class net.obvj.confectory.source.AbstractSource
- 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.
M
- mapper(Mapper<T>) - Method in class net.obvj.confectory.ConfigurationBuilder
-
Defines the
Mapperof the newConfiguration. - 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
Configurationwith another one, producing a newConfiguration. - merge(Configuration<T>, Configuration<T>, JsonMergeOption...) - Method in class net.obvj.confectory.merger.AbstractConfigurationMerger
- merge(Configuration<T>, Configuration<T>, JsonMergeOption...) - Method in interface net.obvj.confectory.merger.ConfigurationMerger
-
Combines two
Configurationobjects into a newConfiguration. - merge(Configuration<T>, JsonMergeOption...) - Method in class net.obvj.confectory.Configuration
-
Combines this
Configurationwith another one, producing a newConfiguration, using advanced options.
N
- namespace(String) - Method in class net.obvj.confectory.ConfigurationBuilder
-
Declares a namespace to be assigned to the new
Configurationobject. - 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
Configurationformats. - net.obvj.confectory.mapper - package net.obvj.confectory.mapper
-
This package groups the
Mapperinterface and its implementations, as well as auxiliary classes. - net.obvj.confectory.merger - package net.obvj.confectory.merger
-
This package contains the
ConfigurationMergerimplementations, 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
Sourceinterface 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
ConfigurationHelperfor the givenMapper. - newObject(Class<T>) - Method in enum net.obvj.confectory.util.ObjectFactory
-
Creates a new instance of the specified class.
- NullConfigurationHelper<T> - Class in net.obvj.confectory.internal.helper
-
A "no-op" Configuration Helper object for situations where an optional
Configurationobject 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
NullConfigurationHelperwith a reference to the original/expectedConfigurationHelper.
O
- ObjectFactory - Enum in net.obvj.confectory.util
-
A factory that encapsulates the logic to reflectively produce new objects depending on the desired strategy.
- OBJENESIS - net.obvj.confectory.util.ObjectFactory
-
Alternative object factory that uses a variety of approaches to attempt to instantiate the object, depending on the type of object, JVM version, JVM vendor and Security Manager present.
- optional() - Method in class net.obvj.confectory.ConfigurationBuilder
-
Marks the new
Configurationas optional.
P
- parse(Class<T>, String) - Static method in class net.obvj.confectory.util.TypeFactory
-
Parses the contents of a string into the specified type.
- parseDateRfc3339(String) - Static method in class net.obvj.confectory.util.DateUtils
-
Parses the given date-time representation string based in RFC-3339 format, producing a
Date. - ParseException - Exception in net.obvj.confectory.util
-
A specialized runtime exception that signals that an error has been reached unexpectedly while parsing.
- ParseException(String, Object...) - Constructor for exception net.obvj.confectory.util.ParseException
-
Constructs a new exception with the specified detail message.
- ParseException(Throwable) - Constructor for exception net.obvj.confectory.util.ParseException
-
Constructs a new exception with the specified cause.
- ParseException(Throwable, String, Object...) - Constructor for exception net.obvj.confectory.util.ParseException
-
Constructs a new exception with the specified detail message and cause.
- parseInstantRfc3339(String) - Static method in class net.obvj.confectory.util.DateUtils
-
Parses the given date-time representation string based in RFC-3339 format, producing an
Instant. - parseValue(String, Class<?>, Property, ObjectFactory) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Parse the specified value into an object of the specified type.
- parseValue(String, Field, ObjectFactory) - Static method in class net.obvj.confectory.util.PropertyUtils
-
Parse the specified value into an object based on the field type.
- precedence(int) - Method in class net.obvj.confectory.ConfigurationBuilder
-
Defines the level of precedence of the new
Configurationcompared to similar objects in the same namespace. - PropertiesConfigurationHelper - Class in net.obvj.confectory.internal.helper
-
A specialized Configuration Helper that retrieves data from a
Propertiesobject. - PropertiesConfigurationHelper(Properties) - Constructor for class net.obvj.confectory.internal.helper.PropertiesConfigurationHelper
-
Builds a new dedicated instance from a specific
Propertiesobject. - PropertiesConfigurationMerger - Class in net.obvj.confectory.merger
-
A specialized
ConfigurationMergerthat combines twoConfigurationobjects of typePropertiesinto a single one. - PropertiesConfigurationMerger() - Constructor for class net.obvj.confectory.merger.PropertiesConfigurationMerger
- PropertiesMapper - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of aSource(e.g.: file, URL) asProperties(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
Mapperthat loads the contents of aSource(e.g.: file, URL) in thePropertiesformat (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.
- PropertiesToObjectMapper(Class<T>, ObjectFactory) - Constructor for class net.obvj.confectory.mapper.PropertiesToObjectMapper
-
Builds a new Properties Mapper with the specified target type and a custom object factory.
- 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.
- PropertyUtils - Class in net.obvj.confectory.util
-
Common methods for working with the
Propertyannotation.
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
Configurationas required (default). - reset() - Method in class net.obvj.confectory.settings.ConfectorySettings
-
Resets
Confectoryconfiguration.
S
- setDataFetchStrategy(DataFetchStrategy) - Method in class net.obvj.confectory.ConfigurationContainer
-
Defines a custom
DataFetchStrategyfor this container. - setDataFetchStrategy(DataFetchStrategy) - Method in class net.obvj.confectory.settings.ConfectorySettings
-
Defines the
DataFetchStrategyto be applied by default when no specific strategy is defined. - setObjectFactory(ObjectFactory) - Method in class net.obvj.confectory.settings.ConfectorySettings
-
Defines the
ObjectFactoryto produce new objects. - settings() - Static method in class net.obvj.confectory.Confectory
-
Returns an object containing global settings for the
Confectoryproject. - size() - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the number of
Configurationobjects in this container. - size() - Method in class net.obvj.confectory.TypeSafeConfigurationContainer
-
Returns the number of
Configurationobjects in this container. - size(String) - Method in class net.obvj.confectory.ConfigurationContainer
-
Returns the number of
Configurationobjects associated with the specifiednamespacein this container. - size(String) - Method in class net.obvj.confectory.TypeSafeConfigurationContainer
-
Returns the number of
Configurationobjects associated with the specifiednamespacein this container. - source(String) - Method in class net.obvj.confectory.ConfigurationBuilder
-
Defines a
DynamicSourcewith the specified path for the newConfiguration. - source(Source<T>) - Method in class net.obvj.confectory.ConfigurationBuilder
-
Defines the
Sourceof the newConfiguration. - 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
Sourceimplementations. - STRICT - net.obvj.confectory.DataFetchStrategy
-
Retrieves sorted data from
Configurationobjects declared with a specific namespace. - STRICT_UNSORTED - net.obvj.confectory.DataFetchStrategy
-
Retrieves unsorted data from
Configurationobjects declared with a specific namespace. - StringMapper - Class in net.obvj.confectory.mapper
-
A specialized
Mapperthat loads the contents of aSource(e.g.: file, URL) as aStringusing the JVM defaultCharset. - StringMapper() - Constructor for class net.obvj.confectory.mapper.StringMapper
- stringSource(String) - Static method in class net.obvj.confectory.source.SourceFactory
-
Creates a new
StringSourcefor loading contents of aString. - StringSource<T> - Class in net.obvj.confectory.source
-
A specialized
Sourcethat loads the contents of aString. - 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.source.StringSource
- toString(Node) - Static method in class net.obvj.confectory.util.XMLUtils
-
Returns a string representation of the specified XML
Node. - toString(NodeList) - Static method in class net.obvj.confectory.util.XMLUtils
-
Returns a string representation of the specified XML
NodeList. - transformerFactory() - Static method in class net.obvj.confectory.util.XMLUtils
-
Obtain a new instance of a
TransformerFactorywhich is considered to be secure against XXE (XML External Entity) attacks. - TypeConverter<T> - Interface in net.obvj.confectory.util
-
This interface defines the contract for classes that know how to convert a String into some domain object.
- TypeFactory - Class in net.obvj.confectory.util
-
A class that contains built-in parsers from string into common object types, typically for Reflection purposes.
- TypeSafeConfigurationContainer<T> - Class in net.obvj.confectory
-
An object that holds multiple
Configurationobjects of the same generic type<T>and selects the highest-precedence available ones whengetBean()is called. - TypeSafeConfigurationContainer(Configuration<T>...) - Constructor for class net.obvj.confectory.TypeSafeConfigurationContainer
-
Builds a new
TypeSafeConfigurationContainerwith an arbitrary number of presetConfigurationobjects to be registered. - TypeSafeConfigurationContainer(DataFetchStrategy, Configuration<?>...) - Constructor for class net.obvj.confectory.TypeSafeConfigurationContainer
-
Builds a new
TypeSageConfigurationContainerwith a customDataFetchStrategyand an arbitrary number of presetConfigurationobjects.
U
- UNSAFE - Static variable in class net.obvj.confectory.util.UnsafeAccessor
-
A object with capabilities to performs low-level operations in the JVM.
- UnsafeAccessor - Class in net.obvj.confectory.util
-
A class that allows to get access to
sun.misc.Unsafe. - urlSource(String) - Static method in class net.obvj.confectory.source.SourceFactory
-
Creates a new
URLSourcefor 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
- value() - Method in annotation type net.obvj.confectory.util.Property
-
Defines the property key from the source file/URL to be associated with this field.
- valueOf(String) - Static method in enum net.obvj.confectory.DataFetchStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.obvj.confectory.util.ObjectFactory
-
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.
- values() - Static method in enum net.obvj.confectory.util.ObjectFactory
-
Returns an array containing the constants of this enum type, in the order they are declared.
X
- XMLUtils - Class in net.obvj.confectory.util
-
Common methods for working with XML.
All Classes All Packages