uk.co.jemos.podam.typeManufacturers

Class TypeManufacturerUtil

java.lang.Object

uk.co.jemos.podam.typeManufacturers.TypeManufacturerUtil

public final class TypeManufacturerUtil
extends Object

Type Manufacturer utility class. Created by tedonema on 01/07/2015.

Since:

6.0.0.RELEASE

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG The application logger

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TypeManufacturerUtil() Non instantiable.

Method Summary

Modifier and Type	Method and Description
static Type[]	fillTypeArgMap(Map<String,Type> typeArgsMap, Class<?> pojoClass, Type[] genericTypeArgs) Fills type agruments map
static AttributeStrategy<?>	findAttributeStrategy(DataProviderStrategy strategy, List<Annotation> annotations, Class<?> attributeType) It returns a AttributeStrategy if one was specified in annotations, or null otherwise.
static Integer	findCollectionSize(DataProviderStrategy strategy, List<Annotation> annotations, Class<?> collectionElementType, Holder<AttributeStrategy<?>> elementStrategyHolder, Holder<AttributeStrategy<?>> keyStrategyHolder) Searches for annotation with information about collection/map size and filling strategies
static Object	getTypeValue(DataProviderStrategy strategy, org.springframework.messaging.MessageChannel channel, AttributeMetadata attributeMetadata, String qualifier) Obtains a type value
static Object	getTypeValueForGenericTypes(DataProviderStrategy strategy, org.springframework.messaging.MessageChannel channel, AttributeMetadata attributeMetadata, Type genericAttributeType, Map<String,Type> genericTypesArgumentsMap, String qualifier) Obtains a type value
static boolean	isWrapper(Class<?> candidateWrapperClass) It returns true if this class is a wrapper class, false otherwise
static Type[]	mergeActualAndSuppliedGenericTypes(Type[] actualTypes, Type[] suppliedTypes, Map<String,Type> typeArgsMap) Utility to merge actual types with supplied array of generic type substitutions
static Type[]	mergeTypeArrays(Type[] original, Type[] extra) Utility method to merge two arrays
static Collection<? super Object>	resolveCollectionType(Class<?> collectionType, Collection<? super Object> defaultValue) Given a collection type it returns an instance The default type for a List is an ArrayList The default type for a Queue is a LinkedList The default type for a Set is a HashSet
static Class<?>	resolveGenericParameter(Type paramType, Map<String,Type> typeArgsMap, AtomicReference<Type[]> methodGenericTypeArgs) It resolves generic parameter type
static Map<? super Object,? super Object>	resolveMapType(Class<?> mapType, Map<? super Object,? super Object> defaultValue) It manufactures and returns a default instance for each map type
static Object	returnAttributeDataStrategyValue(Class<?> attributeType, AttributeStrategy<?> attributeStrategy) It retrieves the value for the PodamStrategyValue annotation with which the attribute was annotated

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The application logger

Constructor Detail

TypeManufacturerUtil

private TypeManufacturerUtil()

Non instantiable.

Method Detail

getTypeValue

public static Object getTypeValue(DataProviderStrategy strategy,
                                  org.springframework.messaging.MessageChannel channel,
                                  AttributeMetadata attributeMetadata,
                                  String qualifier)

Obtains a type value

Parameters:

strategy - The Data Provider strategy

channel - The Message Channel where to send/receive the message for the required value

attributeMetadata - The AttributeMetadata information

qualifier - The class of the requested type

Returns:

The type value

getTypeValueForGenericTypes

public static Object getTypeValueForGenericTypes(DataProviderStrategy strategy,
                                                 org.springframework.messaging.MessageChannel channel,
                                                 AttributeMetadata attributeMetadata,
                                                 Type genericAttributeType,
                                                 Map<String,Type> genericTypesArgumentsMap,
                                                 String qualifier)

Obtains a type value

Parameters:

strategy - The Data Provider strategy

channel - The Message Channel where to send/receive the message for the required value

attributeMetadata - The AttributeMetadata information

genericAttributeType - The generic attribute type

qualifier - The class of the requested type @return The type value

findAttributeStrategy

public static AttributeStrategy<?> findAttributeStrategy(DataProviderStrategy strategy,
                                                         List<Annotation> annotations,
                                                         Class<?> attributeType)
                                                  throws InstantiationException,
                                                         IllegalAccessException

It returns a AttributeStrategy if one was specified in annotations, or null otherwise.

Parameters:

annotations - The list of annotations

attributeType - Type of attribute expected to be returned

Returns:

AttributeStrategy, if PodamStrategyValue or bean validation constraint annotation was found among annotations

Throws:

