AbstractRandomDataProviderStrategy (podam 4.7.0.RELEASE API)

java.lang.Object
- uk.co.jemos.podam.api.AbstractRandomDataProviderStrategy

All Implemented Interfaces:

DataProviderStrategy

Direct Known Subclasses:

RandomDataProviderStrategy
```
public abstract class AbstractRandomDataProviderStrategy
extends Object
implements DataProviderStrategy
```
Default abstract implementation of a DataProviderStrategy
This default implementation returns values based on a random generator. Convinient for subclassing and redefining behaviour. Don't use this implementation if you seek deterministic values

All values returned by this implementation are different from zero.

Since:

1.0.0

Author:

mtedone

Field Summary

Fields
Modifier and Type	Field and Description
`private static ConstructorComparator`	`CONSTRUCTOR_COMPARATOR` The constructor comparator
`static int`	`DEFAULT_NBR_COLLECTION_ELEMENTS` The default number of collection elements for this strategy
`private Set<Class<? extends Annotation>>`	`excludedAnnotations` Set of annotations, which mark fields to be skipped from populating.
`private boolean`	`isMemoizationEnabled` Flag to enable/disable the memoization setting.
`static int`	`MAX_DEPTH` How many times it is allowed to PODAM to create an instance of the same class in a recursive hierarchy
`private int`	`maxDepth` The max stack trace depth.
`private static MethodComparator`	`METHOD_COMPARATOR` The constructor comparator
`private int`	`nbrOfCollectionElements` The number of collection elements.
`static char[]`	`NICE_ASCII_CHARACTERS` An array of valid String characters
`private static Random`	`RANDOM` A RANDOM generator
`private Map<Class<?>,Class<?>>`	`specificTypes` A list of user-submitted specific implementations for interfaces and abstract classes

Constructor Summary

Constructors
Constructor and Description

AbstractRandomDataProviderStrategy()
Implementation of the Singleton pattern

AbstractRandomDataProviderStrategy(int nbrOfCollectionElements)

Constructors
Constructor and Description
`AbstractRandomDataProviderStrategy()` Implementation of the Singleton pattern
`AbstractRandomDataProviderStrategy(int nbrOfCollectionElements)`

Method Summary

Methods
Modifier and Type	Method and Description
`AbstractRandomDataProviderStrategy`	`addExcludedAnnotation(Class<? extends Annotation> annotation)` Adds the specified `Annotation` to set of excluded annotations, if it is not already present.
`<T> AbstractRandomDataProviderStrategy`	`addSpecific(Class<T> abstractClass, Class<? extends T> specificClass)` Bind an interface/abstract class to a specific implementation
`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)` This implementation returns the current time in milliseconds.
`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.
`AbstractRandomDataProviderStrategy`	`removeExcludedAnnotation(Class<? extends Annotation> annotation)` Adds the specified `Annotation` from set of excluded annotations.
`<T> AbstractRandomDataProviderStrategy`	`removeSpecific(Class<T> abstractClass)` Remove binding of an interface/abstract class to a specific implementation
`void`	`setMaxDepth(int newMaxDepth)` Sets the new max stack trace depth.
`void`	`setMemoizationEnabled(boolean value)` When memoization is enabled, only one object will be created for each type.
`void`	`setNumberOfCollectionElements(int newNumberOfCollectionElements)` Sets the new number of default collection elements.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RANDOM
```
private static final Random RANDOM
```
    A RANDOM generator
  - CONSTRUCTOR_COMPARATOR
```
private static final ConstructorComparator CONSTRUCTOR_COMPARATOR
```
    The constructor comparator
  - METHOD_COMPARATOR
```
private static final MethodComparator METHOD_COMPARATOR
```
    The constructor comparator
  - NICE_ASCII_CHARACTERS
```
public static final char[] NICE_ASCII_CHARACTERS
```
    An array of valid String characters
  - MAX_DEPTH
```
public static final int MAX_DEPTH
```
    How many times it is allowed to PODAM to create an instance of the same class in a recursive hierarchy
    
    See Also:
    Constant Field Values
  - DEFAULT_NBR_COLLECTION_ELEMENTS
```
public static final int DEFAULT_NBR_COLLECTION_ELEMENTS
```
    The default number of collection elements for this strategy
    
    See Also:
    Constant Field Values
  - maxDepth
```
private int maxDepth
```
    The max stack trace depth.
  - nbrOfCollectionElements
```
private int nbrOfCollectionElements
```
    The number of collection elements.
  - isMemoizationEnabled
```
private boolean isMemoizationEnabled
```
    Flag to enable/disable the memoization setting.
  - specificTypes
```
private final Map<Class<?>,Class<?>> specificTypes
```
    A list of user-submitted specific implementations for interfaces and abstract classes
  - excludedAnnotations
```
private final Set<Class<? extends Annotation>> excludedAnnotations
```
    Set of annotations, which mark fields to be skipped from populating.
- Constructor Detail
  - AbstractRandomDataProviderStrategy
```
public AbstractRandomDataProviderStrategy()
```
    Implementation of the Singleton pattern
  - AbstractRandomDataProviderStrategy
```
public AbstractRandomDataProviderStrategy(int nbrOfCollectionElements)
```
- Method Detail
  - getBoolean
```
public Boolean getBoolean(AttributeMetadata attributeMetadata)
```
    It returns a boolean/Boolean value.
    
    Specified by:
    
    getBoolean in interface DataProviderStrategy
  - getByte
```
public Byte getByte(AttributeMetadata attributeMetadata)
```
    It returns a byte/Byte value.
    
    Specified by:
    
    getByte in interface DataProviderStrategy
  - getByteInRange
```
public Byte getByteInRange(byte minValue,
                  byte maxValue,
                  AttributeMetadata attributeMetadata)
