uk.co.jemos.podam.api

Interface DataProviderStrategy

All Known Subinterfaces:

RandomDataProviderStrategy

All Known Implementing Classes:

AbstractRandomDataProviderStrategy, RandomDataProviderStrategyImpl

public interface DataProviderStrategy

This interface defines the contact for PODAM data providers.

PODAM is a tool to fill POJOs with data. There are different requirements when it comes to which data POJOs should be filled with. The default strategy adopted by PODAM is to fill POJOs with random data. However other requirements might dictate to assign deterministic data using sequences, or other predictable sources of data. In order to do so, clients of PODAM will have to provide an implementation of this interface and pass it to the constructor of the PodamFactoryImpl class.

Since:

1.0.0

Author:

mtedone

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataProviderStrategy.Order Specifies how to sort constructors

Method Summary

Modifier and Type	Method and Description
<T> DataProviderStrategy	addOrReplaceSpecific(Class<T> abstractClass, Class<? extends T> specificClass) Bind an interface/abstract class to a specific implementation.
void	cacheMemoizedObject(AttributeMetadata attributeMetadata, Object instance) Saves object in memoization cache
void	clearMemoizationCache() Clears memoization cache
Boolean	getBoolean(AttributeMetadata attributeMetadata) It returns a boolean/Boolean value.
Byte	getByte(AttributeMetadata attributeMetadata) It returns a byte/Byte value.
Byte	getByteInRange(byte minValue, byte maxValue, AttributeMetadata attributeMetadata) It returns a byte/Byte within min and max value (included).
Character	getCharacter(AttributeMetadata attributeMetadata) It returns a char/Character value.
Character	getCharacterInRange(char minValue, char maxValue, AttributeMetadata attributeMetadata) It returns a char/Character value between min and max value (included).
Double	getDouble(AttributeMetadata attributeMetadata) It returns a double/Double value
Double	getDoubleInRange(double minValue, double maxValue, AttributeMetadata attributeMetadata) It returns a double/Double value between min and max value (included).
Float	getFloat(AttributeMetadata attributeMetadata) It returns a float/Float value.
Float	getFloatInRange(float minValue, float maxValue, AttributeMetadata attributeMetadata) It returns a float/Float value between min and max value (included).
Integer	getInteger(AttributeMetadata attributeMetadata) It returns an int/Integer value.
int	getIntegerInRange(int minValue, int maxValue, AttributeMetadata attributeMetadata) It returns an int/Integer value between min and max value (included).
Long	getLong(AttributeMetadata attributeMetadata) It returns a long/Long value.
Long	getLongInRange(long minValue, long maxValue, AttributeMetadata attributeMetadata) It returns a long/Long value between min and max value (included).
int	getMaxDepth(Class<?> type) Returns how many times it is allowed to PODAM to create an instance of the same class in a recursive hierarchy
Object	getMemoizedObject(AttributeMetadata attributeMetadata) Obtains object from memoization cache
int	getNumberOfCollectionElements(Class<?> type) Returns the number of default collection elements.
Short	getShort(AttributeMetadata attributeMetadata) It returns a short/Short value.
Short	getShortInRange(short minValue, short maxValue, AttributeMetadata attributeMetadata) It returns a short/Short value between min and max value (included).
<T> Class<? extends T>	getSpecificClass(Class<T> nonInstantiatableClass) Resolves abstract classes and interfaces.
Class<AttributeStrategy<?>>	getStrategyForAnnotation(Class<? extends Annotation> annotationClass) Finds attribute strategies for annotations.
String	getStringOfLength(int length, AttributeMetadata attributeMetadata) It returns a String of length characters.
String	getStringValue(AttributeMetadata attributeMetadata) It returns a string value
boolean	isMemoizationEnabled() Returns whether the memoization setting is enabled.
<T> DataProviderStrategy	removeSpecific(Class<T> abstractClass) Remove binding of an interface/abstract class to a specific implementation
void	setDefaultNumberOfCollectionElements(int newNumberOfCollectionElements) Sets the new default number of default collection elements.
void	setMemoization(boolean isMemoizationEnabled) Sets whether memoization is enabled
void	sort(Constructor<?>[] constructors, DataProviderStrategy.Order order) Rearranges POJO's constructors in order they will be tried to produce the POJO.
void	sort(Method[] methods, DataProviderStrategy.Order order) Rearranges POJO's methods in order they will be tried to produce the POJO.

Method Detail

addOrReplaceSpecific

<T> DataProviderStrategy addOrReplaceSpecific(Class<T> abstractClass,
                                              Class<? extends T> specificClass)

Bind an interface/abstract class to a specific implementation. If the strategy previously contained a binding for the interface/abstract class, the old value will be replaced by the new value. If you want to implement more sophisticated binding strategy, override this class.

Type Parameters:

T - return type

Parameters:

abstractClass - the interface/abstract class to bind

specificClass - the specific class implementing or extending abstractClass.

Returns:

itself

removeSpecific

<T> DataProviderStrategy removeSpecific(Class<T> abstractClass)

Remove binding of an interface/abstract class to a specific implementation

Type Parameters:

T - return type

Parameters:

abstractClass - the interface/abstract class to remove binding

Returns:

itself

getBoolean

Boolean getBoolean(AttributeMetadata attributeMetadata)

It returns a boolean/Boolean value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

a boolean/Boolean value

getByte

Byte getByte(AttributeMetadata attributeMetadata)

It returns a byte/Byte value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

a boolean/Boolean value

getByteInRange

Byte getByteInRange(byte minValue,
                    byte maxValue,
                    AttributeMetadata attributeMetadata)

It returns a byte/Byte within min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A byte/Byte within min and max value (included).