IllegalAccessException - if attribute strategy cannot be instantiated

InstantiationException - if attribute strategy cannot be instantiated

fillTypeArgMap

public static Type[] fillTypeArgMap(Map<String,Type> typeArgsMap,
                                    Class<?> pojoClass,
                                    Type[] genericTypeArgs)

Fills type agruments map

This method places required and provided types for object creation into a map, which will be used for type mapping.

Parameters:

typeArgsMap - a map to fill

pojoClass - Typed class

genericTypeArgs - Type arguments provided for a generics object by caller

Returns:

Array of unused provided generic type arguments

Throws:

IllegalStateException - If number of typed parameters doesn't match number of provided generic types

findCollectionSize

public static Integer findCollectionSize(DataProviderStrategy strategy,
                                         List<Annotation> annotations,
                                         Class<?> collectionElementType,
                                         Holder<AttributeStrategy<?>> elementStrategyHolder,
                                         Holder<AttributeStrategy<?>> keyStrategyHolder)
                                  throws InstantiationException,
                                         IllegalAccessException

Searches for annotation with information about collection/map size and filling strategies

Parameters:

annotations - a list of annotations to inspect

collectionElementType - a collection element type

elementStrategyHolder - a holder to pass found element strategy back to the caller, can be null

keyStrategyHolder - a holder to pass found key strategy back to the caller, can be null

Returns:

A number of element in collection or null, if no annotation was found

Throws:

InstantiationException - A strategy cannot be instantiated

IllegalAccessException - A strategy cannot be instantiated

isWrapper

public static boolean isWrapper(Class<?> candidateWrapperClass)

It returns true if this class is a wrapper class, false otherwise

Parameters:

candidateWrapperClass - The class to check

Returns:

true if this class is a wrapper class, false otherwise

mergeActualAndSuppliedGenericTypes

public static Type[] mergeActualAndSuppliedGenericTypes(Type[] actualTypes,
                                                        Type[] suppliedTypes,
                                                        Map<String,Type> typeArgsMap)

Utility to merge actual types with supplied array of generic type substitutions

Parameters:

actualTypes - an array of types used for field or POJO declaration

suppliedTypes - an array of supplied types for generic type substitution

typeArgsMap - a map relating the generic class arguments ("<T, V>" for example) with their actual types

Returns:

An array of merged actual and supplied types with generic types resolved

mergeTypeArrays

public static Type[] mergeTypeArrays(Type[] original,
                                     Type[] extra)

Utility method to merge two arrays

Parameters:

original - The main array

extra - The additional array, optionally may be null

Returns:

A merged array of original and extra arrays

resolveCollectionType

public static Collection<? super Object> resolveCollectionType(Class<?> collectionType,
                                                               Collection<? super Object> defaultValue)

Given a collection type it returns an instance

• The default type for a List is an ArrayList
• The default type for a Queue is a LinkedList
• The default type for a Set is a HashSet

Parameters:

collectionType - The collection type *

defaultValue - Default value for the collection, can be null

Returns:

an instance of the collection type or null

resolveGenericParameter

public static Class<?> resolveGenericParameter(Type paramType,
                                               Map<String,Type> typeArgsMap,
                                               AtomicReference<Type[]> methodGenericTypeArgs)

It resolves generic parameter type

Parameters:

paramType - The generic parameter type

typeArgsMap - A map of resolved types

methodGenericTypeArgs - Return value posible generic types of the generic parameter type

Returns:

value for class representing the generic parameter type

resolveMapType

public static Map<? super Object,? super Object> resolveMapType(Class<?> mapType,
                                                                Map<? super Object,? super Object> defaultValue)

It manufactures and returns a default instance for each map type

The default implementation for a ConcurrentMap is ConcurrentHashMap

The default implementation for a SortedMap is a TreeMap

The default Map is none of the above was recognised is a HashMap

Parameters:

mapType - The attribute type implementing Map

defaultValue - Default value for map

Returns:

A default instance for each map type or null

returnAttributeDataStrategyValue

public static Object returnAttributeDataStrategyValue(Class<?> attributeType,
                                                      AttributeStrategy<?> attributeStrategy)
                                               throws IllegalArgumentException

It retrieves the value for the PodamStrategyValue annotation with which the attribute was annotated

Parameters:

attributeType - The attribute type, used for type checking

attributeStrategy - The AttributeStrategy to use

Returns:

The value for the PodamStrategyValue annotation with which the attribute was annotated

Throws:

IllegalArgumentException - If the type of the data strategy defined for the PodamStrategyValue annotation is not assignable to the annotated attribute. This de facto guarantees type safety.