```
    It returns a byte/Byte within min and max value (included).
    
    Specified by:
    
    getByteInRange in interface DataProviderStrategy
    
    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
```
public Character getCharacter(AttributeMetadata attributeMetadata)
```
    It returns a char/Character value.
    
    Specified by:
    
    getCharacter in interface DataProviderStrategy
  - getCharacterInRange
```
public Character getCharacterInRange(char minValue,
                            char maxValue,
                            AttributeMetadata attributeMetadata)
```
    It returns a char/Character value between min and max value (included).
    
    Specified by:
    
    getCharacterInRange in interface DataProviderStrategy
    
    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
```
public Double getDouble(AttributeMetadata attributeMetadata)
```
    It returns a double/Double value
    
    Specified by:
    
    getDouble in interface DataProviderStrategy
  - getDoubleInRange
```
public Double getDoubleInRange(double minValue,
                      double maxValue,
                      AttributeMetadata attributeMetadata)
```
    It returns a double/Double value between min and max value (included).
    
    Specified by:
    
    getDoubleInRange in interface DataProviderStrategy
    
    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
```
public Float getFloat(AttributeMetadata attributeMetadata)
```
    It returns a float/Float value.
    
    Specified by:
    
    getFloat in interface DataProviderStrategy
  - getFloatInRange
```
public Float getFloatInRange(float minValue,
                    float maxValue,
                    AttributeMetadata attributeMetadata)
```
    It returns a float/Float value between min and max value (included).
    
    Specified by:
    
    getFloatInRange in interface DataProviderStrategy
    
    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
```
public Integer getInteger(AttributeMetadata attributeMetadata)
```
    It returns an int/Integer value.
    
    Specified by:
    
    getInteger in interface DataProviderStrategy
  - getIntegerInRange
```
public int getIntegerInRange(int minValue,
                    int maxValue,
                    AttributeMetadata attributeMetadata)
```
    It returns an int/Integer value between min and max value (included).
    
    Specified by:
    
    getIntegerInRange in interface DataProviderStrategy
    
    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
```
public Long getLong(AttributeMetadata attributeMetadata)
```
    This implementation returns the current time in milliseconds.
    This can be useful for Date-like constructors which accept a long as argument. A complete random number would cause the instantiation of such classes to fail on a non-deterministic basis, e.g. when the random long would not be an acceptable value for, say, a YEAR field.
    It returns a long/Long value.
    
    Specified by:
    
    getLong in interface DataProviderStrategy
  - getLongInRange
```
public Long getLongInRange(long minValue,
                  long maxValue,
                  AttributeMetadata attributeMetadata)
```
    It returns a long/Long value between min and max value (included).
    
    Specified by:
    
    getLongInRange in interface DataProviderStrategy
    
    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
```
public Short getShort(AttributeMetadata attributeMetadata)
```
    It returns a short/Short value.
    
    Specified by:
    
    getShort in interface DataProviderStrategy
  - getShortInRange
```
public Short getShortInRange(short minValue,
                    short maxValue,
                    AttributeMetadata attributeMetadata)
```
    It returns a short/Short value between min and max value (included).
    
    Specified by:
    
    getShortInRange in interface DataProviderStrategy
    
    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
```
public String getStringValue(AttributeMetadata attributeMetadata)
```
    It returns a string value
    
    Specified by:
    
    getStringValue in interface DataProviderStrategy
  - getStringOfLength
```
public String getStringOfLength(int length,
                       AttributeMetadata attributeMetadata)
