Package de.cuioss.test.valueobjects.util

Class AnnotationHelper

java.lang.Object

de.cuioss.test.valueobjects.util.AnnotationHelper

public final class AnnotationHelper
extends Object

Simple helper class dealing with annotation on the test-base classes.

Author:

Oliver Wolff

Constructor Summary

Constructors

Constructor	Description
AnnotationHelper()

Method Summary

Modifier and Type	Method	Description
static List<PropertyMetadata>	constructorConfigToPropertyMetadata(VerifyConstructor config, Collection<PropertyMetadata> givenMetadata)	Creates a List of PropertyMetadata according to the given parameter
static Set<VerifyConstructor>	extractConfiguredConstructorContracts(Class<?> annotated)	Checks the given type for the annotation VerifyConstructor and VerifyConstructors and puts all found in the returned Set
static Set<VerifyFactoryMethod>	extractConfiguredFactoryContracts(Class<?> annotated)	Checks the given type for the annotation VerifyFactoryMethod and VerifyFactoryMethods and puts all found in the returned list
static List<PropertyMetadata>	factoryConfigToPropertyMetadata(VerifyFactoryMethod config, Collection<PropertyMetadata> givenMetadata)	Creates a List of PropertyMetadata according to the given parameter
static List<PropertyMetadata>	handleMetadataForBuilderTest(Class<?> annotated, List<PropertyMetadata> givenMetadata)
static List<PropertyMetadata>	handleMetadataForMapperTest(VerifyMapperConfiguration verifyMapper, List<PropertyMetadata> givenMetadata)
static List<PropertyMetadata>	handleMetadataForPropertyTest(Class<?> annotated, List<PropertyMetadata> givenMetadata)
static Map<String,PropertyMetadata>	modifyPropertyMetadata(Map<String,PropertyMetadata> map, String[] defaultValued, String[] readOnly, String[] required, String[] transientProperties, String[] writeOnly, String[] unorderedCollection)	Checks the individual contracts and changes / modifies the corresponding PropertyMetadata accordingly
static Map<String,PropertyMetadata>	modifyPropertyMetadata(Map<String,PropertyMetadata> map, List<String> defaultValued, List<String> readOnly, List<String> required, List<String> transientProperties, List<String> writeOnly, List<String> unorderedCollection)	Checks the individual contracts and changes / modifies the corresponding PropertyMetadata accordingly

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationHelper

public AnnotationHelper()

Method Details

constructorConfigToPropertyMetadata

public static List<PropertyMetadata> constructorConfigToPropertyMetadata(VerifyConstructor config,
 Collection<PropertyMetadata> givenMetadata)

Creates a List of PropertyMetadata according to the given parameter

Parameters:

config - identifying the concrete configuration

givenMetadata - used fore deriving the concrete metadata. Must not be null

Returns:

a List of PropertyMetadata according to the given parameter

factoryConfigToPropertyMetadata

public static List<PropertyMetadata> factoryConfigToPropertyMetadata(VerifyFactoryMethod config,
 Collection<PropertyMetadata> givenMetadata)

Creates a List of PropertyMetadata according to the given parameter

Parameters:

config - identifying the concrete configuration

givenMetadata - used fore deriving the concrete metadata. Must not be null

Returns:

a List of PropertyMetadata according to the given parameter

extractConfiguredConstructorContracts

public static Set<VerifyConstructor> extractConfiguredConstructorContracts(Class<?> annotated)

Checks the given type for the annotation VerifyConstructor and VerifyConstructors and puts all found in the returned Set

Parameters:

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

Returns:

a Set of VerifyConstructor extracted from the annotations of the given type. May be empty but never null

extractConfiguredFactoryContracts

public static Set<VerifyFactoryMethod> extractConfiguredFactoryContracts(Class<?> annotated)

Checks the given type for the annotation VerifyFactoryMethod and VerifyFactoryMethods and puts all found in the returned list

Parameters:

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

Returns:

a Set of VerifyFactoryMethod extracted from the annotations of the given type. May be empty but never null

handleMetadataForPropertyTest

public static List<PropertyMetadata> handleMetadataForPropertyTest(Class<?> annotated,
 List<PropertyMetadata> givenMetadata)

Parameters:

annotated - must not be null and must be annotated with VerifyBeanProperty

givenMetadata - must not be null

Returns:

a SortedSet providing the property configuration derived by the given properties and the annotated VerifyBeanProperty

handleMetadataForBuilderTest

public static List<PropertyMetadata> handleMetadataForBuilderTest(Class<?> annotated,
 List<PropertyMetadata> givenMetadata)

Parameters:

annotated - must not be null and must be annotated with VerifyBeanProperty

givenMetadata - must not be null

Returns:

a SortedSet providing the property configuration derived by the given properties and the annotated VerifyBuilder

handleMetadataForMapperTest

public static List<PropertyMetadata> handleMetadataForMapperTest(VerifyMapperConfiguration verifyMapper,
 List<PropertyMetadata> givenMetadata)

Parameters:

verifyMapper - must not be null and must be annotated with VerifyMapperConfiguration

givenMetadata - must not be null

Returns:

a SortedSet providing the property configuration derived by the given properties and the annotated VerifyMapperConfiguration

modifyPropertyMetadata

public static Map<String,PropertyMetadata> modifyPropertyMetadata(Map<String,PropertyMetadata> map,
 String[] defaultValued,
 String[] readOnly,
 String[] required,
 String[] transientProperties,
 String[] writeOnly,
 String[] unorderedCollection)

Checks the individual contracts and changes / modifies the corresponding PropertyMetadata accordingly

Parameters:

map - must not be null

defaultValued - must not be null

readOnly - must not be null

required - must not be null

transientProperties - must not be null

writeOnly - must not be null

unorderedCollection - must not be null, see PropertyReflectionConfig.assertUnorderedCollection()

Returns:

the filtered map

modifyPropertyMetadata

public static Map<String,PropertyMetadata> modifyPropertyMetadata(Map<String,PropertyMetadata> map,
 List<String> defaultValued,
 List<String> readOnly,
 List<String> required,
 List<String> transientProperties,
 List<String> writeOnly,
 List<String> unorderedCollection)

Checks the individual contracts and changes / modifies the corresponding PropertyMetadata accordingly

Parameters:

map - must not be null

defaultValued - must not be null

readOnly - must not be null

required - must not be null

transientProperties - must not be null

writeOnly - must not be null

unorderedCollection - must not be null, see PropertyReflectionConfig.assertUnorderedCollection()

Returns:

the filtered map