Index

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

A

AbstractConfiguration - Class in org.myjtools.imconfig.internal
 
AbstractConfiguration(Map<String, PropertyDefinition>) - Constructor for class org.myjtools.imconfig.internal.AbstractConfiguration
 
accepts(String) - Method in interface org.myjtools.imconfig.PropertyType
Check if the current type accepts the given value
accepts(String) - Method in class org.myjtools.imconfig.types.BooleanPropertyType
 
accepts(String) - Method in class org.myjtools.imconfig.types.DecimalPropertyType
 
accepts(String) - Method in class org.myjtools.imconfig.types.EnumPropertyType
 
accepts(String) - Method in class org.myjtools.imconfig.types.IntegerPropertyType
 
accepts(String) - Method in class org.myjtools.imconfig.types.TextPropertyType
 
accordingDefinitions(Collection<PropertyDefinition>) - Method in interface org.myjtools.imconfig.Config
Create a new configuration according the given property definitions.
accordingDefinitions(Collection<PropertyDefinition>) - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
AnnotatedConfig - Annotation Interface in org.myjtools.imconfig
This annotation allows classes to be used as a data source for a configuration
ApacheConfiguration2 - Class in org.myjtools.imconfig.internal
 
ApacheConfiguration2(Map<String, PropertyDefinition>, Configuration) - Constructor for class org.myjtools.imconfig.internal.ApacheConfiguration2
 
ApacheConfiguration2(Configuration) - Constructor for class org.myjtools.imconfig.internal.ApacheConfiguration2
 
ApacheConfiguration2ConversionHandler - Class in org.myjtools.imconfig.internal
 
ApacheConfiguration2ConversionHandler() - Constructor for class org.myjtools.imconfig.internal.ApacheConfiguration2ConversionHandler
 
append(Config) - Method in interface org.myjtools.imconfig.Config
Create a new configuration resulting in the merge the current configuration with another one
append(Config) - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
asMap() - Method in interface org.myjtools.imconfig.Config
 
asMap() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
asProperties() - Method in interface org.myjtools.imconfig.Config
 
asProperties() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

B

BooleanPropertyType - Class in org.myjtools.imconfig.types
 
BooleanPropertyType() - Constructor for class org.myjtools.imconfig.types.BooleanPropertyType
 
booleanType() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
build() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
builder() - Static method in class org.myjtools.imconfig.PropertyDefinition
Get a new builder
builder(String) - Static method in class org.myjtools.imconfig.PropertyDefinition
Get a new builder for the given property

C

ClasspathURLStreamHandler - Class in org.myjtools.imconfig.internal
This class implements the virtual protocol 'classpath:' to be used in URLs
ClasspathURLStreamHandler(ClassLoader) - Constructor for class org.myjtools.imconfig.internal.ClasspathURLStreamHandler
 
conf - Variable in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
Config - Interface in org.myjtools.imconfig
The main interface used to get configuration values and create derived configurations.
ConfigClass - Annotation Interface in org.myjtools.imconfig
 
ConfigException - Exception Class in org.myjtools.imconfig
Multi-purpose runtime exception for any error occurred during the creation of a new configuration.
ConfigException(String) - Constructor for exception class org.myjtools.imconfig.ConfigException
 
ConfigException(String, Throwable) - Constructor for exception class org.myjtools.imconfig.ConfigException
 
ConfigException(Throwable) - Constructor for exception class org.myjtools.imconfig.ConfigException
 
ConfigFactory - Class in org.myjtools.imconfig.internal
 
ConfigFactory() - Constructor for class org.myjtools.imconfig.internal.ConfigFactory
 
ConfigProperty - Annotation Interface in org.myjtools.imconfig
Pair of [key,value] used in AnnotatedConfig.value()
Configurable - Interface in org.myjtools.imconfig
A convenient interface for objects that can apply a configuration to themselves.
configure(Config) - Method in interface org.myjtools.imconfig.Configurable
Apply the given configuration
configure(T, Config) - Method in interface org.myjtools.imconfig.Configurer
Apply the given configuration to the specified object
Configurer<T> - Interface in org.myjtools.imconfig
A convenient interface for objects that can apply a configuration to another object.
convertValue(Object, Class<T>, ConfigurationInterpolator) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2ConversionHandler
 

D

DecimalPropertyType - Class in org.myjtools.imconfig.types
 
DecimalPropertyType(Number, Number) - Constructor for class org.myjtools.imconfig.types.DecimalPropertyType
 
decimalType() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
decimalType(Number, Number) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
defaultValue() - Method in class org.myjtools.imconfig.PropertyDefinition
 
defaultValue(String) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
definitions - Variable in class org.myjtools.imconfig.internal.AbstractConfiguration
 
description() - Method in class org.myjtools.imconfig.PropertyDefinition
 
description(String) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 

E

empty() - Static method in interface org.myjtools.imconfig.Config
Create a new empty configuration
EMPTY - Static variable in class org.myjtools.imconfig.internal.ConfigFactory
 