getCharacter

Character getCharacter(AttributeMetadata attributeMetadata)

It returns a char/Character value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

a char/Character value

getCharacterInRange

Character getCharacterInRange(char minValue,
                              char maxValue,
                              AttributeMetadata attributeMetadata)

It returns a char/Character value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A char/Character value between min and max value (included).

getDouble

Double getDouble(AttributeMetadata attributeMetadata)

It returns a double/Double value

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

a double/Double value

getDoubleInRange

Double getDoubleInRange(double minValue,
                        double maxValue,
                        AttributeMetadata attributeMetadata)

It returns a double/Double value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A double/Double value between min and max value (included)

getFloat

Float getFloat(AttributeMetadata attributeMetadata)

It returns a float/Float value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A float/Float value

getFloatInRange

Float getFloatInRange(float minValue,
                      float maxValue,
                      AttributeMetadata attributeMetadata)

It returns a float/Float value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A float/Float value between min and max value (included).

getInteger

Integer getInteger(AttributeMetadata attributeMetadata)

It returns an int/Integer value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A int/Integer value

getIntegerInRange

int getIntegerInRange(int minValue,
                      int maxValue,
                      AttributeMetadata attributeMetadata)

It returns an int/Integer value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

An int/Integer value between min and max value (included).

getLong

Long getLong(AttributeMetadata attributeMetadata)

It returns a long/Long value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A long/Long value

getLongInRange

Long getLongInRange(long minValue,
                    long maxValue,
                    AttributeMetadata attributeMetadata)

It returns a long/Long value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A long/Long value between min and max value (included).

getShort

Short getShort(AttributeMetadata attributeMetadata)

It returns a short/Short value.

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A short/Short value.

getShortInRange

Short getShortInRange(short minValue,
                      short maxValue,
                      AttributeMetadata attributeMetadata)

It returns a short/Short value between min and max value (included).

Parameters:

minValue - The minimum value for the returned value

maxValue - The maximum value for the returned value

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A short/Short value between min and max value (included).

getStringValue

String getStringValue(AttributeMetadata attributeMetadata)

It returns a string value

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A String of default length

getStringOfLength

String getStringOfLength(int length,
                         AttributeMetadata attributeMetadata)

It returns a String of length characters.

Parameters:

length - The number of characters required in the returned String

attributeMetadata - attribute metadata for instance to be fetched

Returns:

A String of length characters

getNumberOfCollectionElements

int getNumberOfCollectionElements(Class<?> type)

Returns the number of default collection elements.

Implementations of this interface need to provide this value.

Parameters:

type - Type of collection's elements

Returns:

The number of default collection elements

setDefaultNumberOfCollectionElements

void setDefaultNumberOfCollectionElements(int newNumberOfCollectionElements)

Sets the new default number of default collection elements.

Parameters:

newNumberOfCollectionElements - The new number of collection elements.

getMaxDepth

int getMaxDepth(Class<?> type)

Returns how many times it is allowed to PODAM to create an instance of the same class in a recursive hierarchy

Implementations of this interface need to provide this value.

Parameters:

type - Type of POJO to be created

Returns:

How many times it is allowed to create an instance of the same class in a recursive hierarchy

isMemoizationEnabled

boolean isMemoizationEnabled()

Returns whether the memoization setting is enabled. When memoization is enabled, only one object will be created for each type. Every next property of the same type will be a reference to the same object. This can dramatically improve performance but with the expense of not having objects with different values.

Implementations of this interface need to provide this value.

Returns:

Whether the memoization setting is enabled.

setMemoization

void setMemoization(boolean isMemoizationEnabled)

Sets whether memoization is enabled

Parameters:

isMemoizationEnabled - whether memoization is enabled

getMemoizedObject

Object getMemoizedObject(AttributeMetadata attributeMetadata)

Obtains object from memoization cache

Parameters:

attributeMetadata - attribute metadata for instance to be fetched

Returns:

object instance from memoization cache

cacheMemoizedObject

void cacheMemoizedObject(AttributeMetadata attributeMetadata,
                         Object instance)

Saves object in memoization cache

Parameters:

attributeMetadata - attribute metadata for instance being memoized

instance - object instance to save in memoization cache

clearMemoizationCache

void clearMemoizationCache()

Clears memoization cache

sort

void sort(Constructor<?>[] constructors,
          DataProviderStrategy.Order order)

Rearranges POJO's constructors in order they will be tried to produce the POJO. Default strategy consists of putting constructors with less parameters to be tried first.

Parameters:

constructors - Array of POJO's constructors

order - DataProviderStrategy.Order how to sort constructors

sort

void sort(Method[] methods,
          DataProviderStrategy.Order order)

Rearranges POJO's methods in order they will be tried to produce the POJO. Default strategy consists of putting factory methods with more parameters to be tried first.

Parameters:

methods - Array of POJO's methods

order - DataProviderStrategy.Order how to sort constructors

getSpecificClass

<T> Class<? extends T> getSpecificClass(Class<T> nonInstantiatableClass)

Resolves abstract classes and interfaces.

Should return specific class type, which can be instantiated and assigned to abstract class type or interface.

Type Parameters:

T - The type of class being resolved

Parameters:

nonInstantiatableClass - Abstract class type or interface

Returns:

Non-abstract class type derived from nonInstantiatableClass.

getStrategyForAnnotation

Class<AttributeStrategy<?>> getStrategyForAnnotation(Class<? extends Annotation> annotationClass)

Finds attribute strategies for annotations.

Searches for mapping between annotations and attribute strategies, which will be used then for populating fields or constructor parameters.

Parameters:

annotationClass - Annotation class to inspect

Returns:

attribute strategy associated with given annotation