ch.jalu.configme.beanmapper.propertydescription

Class BeanDescriptionFactoryImpl

java.lang.Object

ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

All Implemented Interfaces:

BeanDescriptionFactory

public class BeanDescriptionFactoryImpl
extends Object
implements BeanDescriptionFactory

Creates all BeanPropertyDescription objects for a given class.

This description factory returns property descriptions for all properties on a class for which a getter and setter is associated. Inherited properties are considered.

This implementation supports ExportName and transient properties, declared either with the transient keyword or by adding the Transient annotation.

Constructor Summary

Constructors

Constructor and Description
BeanDescriptionFactoryImpl()

Method Summary

Modifier and Type	Method and Description
protected List<BeanPropertyDescription>	collectAllProperties(Class<?> clazz) Collects all properties available on the given class.
protected List<Class<?>>	collectClassAndAllParents(Class<?> clazz) Returns a list of the class' parents, including the given class itself, with the top-most parent coming first.
protected BeanPropertyDescription	convert(PropertyDescriptor descriptor) Converts a PropertyDescriptor to a BeanPropertyDescription object.
protected Map<String,Integer>	createFieldNameOrderMap(Class<?> clazz) Creates a map of index (encounter number) by field name for all fields of the given class, including its superclasses.
protected TypeInformation	createTypeInfo(PropertyDescriptor descriptor)
Collection<BeanPropertyDescription>	getAllProperties(Class<?> clazz) Returns all properties of the given bean class for which there exists a getter and setter.
protected String	getPropertyName(PropertyDescriptor descriptor) Returns the name which is used in the export files for the given property descriptor.
protected List<PropertyDescriptor>	getWritableProperties(Class<?> clazz) Returns all properties of the given class that are writable (all bean properties with an associated read and write method).
protected List<PropertyDescriptor>	sortPropertiesList(Class<?> clazz, List<PropertyDescriptor> properties) Returns a sorted list of the given properties which will be used for further processing and whose order will be maintained.
protected void	validateProperties(Class<?> clazz, Collection<BeanPropertyDescription> properties) Validates the class' properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanDescriptionFactoryImpl

public BeanDescriptionFactoryImpl()

Method Detail

getAllProperties

public Collection<BeanPropertyDescription> getAllProperties(Class<?> clazz)

Returns all properties of the given bean class for which there exists a getter and setter.

Specified by:

getAllProperties in interface BeanDescriptionFactory

Parameters:

clazz - the bean property to process

Returns:

the bean class' properties to handle

collectAllProperties

protected List<BeanPropertyDescription> collectAllProperties(Class<?> clazz)

Collects all properties available on the given class.

Parameters:

clazz - the class to process

Returns:

properties of the class

convert

@Nullable
protected BeanPropertyDescription convert(PropertyDescriptor descriptor)

Converts a PropertyDescriptor to a BeanPropertyDescription object.

Parameters:

descriptor - the descriptor to convert

Returns:

the converted object, or null if the property should be skipped

validateProperties

protected void validateProperties(Class<?> clazz,
                                  Collection<BeanPropertyDescription> properties)

Validates the class' properties.

Parameters:

clazz - the class to which the properties belong

properties - the properties that will be used on the class

getPropertyName

protected String getPropertyName(PropertyDescriptor descriptor)

Returns the name which is used in the export files for the given property descriptor.

Parameters:

descriptor - the descriptor to get the name for

Returns:

the property name

createTypeInfo

protected TypeInformation createTypeInfo(PropertyDescriptor descriptor)

getWritableProperties

protected List<PropertyDescriptor> getWritableProperties(Class<?> clazz)

Returns all properties of the given class that are writable (all bean properties with an associated read and write method).

Parameters:

clazz - the class to process

Returns:

all writable properties of the bean class

sortPropertiesList

protected List<PropertyDescriptor> sortPropertiesList(Class<?> clazz,
                                                      List<PropertyDescriptor> properties)

Returns a sorted list of the given properties which will be used for further processing and whose order will be maintained. May return the same list.

Parameters:

clazz - the class from which the properties come from

properties - the properties to sort

Returns:

sorted properties

createFieldNameOrderMap

protected Map<String,Integer> createFieldNameOrderMap(Class<?> clazz)

Creates a map of index (encounter number) by field name for all fields of the given class, including its superclasses. Fields are sorted by declaration order in the classes; sorted by top-most class in the inheritance hierarchy to the lowest (the class provided as parameter).

Parameters:

clazz - the class to create the field index map for

Returns:

map with all field names as keys and its index as value

collectClassAndAllParents

protected List<Class<?>> collectClassAndAllParents(Class<?> clazz)

Returns a list of the class' parents, including the given class itself, with the top-most parent coming first. Does not include the Object class.

Parameters:

clazz - the class whose parents should be collected

Returns:

list of all of the class' parents, sorted by highest class in the hierarchy to lowest