DataProviderStrategy (podam 4.7.0.RELEASE API)

All Known Implementing Classes:

AbstractRandomDataProviderStrategy, RandomDataProviderStrategy
```
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

Method Summary

Methods
Modifier and Type	Method and Description
`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).
`Set<Class<? extends Annotation>>`	`getExcludedAnnotations()` Identifies `Annotation`s for fields to be skipped.
`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
`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.
`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.
`void`	`sort(Constructor<?>[] constructors)` Rearranges POJO's constructors in order they will be tried to produce the POJO.
`void`	`sort(Method[] methods)` Rearranges POJO's methods in order they will be tried to produce the POJO.

- Method Detail
  - getBoolean
```
Boolean getBoolean(AttributeMetadata attributeMetadata)
```
    It returns a boolean/Boolean value.
  - getByte
```
Byte getByte(AttributeMetadata attributeMetadata)
```
    It returns a byte/Byte 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
    
    Returns:
    A byte/Byte within min and max value (included).
  - getCharacter
```
Character getCharacter(AttributeMetadata attributeMetadata)
```
    It 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
    
    Returns:
    A char/Character value between min and max value (included).
  - getDouble
```
Double getDouble(AttributeMetadata attributeMetadata)
```
    It 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
    
    Returns:
    A double/Double value between min and max value (included)
  - getFloat
```
Float getFloat(AttributeMetadata attributeMetadata)
```
    It 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
    
    Returns:
    A float/Float value between min and max value (included).
  - getInteger
```
Integer getInteger(AttributeMetadata attributeMetadata)
```
    It returns an 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
    
    Returns:
    An int/Integer value between min and max value (included).
  - getLong
```
Long getLong(AttributeMetadata attributeMetadata)
```
    It 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
    
    Returns:
    A long/Long value between min and max value (included).
  - getShort
```
Short getShort(AttributeMetadata attributeMetadata)
```
    It 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
    
    Returns:
    A short/Short value between min and max value (included).
  - getStringValue
```
String getStringValue(AttributeMetadata attributeMetadata)
```
    It returns a string value
  - 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
    
    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
  - 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.
  - sort
```
void sort(Constructor<?>[] constructors)
```
    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
  - sort
```
void sort(Method[] methods)
```
    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
  - 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.
    
    Parameters:
    nonInstantiatableClass - Abstract class type or interface
    
    Returns:
    Non-abstract class type derived from nonInstantiatableClass.
  - getExcludedAnnotations
```
Set<Class<? extends Annotation>> getExcludedAnnotations()
```
    Identifies Annotations for fields to be skipped.
    Should return set of annotations, which will be treated as notion for PodamFactory to skip production of these particular fields.
    
    Returns:
    set of annotations, which mark fields to be skipped from populating.

Interface DataProviderStrategy

Method Summary

Method Detail

getBoolean

getByte

getByteInRange

getCharacter

getCharacterInRange

getDouble

getDoubleInRange

getFloat

getFloatInRange

getInteger

getIntegerInRange

getLong

getLongInRange

getShort

getShortInRange

getStringValue

getStringOfLength

getNumberOfCollectionElements

getMaxDepth

isMemoizationEnabled

sort

sort

getSpecificClass

getExcludedAnnotations