```
    It returns a String of length characters.
    
    Specified by:
    
    getStringOfLength in interface DataProviderStrategy
    
    Parameters:
    length - The number of characters required in the returned String
    
    Returns:
    A String of length characters
  - getNumberOfCollectionElements
```
public int getNumberOfCollectionElements(Class<?> type)
```
    Returns the number of default collection elements.
    Implementations of this interface need to provide this value.
    
    Specified by:
    
    getNumberOfCollectionElements in interface DataProviderStrategy
    
    Parameters:
    type - Type of collection's elements
    
    Returns:
    The number of default collection elements
  - setNumberOfCollectionElements
```
public void setNumberOfCollectionElements(int newNumberOfCollectionElements)
```
    Sets the new number of default collection elements.
    
    Parameters:
    newNumberOfCollectionElements - The new number of collection elements.
  - getMaxDepth
```
public 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.
    
    Specified by:
    
    getMaxDepth in interface DataProviderStrategy
    
    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
  - setMaxDepth
```
public void setMaxDepth(int newMaxDepth)
```
    Sets the new max stack trace depth.
    
    Parameters:
    newMaxDepth - The new max stack trace depth.
  - isMemoizationEnabled
```
public 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.
    
    Specified by:
    
    isMemoizationEnabled in interface DataProviderStrategy
    
    Returns:
    Whether the memoization setting is enabled.
  - setMemoizationEnabled
```
public void setMemoizationEnabled(boolean value)
```
    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.
    
    Parameters:
    value - True to enable, false to disable.
  - sort
```
public void sort(Constructor<?>[] constructors)
```
    Rearranges POJO's constructors in order they will be tried to produce the POJO. Default strategy consist of putting constructors with less parameters to be tried first.
    
    Specified by:
    
    sort in interface DataProviderStrategy
    
    Parameters:
    constructors - Array of POJO's constructors
  - sort
```
public void sort(Method[] methods)
```
    Rearranges POJO's methods in order they will be tried to produce the POJO. Default strategy consist of putting methods with more parameters to be tried first.
    
    Specified by:
    
    sort in interface DataProviderStrategy
    
    Parameters:
    methods - Array of POJO's methods
  - addSpecific
```
public <T> AbstractRandomDataProviderStrategy addSpecific(Class<T> abstractClass,
                                                 Class<? extends T> specificClass)
```
    Bind an interface/abstract class to a specific implementation
    
    Parameters:
    abstractClass - the interface/abstract class to bind
    specificClass - the specific class implementing or extending abstractClass.
    
    Returns:
    itself
  - removeSpecific
```
public <T> AbstractRandomDataProviderStrategy removeSpecific(Class<T> abstractClass)
```
    Remove binding of an interface/abstract class to a specific implementation
    
    Parameters:
    abstractClass - the interface/abstract class to remove binding
    
    Returns:
    itself
  - getSpecificClass
```
public <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.
    
    Specified by:
    
    getSpecificClass in interface DataProviderStrategy
    
    Parameters:
    nonInstantiatableClass - Abstract class type or interface
    
    Returns:
    Non-abstract class type derived from nonInstantiatableClass.
  - addExcludedAnnotation
```
public AbstractRandomDataProviderStrategy addExcludedAnnotation(Class<? extends Annotation> annotation)
```
    Adds the specified Annotation to set of excluded annotations, if it is not already present.
    
    Parameters:
    annotation - the annotation to use as an exlusion mark
    
    Returns:
    itself
  - removeExcludedAnnotation
```
public AbstractRandomDataProviderStrategy removeExcludedAnnotation(Class<? extends Annotation> annotation)
```
    Adds the specified Annotation from set of excluded annotations.
    
    Parameters:
    annotation - the annotation used as an exlusion mark
    
    Returns:
    itself
  - getExcludedAnnotations
```
public 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.
    
    Specified by:
    
    getExcludedAnnotations in interface DataProviderStrategy
    
    Returns:
    set of annotations, which mark fields to be skipped from populating.

Class AbstractRandomDataProviderStrategy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RANDOM

CONSTRUCTOR_COMPARATOR

METHOD_COMPARATOR

NICE_ASCII_CHARACTERS

MAX_DEPTH

DEFAULT_NBR_COLLECTION_ELEMENTS

maxDepth

nbrOfCollectionElements

isMemoizationEnabled

specificTypes

excludedAnnotations

Constructor Detail

AbstractRandomDataProviderStrategy

AbstractRandomDataProviderStrategy

Method Detail

getBoolean

getByte

getByteInRange

getCharacter

getCharacterInRange

getDouble

getDoubleInRange

getFloat

getFloatInRange

getInteger

getIntegerInRange

getLong

getLongInRange

getShort

getShortInRange

getStringValue

getStringOfLength

getNumberOfCollectionElements

setNumberOfCollectionElements

getMaxDepth

setMaxDepth

isMemoizationEnabled

setMemoizationEnabled

sort

sort

addSpecific

removeSpecific

getSpecificClass

addExcludedAnnotation

removeExcludedAnnotation

getExcludedAnnotations