EnumPropertyType - Class in org.myjtools.imconfig.types
 
EnumPropertyType(List<String>) - Constructor for class org.myjtools.imconfig.types.EnumPropertyType
 
enumType(String...) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
env() - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from the environment properties
ENVIRONMENT - Static variable in class org.myjtools.imconfig.internal.ConfigFactory
 

F

factory - Static variable in interface org.myjtools.imconfig.Config
 
filtered(String) - Method in interface org.myjtools.imconfig.Config
Creates a new configuration resulting of filtering the properties starting with the given prefix
filtered(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
forEach(BiConsumer<String, String>) - Method in interface org.myjtools.imconfig.Config
Perform an action for each pair [key,value]
forEach(BiConsumer<String, String>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

G

get(String, Class<T>) - Method in interface org.myjtools.imconfig.Config
 
get(String, Class<T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
get(String, Function<String, T>) - Method in interface org.myjtools.imconfig.Config
 
get(String, Function<String, T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getDefinition(String) - Method in interface org.myjtools.imconfig.Config
Retrieve the property definition for a given property
getDefinition(String) - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
getDefinitions() - Method in interface org.myjtools.imconfig.Config
Retrieve every property definition defined for this configuration
getDefinitions() - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
getDefinitionsToString() - Method in interface org.myjtools.imconfig.Config
Get a textual representation of all defined properties
getDefinitionsToString() - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
getDouble(String) - Method in interface org.myjtools.imconfig.Config
 
getDouble(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getFloat(String) - Method in interface org.myjtools.imconfig.Config
 
getFloat(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getInteger(String) - Method in interface org.myjtools.imconfig.Config
 
getInteger(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getList(String, Class<T>) - Method in interface org.myjtools.imconfig.Config
 
getList(String, Class<T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getLong(String) - Method in interface org.myjtools.imconfig.Config
 
getLong(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getObject(Class<T>) - Method in interface org.myjtools.imconfig.Config
Instantiate a new object with its fields filled according the configuration.
getObject(Class<T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getSet(String, Class<T>) - Method in interface org.myjtools.imconfig.Config
 
getSet(String, Class<T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getStream(String, Class<T>) - Method in interface org.myjtools.imconfig.Config
 
getStream(String, Class<T>) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
getString(String) - Method in interface org.myjtools.imconfig.Config
 
getString(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

H

hasDefinition(String) - Method in interface org.myjtools.imconfig.Config
 
hasDefinition(String) - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
hasMultivalueSeparator() - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
hasProperty(String) - Method in interface org.myjtools.imconfig.Config
 
hasProperty(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
hint() - Method in class org.myjtools.imconfig.PropertyDefinition
 
hint() - Method in interface org.myjtools.imconfig.PropertyType
 
hint() - Method in class org.myjtools.imconfig.types.BooleanPropertyType
 
hint() - Method in class org.myjtools.imconfig.types.DecimalPropertyType
 
hint() - Method in class org.myjtools.imconfig.types.EnumPropertyType
 
hint() - Method in class org.myjtools.imconfig.types.IntegerPropertyType
 
hint() - Method in class org.myjtools.imconfig.types.TextPropertyType
 

I

inner(String) - Method in interface org.myjtools.imconfig.Config
Creates a new configuration resulting of filtering the properties starting with the given prefix, and the removing it
inner(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
IntegerPropertyType - Class in org.myjtools.imconfig.types
 
IntegerPropertyType(Number, Number) - Constructor for class org.myjtools.imconfig.types.IntegerPropertyType
 
integerType() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
integerType(Number, Number) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
isEmpty() - Method in interface org.myjtools.imconfig.Config
 
isEmpty() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
isNotEmpty() - Method in interface org.myjtools.imconfig.Config
 
isNotEmpty() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

K

key() - Element in annotation interface org.myjtools.imconfig.Property
The property key
keys() - Method in interface org.myjtools.imconfig.Config
 
keys() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

L

loadDefinitions(URI) - Static method in interface org.myjtools.imconfig.Config
Create a new defined configuration
loadDefinitions(URI) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
loadDefinitionsFromResource(String, ClassLoader) - Static method in interface org.myjtools.imconfig.Config
Create a new defined configuration
loadDefinitionsFromResource(String, ClassLoader) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 

M

max() - Method in class org.myjtools.imconfig.types.IntegerPropertyType
 
merge(Config, Config) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
min() - Method in class org.myjtools.imconfig.types.IntegerPropertyType
 
multivalue() - Method in class org.myjtools.imconfig.PropertyDefinition
 
multivalue() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
multivalue(Boolean) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
multivalueSeparator() - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
multivalueSeparator(char) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 

N

name() - Method in interface org.myjtools.imconfig.PropertyType
The type name (for describing purposes).
name() - Method in class org.myjtools.imconfig.types.BooleanPropertyType
 
name() - Method in class org.myjtools.imconfig.types.DecimalPropertyType
 
name() - Method in class org.myjtools.imconfig.types.EnumPropertyType
 
name() - Method in class org.myjtools.imconfig.types.IntegerPropertyType
 
name() - Method in class org.myjtools.imconfig.types.TextPropertyType
 
notHasProperty(String) - Method in interface org.myjtools.imconfig.Config
 
notHasProperty(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 

O

ofClass(Class<?>) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from an annotated class
ofClass(Class<?>) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
ofClass(AnnotatedConfig) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
ofMap(Map<String, ?>) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from a map
ofMap(Map<String, ?>) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
ofPath(Path) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from the file of the given path
ofProperties(Properties) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from a properties object
ofProperties(Properties) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
ofResource(String, ClassLoader) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from the file of the classpath resource
ofResource(String, ClassLoader) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
ofURI(URI) - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from the file of the given URI
ofURI(URI) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
openConnection(URL) - Method in class org.myjtools.imconfig.internal.ClasspathURLStreamHandler
 
org.myjtools.imconfig - module org.myjtools.imconfig
This module provides a simple interface in order to load and consume configurations, which are mainly a set of valued properties that can be parsed from a wide range of sources (such as JSON, YAML or .properties files, Map and Properties objects, or even plain pairs of values) to specific Java types.
org.myjtools.imconfig - package org.myjtools.imconfig
 
org.myjtools.imconfig.internal - package org.myjtools.imconfig.internal
 
org.myjtools.imconfig.types - package org.myjtools.imconfig.types
 

P

pattern() - Method in class org.myjtools.imconfig.types.TextPropertyType
 
property() - Method in class org.myjtools.imconfig.PropertyDefinition
 
property(String) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
Property - Annotation Interface in org.myjtools.imconfig
Pair of [key,value] used in AnnotatedConfig.value()
PropertyDefinition - Class in org.myjtools.imconfig
This class instantiates an immutable value object that represents the definition of a given property.
PropertyDefinitionBuilder - Class in org.myjtools.imconfig
This class allows you to create new PropertyDefinition objects in a fluent manner, setting only the actual information you required.
PropertyDefinitionBuilder() - Constructor for class org.myjtools.imconfig.PropertyDefinitionBuilder
 
PropertyDefinitionParser - Class in org.myjtools.imconfig.internal
 
PropertyDefinitionParser() - Constructor for class org.myjtools.imconfig.internal.PropertyDefinitionParser
 
propertyType() - Method in class org.myjtools.imconfig.PropertyDefinition
 
propertyType(PropertyType) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
PropertyType - Interface in org.myjtools.imconfig
This class determines what are the accepted values for an specific property.

R

read(InputStream) - Method in class org.myjtools.imconfig.internal.PropertyDefinitionParser
 
required() - Method in class org.myjtools.imconfig.PropertyDefinition
 
required() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
required(Boolean) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 

S

system() - Static method in interface org.myjtools.imconfig.Config
Create a new configuration from the system properties
SYSTEM - Static variable in class org.myjtools.imconfig.internal.ConfigFactory
 

T

TextPropertyType - Class in org.myjtools.imconfig.types
 
TextPropertyType(String) - Constructor for class org.myjtools.imconfig.types.TextPropertyType
 
textType() - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
textType(String) - Method in class org.myjtools.imconfig.PropertyDefinitionBuilder
 
toString() - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
toString() - Method in class org.myjtools.imconfig.PropertyDefinition
 
type() - Method in class org.myjtools.imconfig.PropertyDefinition
 

V

validate() - Method in interface org.myjtools.imconfig.Config
Ensures that all property values are valid according the current definition.
validate() - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
validate(String) - Method in class org.myjtools.imconfig.PropertyDefinition
 
validations() - Method in interface org.myjtools.imconfig.Config
Return a map in form of property=[validation_message1,...] with the validation error messages for all invalid properties values according the current definition.
validations() - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
validations(String) - Method in interface org.myjtools.imconfig.Config
Check whether the current value for the given property is valid according its definition.
validations(String) - Method in class org.myjtools.imconfig.internal.AbstractConfiguration
 
value() - Element in annotation interface org.myjtools.imconfig.AnnotatedConfig
Pairs of [key,value] that defines the configuration
value() - Element in annotation interface org.myjtools.imconfig.ConfigProperty
The key of the property
value() - Element in annotation interface org.myjtools.imconfig.Property
The value (either single or multiple) of the property
values() - Method in class org.myjtools.imconfig.types.EnumPropertyType
 

W

withDefinitions(Collection<PropertyDefinition>) - Static method in interface org.myjtools.imconfig.Config
Create a new defined configuration from a set of definitions
withDefinitions(Collection<PropertyDefinition>) - Method in class org.myjtools.imconfig.internal.ConfigFactory
 
withPrefix(String) - Method in interface org.myjtools.imconfig.Config
Creates a new configuration resulting of adding the given prefix to every key
withPrefix(String) - Method in class org.myjtools.imconfig.internal.ApacheConfiguration2
 
A B C D E F G H I K L M N O P R S T V W 
All Classes and Interfaces|All Packages|Serialized Form