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 @NotNull List<BeanPropertyDescription>	collectAllProperties(@NotNull Class<?> clazz) Collects all properties available on the given class.
protected @NotNull List<Class<?>>	collectClassAndAllParents(@NotNull Class<?> clazz) Returns a list of the class's parents, including the given class itself, with the top-most parent coming first.
protected @Nullable BeanPropertyDescription	convert(@NotNull PropertyDescriptor descriptor) Converts a PropertyDescriptor to a BeanPropertyDescription object.
protected @NotNull Map<String,Integer>	createFieldNameOrderMap(@NotNull Class<?> clazz) Creates a map of index (encounter number) by field name for all fields of the given class, including its superclasses.
protected @NotNull TypeInformation	createTypeInfo(@NotNull PropertyDescriptor descriptor)
@NotNull Collection<BeanPropertyDescription>	getAllProperties(@NotNull Class<?> clazz) Returns all properties of the given bean class for which there exists a getter and setter.
protected @NotNull BeanPropertyComments	getComments(@Nullable Field field) Returns the comments that are defined on the property.
protected @NotNull String	getPropertyName(@NotNull PropertyDescriptor descriptor, @Nullable Field field) Returns the name which is used in the export files for the given property descriptor.
protected @NotNull List<PropertyDescriptor>	getWritableProperties(@NotNull Class<?> clazz) Returns all properties of the given class that are writable (all bean properties with an associated read and write method).
protected @NotNull List<PropertyDescriptor>	sortPropertiesList(@NotNull Class<?> clazz, @NotNull 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 @Nullable Field	tryGetField(@NotNull Class<?> clazz, @NotNull String name) Returns the field with the given name on the provided class, or null if it doesn't exist.
protected void	validateProperties(@NotNull Class<?> clazz, @NotNull Collection<BeanPropertyDescription> properties) Validates the class's 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

@NotNull
public @NotNull Collection<BeanPropertyDescription> getAllProperties(@NotNull
                                                                              @NotNull 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's properties to handle

collectAllProperties

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

Collects all properties available on the given class.

Parameters:

clazz - the class to process

Returns:

properties of the class

convert

@Nullable
protected @Nullable BeanPropertyDescription convert(@NotNull
                                                              @NotNull 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

getComments

@NotNull
protected @NotNull BeanPropertyComments getComments(@Nullable
                                                             @Nullable Field field)

Returns the comments that are defined on the property. Comments are found by looking for an @Comment annotation on a field with the same name as the property.

Parameters:

field - the field associated with the property (may be null)

Returns:

comments for the property (never null)

tryGetField

@Nullable
protected @Nullable Field tryGetField(@NotNull
                                                @NotNull Class<?> clazz,
                                                @NotNull
                                                @NotNull String name)

Returns the field with the given name on the provided class, or null if it doesn't exist.

Parameters:

clazz - the class to search in

name - the field name to look for

Returns:

the field if matched, otherwise null

validateProperties

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

Validates the class's properties.

Parameters:

clazz - the class to which the properties belong

properties - the properties that will be used on the class

getPropertyName

@NotNull
protected @NotNull String getPropertyName(@NotNull
                                                   @NotNull PropertyDescriptor descriptor,
                                                   @Nullable
                                                   @Nullable Field field)

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

Parameters:

descriptor - the descriptor to get the name for

field - the field associated with the property (may be null)

Returns:

the property name

createTypeInfo

@NotNull
protected @NotNull TypeInformation createTypeInfo(@NotNull
                                                           @NotNull PropertyDescriptor descriptor)

getWritableProperties

@NotNull
protected @NotNull List<PropertyDescriptor> getWritableProperties(@NotNull
                                                                           @NotNull 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

@NotNull
protected @NotNull List<PropertyDescriptor> sortPropertiesList(@NotNull
                                                                        @NotNull Class<?> clazz,
                                                                        @NotNull
                                                                        @NotNull 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

@NotNull
protected @NotNull Map<String,Integer> createFieldNameOrderMap(@NotNull
                                                                        @NotNull 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

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

Returns a list of the class's 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 with all of the class's parents, sorted by highest class in the hierarchy to lowest