ru.qatools.properties

Class PropertyLoader

java.lang.Object

ru.qatools.properties.PropertyLoader

public class PropertyLoader
extends Object

Author:

Dmitry Baev charlie@yandex-team.ru Eroshenko Artem eroshenkoam@yandex-team.ru Date: 09.04.15

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader
protected Properties	compiled
protected Properties	defaults
protected ConverterManager	manager
protected PropertyProvider	propertyProvider

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkConfigurationClass(Class<?> clazz) Check that given class is interface.
protected void	checkRequired(String key, AnnotatedElement element) Throws an exception if given element is required.
protected void	compileProperties(Class<?> clazz) Compile properties to compiled field.
protected Object	convertValue(AnnotatedElement element, String value) Convert given value to specified type.
ClassLoader	getClassLoader()
protected Class<?>	getCollectionElementType(Type genericType) Get collection element type for given type.
Properties	getCompiled()
protected Converter	getConverterForElementWithUseAnnotation(AnnotatedElement element) Returns new instance of converter specified in Use annotation for given element.
Properties	getDefaults()
protected String	getKey(String prefix, AnnotatedElement element) Get property key for specified element with given prefix.
protected String	getPropertyDefaultValue(AnnotatedElement element) Get the default value for given element.
PropertyProvider	getPropertyProvider()
protected Type	getValueGenericType(AnnotatedElement element) Returns the generic type of the value for given element.
protected Class<?>	getValueType(AnnotatedElement element) Returns the type of the value for given element.
protected boolean	isRequired(AnnotatedElement element) Returns true if annotatedElement marked as required with Required.
static PropertyLoader	newInstance() Do not instance class by yourself.
<T> T	populate(Class<T> clazz)
<T> T	populate(Class<T> clazz, Set<Class> resolvedConfigs) Shortcut for populate(String, Class, Set).
void	populate(Object bean) Populate given bean using properties from defaults and PropertyProvider.provide(ClassLoader, Class)
<T> T	populate(String prefix, Class<T> clazz, Set<Class> resolvedConfigs) Creates a proxy instance of given configuration.
<T> PropertyLoader	register(Converter<T> converter, Class<T> type) Register custom converter for given type.
protected <T extends AnnotatedElement> Map<T,PropertyInfo>	resolveProperties(String keyPrefix, T[] elements) Return PropertyInfo for each of given elements.
protected <T extends AnnotatedElement> Map<T,PropertyInfo>	resolveProperties(T[] elements) Shortcut for resolveProperties(String, AnnotatedElement[]).
void	setClassLoader(ClassLoader classLoader)
void	setDefaults(Properties defaults)
void	setPropertyProvider(PropertyProvider propertyProvider)
protected void	setValueToField(Field field, Object bean, Object value) Set given value to specified field of given object.
protected boolean	shouldDecorate(AnnotatedElement element) Returns true if given annotatedElement should be decorated, false otherwise.
PropertyLoader	withClassLoader(ClassLoader classLoader) Fluent-api builder.
PropertyLoader	withDefaults(Properties defaults) Fluent-api builder.
PropertyLoader	withPropertyProvider(PropertyProvider propertyProvider) Fluent-api builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classLoader

protected ClassLoader classLoader

defaults

protected Properties defaults

compiled

protected Properties compiled

propertyProvider

protected PropertyProvider propertyProvider

manager

protected final ConverterManager manager

Method Detail

populate

public void populate(Object bean)

Populate given bean using properties from defaults and PropertyProvider.provide(ClassLoader, Class)

populate

public <T> T populate(Class<T> clazz)

populate

public <T> T populate(Class<T> clazz,
             Set<Class> resolvedConfigs)

Shortcut for populate(String, Class, Set).

populate

public <T> T populate(String prefix,
             Class<T> clazz,
             Set<Class> resolvedConfigs)

Creates a proxy instance of given configuration.

setValueToField

protected void setValueToField(Field field,
                   Object bean,
                   Object value)

Set given value to specified field of given object.

Throws:

PropertyLoaderException - if some exceptions occurs during reflection calls.

See Also:

AccessibleObject.setAccessible(boolean), Field.set(Object, Object)

checkConfigurationClass

protected void checkConfigurationClass(Class<?> clazz)

Check that given class is interface.

compileProperties

protected void compileProperties(Class<?> clazz)

Compile properties to compiled field.

resolveProperties

protected <T extends AnnotatedElement> Map<T,PropertyInfo> resolveProperties(T[] elements)

Shortcut for resolveProperties(String, AnnotatedElement[]).

resolveProperties

protected <T extends AnnotatedElement> Map<T,PropertyInfo> resolveProperties(String keyPrefix,
                                                                 T[] elements)

Return PropertyInfo for each of given elements.

shouldDecorate

protected boolean shouldDecorate(AnnotatedElement element)

Returns true if given annotatedElement should be decorated, false otherwise.

checkRequired

protected void checkRequired(String key,
                 AnnotatedElement element)

Throws an exception if given element is required.

See Also:

isRequired(AnnotatedElement)

isRequired

protected boolean isRequired(AnnotatedElement element)

Returns true if annotatedElement marked as required with Required.

getPropertyDefaultValue

protected String getPropertyDefaultValue(AnnotatedElement element)

Get the default value for given element. Annotation Property should be present.

getKey

protected String getKey(String prefix,
            AnnotatedElement element)

Get property key for specified element with given prefix. Annotation Property should be present.

convertValue

protected Object convertValue(AnnotatedElement element,
                  String value)

Convert given value to specified type. If given element annotated with Use annotation use getConverterForElementWithUseAnnotation(AnnotatedElement) converter, otherwise if element has collection type convert collection and finally try to convert element using registered converters.

getValueType

protected Class<?> getValueType(AnnotatedElement element)

Returns the type of the value for given element. Field and Method are only supported.

getValueGenericType

protected Type getValueGenericType(AnnotatedElement element)

Returns the generic type of the value for given element. Field and Method are only supported.

getCollectionElementType

protected Class<?> getCollectionElementType(Type genericType)
                                     throws ConversionException

Get collection element type for given type. Given type type should be assignable from Collection. For collections without generic returns String.

Throws:

ConversionException

getConverterForElementWithUseAnnotation

protected Converter getConverterForElementWithUseAnnotation(AnnotatedElement element)

Returns new instance of converter specified in Use annotation for given element.

Parameters:

element - given element with Use annotation.

register

public <T> PropertyLoader register(Converter<T> converter,
                          Class<T> type)

Register custom converter for given type.

getCompiled

public Properties getCompiled()

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

See Also:

classLoader

withClassLoader

public PropertyLoader withClassLoader(ClassLoader classLoader)

Fluent-api builder.

See Also:

setClassLoader(ClassLoader)

getDefaults

public Properties getDefaults()

setDefaults

public void setDefaults(Properties defaults)

See Also:

defaults

withDefaults

public PropertyLoader withDefaults(Properties defaults)

Fluent-api builder.

See Also:

setDefaults(Properties)

getPropertyProvider

public PropertyProvider getPropertyProvider()

setPropertyProvider

public void setPropertyProvider(PropertyProvider propertyProvider)

See Also:

propertyProvider

withPropertyProvider

public PropertyLoader withPropertyProvider(PropertyProvider propertyProvider)

Fluent-api builder.

See Also:

setPropertyProvider(PropertyProvider)

newInstance

public static PropertyLoader newInstance()

Do not instance class by yourself. Use this builder