Package de.cuioss.test.valueobjects.util

Class ReflectionHelper

java.lang.Object

de.cuioss.test.valueobjects.util.ReflectionHelper

public final class ReflectionHelper
extends Object

Author:

Oliver Wolff

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	PROPERTY_IGNORE_SET	Identifies the properties to be ignored.

Constructor Summary

Constructors

Constructor	Description
ReflectionHelper()

Method Summary

Modifier and Type	Method	Description
static PropertyMetadata	createPropertyMetadata(Class<?> beanType, de.cuioss.tools.property.PropertyHolder propertyHolder)	Creates a PropertyMetadata for a given field.
static <T> Class<T>	determineSupertypeFromIterable(Iterable<T> iterable)	Helper method that determines the actual type of a given Iterable by peeking into it.
static SortedSet<PropertyMetadata>	handlePostProcess(Class<?> annotated, SortedSet<PropertyMetadata> metatdata)	Filters the given properties according to the annotated element given.
static SortedSet<PropertyMetadata>	handlePostProcessConfig(PropertyReflectionConfig config, SortedSet<PropertyMetadata> metatdata)	Filters the given properties according to the annotated element given.
static <T> List<PropertyMetadata>	handlePropertyMetadata(PropertyReflectionConfig propertyReflectionConfig, List<PropertyConfig> propertyConfig, Class<T> targetClass)	One stop method for the deriving of configured metadata
static <T> List<PropertyMetadata>	handlePropertyMetadata(Class<?> annotated, Class<T> targetClass)	One stop method for the deriving of configured metadata
static SortedSet<PropertyMetadata>	scanBeanTypeForProperties(Class<?> beanType, PropertyReflectionConfig config)	Uses MoreReflection to scan the concrete bean and describe the properties with fitting PropertyMetadata.
static boolean	shouldScanClass(PropertyReflectionConfig config)	Checks the given type for the annotation PropertyReflectionConfig if it is there it checks on the value PropertyReflectionConfig.skip()
static boolean	shouldScanClass(Class<?> annotated)	Checks the given type for the annotation PropertyReflectionConfig if it is there it checks on the value PropertyReflectionConfig.skip()

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_IGNORE_SET

public static final Set<String> PROPERTY_IGNORE_SET

Identifies the properties to be ignored. Currently only consisting of 'class'

Constructor Details

ReflectionHelper

public ReflectionHelper()

Method Details

handlePropertyMetadata

public static <T> List<PropertyMetadata> handlePropertyMetadata(Class<?> annotated,
 Class<T> targetClass)

One stop method for the deriving of configured metadata

Parameters:

annotated - must not be null

targetClass - must not be null

Returns:

an immutable List of PropertyMetadata containing the result of the actual scanning with scanBeanTypeForProperties(Class, PropertyReflectionConfig) and handlePostProcess(Class, SortedSet) and PropertyHelper.handlePropertyConfigAnnotations(Class) and PropertyHelper.handlePrimitiveAsDefaults(Collection)

handlePropertyMetadata

public static <T> List<PropertyMetadata> handlePropertyMetadata(PropertyReflectionConfig propertyReflectionConfig,
 List<PropertyConfig> propertyConfig,
 Class<T> targetClass)

One stop method for the deriving of configured metadata

Parameters:

propertyReflectionConfig - extracted from the target class, may be null.

propertyConfig - extracted from the target class, may be empty

targetClass - must not be null

Returns:

an immutable List of PropertyMetadata containing the result of the actual scanning with scanBeanTypeForProperties(Class, PropertyReflectionConfig) and handlePostProcess(Class, SortedSet) and PropertyHelper.handlePropertyConfigAnnotations(Class) and PropertyHelper.handlePrimitiveAsDefaults(Collection)

scanBeanTypeForProperties

public static SortedSet<PropertyMetadata> scanBeanTypeForProperties(Class<?> beanType,
 PropertyReflectionConfig config)

Uses MoreReflection to scan the concrete bean and describe the properties with fitting PropertyMetadata. Each property will contain the derived data for the attributes:

• PropertyMetadata.getName()
• PropertyMetadata.getGenerator() with the generator being dynamically resolved using GeneratorResolver.resolveGenerator(Class)
• PropertyMetadata.getPropertyReadWrite()
• PropertyMetadata.getCollectionType()
• PropertyMetadata.getPropertyMemberInfo()

Other attributes use there defaults:

• PropertyMetadata.isRequired() defaults to false
• PropertyMetadata.isDefaultValue() defaults to false

Parameters:

beanType - to be checked by reflection

config - optional instance of PropertyReflectionConfig used for filtering the scanning

Returns:

a SortedSet containing the result of the inspection

createPropertyMetadata

public static PropertyMetadata createPropertyMetadata(Class<?> beanType,
 de.cuioss.tools.property.PropertyHolder propertyHolder)

Creates a PropertyMetadata for a given field.

Parameters:

beanType - providing the property, must not be null

propertyHolder - identifying the property-metadata, must not be null

Returns:

an instance of PropertyMetadata describing the field.

Throws:

IllegalArgumentException - wrapping underlying reflection exceptions.

handlePostProcess

public static SortedSet<PropertyMetadata> handlePostProcess(Class<?> annotated,
 SortedSet<PropertyMetadata> metatdata)

Filters the given properties according to the annotated element given. It checks for the annotation PropertyReflectionConfig and filters the given SortedSet

Parameters:

annotated - must not be null

metatdata - must not be null

Returns:

the filtered SortedSet

handlePostProcessConfig

public static SortedSet<PropertyMetadata> handlePostProcessConfig(PropertyReflectionConfig config,
 SortedSet<PropertyMetadata> metatdata)

Filters the given properties according to the annotated element given. It checks for the annotation PropertyReflectionConfig and filters the given SortedSet

Parameters:

config - must not be null

metatdata - must not be null

Returns:

the filtered SortedSet

shouldScanClass

public static boolean shouldScanClass(Class<?> annotated)

Checks the given type for the annotation PropertyReflectionConfig if it is there it checks on the value PropertyReflectionConfig.skip()

Parameters:

annotated - the class that may or may not provide the annotations, must not be null

Returns:

boolean indicating whether to skip property scanning.

shouldScanClass

public static boolean shouldScanClass(PropertyReflectionConfig config)

Checks the given type for the annotation PropertyReflectionConfig if it is there it checks on the value PropertyReflectionConfig.skip()

Parameters:

config - the optional annotation, may be null

Returns:

boolean indicating whether to skip property scanning.

determineSupertypeFromIterable

public static <T> Class<T> determineSupertypeFromIterable(Iterable<T> iterable)

Helper method that determines the actual type of a given Iterable by peeking into it. For testing only, should never be used in productive code

Parameters:

iterable - must not be null nor empty, the iterator must be reentrant.

Returns:

The Class of the given Iterable.