io.probedock.junitee.generator

Class CompositeDataGenerator

java.lang.Object

io.probedock.junitee.generator.CompositeDataGenerator

All Implemented Interfaces:

IDataGenerator

public abstract class CompositeDataGenerator
extends Object
implements IDataGenerator

Use a composite data generator if you want to beneficiate from the power of automatism around the composite data generator. Once your setup of data generator is done properly, you do not have to manually call the data generation by yourself. Basically, you have to override the setup method to put the code you need to register and setup your data generators to be run in the correct order.

Author:

Laurent Prevost

Constructor Summary

Constructors

Constructor and Description
CompositeDataGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	cleanData() Generate method should be implemented to cleanup data before all other data are cleanup.
void	cleanup() Cleanup data after the test ends.
CompositeDataGenerator	dependsOn(IDataGenerator dataGenerator) Define a dependency from a data generator to another one.
CompositeDataGenerator	dependsOn(String dataGeneratorName, IDataGenerator dataGenerator) Define a dependency from a data generator to another one.
void	generate() Generate data before the test starts.
protected abstract void	generateData() Generate method should be implemented to generate data after all other data are generated.
protected <T> T	getDataGenerator(Class<? extends T> dataGeneratorClass) Retrieve the generator from a data generator class
protected <T> T	getDataGenerator(String dataDataGeneratorName, Class<? extends T> dataGeneratorClass) Retrieve the generator from a data generator class
protected int	getNumberToGenerate()
protected String	getPrefix()
CompositeDataGenerator	numberToGenerate(int number) Configure the number of data instances to generate.
protected void	register(IDataGenerator dataGenerator) Register a data generator to be run next to the previous registered data generator.
protected void	setup() The setup method must be override to setup the different things in the composite generator.
CompositeDataGenerator	usePrefix(String prefix) Configure a string prefix to be used in the data generation

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeDataGenerator

public CompositeDataGenerator()

Method Detail

dependsOn

public CompositeDataGenerator dependsOn(IDataGenerator dataGenerator)

Define a dependency from a data generator to another one. This allows to gain access to the data generator directly into the data generator and to have the warranty that the data generator has already run. It allows having the generated data available into one another generator.

Parameters:

dataGenerator - The data generator on which [this] depends on

Returns:

This

dependsOn

public CompositeDataGenerator dependsOn(String dataGeneratorName,
                               IDataGenerator dataGenerator)

Define a dependency from a data generator to another one. This allows to gain access to the data generator directly into the data generator and to have the warranty that the data generator has already run. It allows having the generated data available into one another generator.

Parameters:

dataGeneratorName - The name of the data generator to have more than one instance of the same generator

dataGenerator - The data generator on which [this] depends on

Returns:

This

numberToGenerate

public CompositeDataGenerator numberToGenerate(int number)

Configure the number of data instances to generate.

Parameters:

number - The number of data to generate

Returns:

This

usePrefix

public CompositeDataGenerator usePrefix(String prefix)

Configure a string prefix to be used in the data generation

Parameters:

prefix - The prefix to use

Returns:

This

getNumberToGenerate

protected int getNumberToGenerate()

Returns:

The configuration value for the number to generate

getPrefix

protected String getPrefix()

Returns:

The configuration value for the prefix to use

getDataGenerator

protected <T> T getDataGenerator(Class<? extends T> dataGeneratorClass)

Retrieve the generator from a data generator class

Type Parameters:

T - The type of generator

Parameters:

dataGeneratorClass - The data generator class

Returns:

The generator found

Throws:

IllegalStateException - In case the data generator is not found

getDataGenerator

protected <T> T getDataGenerator(String dataDataGeneratorName,
                     Class<? extends T> dataGeneratorClass)

Retrieve the generator from a data generator class

Type Parameters:

T - The type of generator

Parameters:

dataDataGeneratorName - The data generator name to retrieve

dataGeneratorClass - The data generator class

Returns:

The generator found

Throws:

IllegalStateException - In case the data generator is not found

register

protected final void register(IDataGenerator dataGenerator)

Register a data generator to be run next to the previous registered data generator. The execution order will be the same as the order of the call to register method.

Parameters:

dataGenerator - The data generator to register

setup

protected void setup()

The setup method must be override to setup the different things in the composite generator. In this method, you should call other methods like register or dependsOn and so on. All the stuff to configure correctly your data generator. The setup method is always run before the data generation

generateData

protected abstract void generateData()

Generate method should be implemented to generate data after all other data are generated. In that method, you should have access to other generators and the result of the data generation.

generate

public final void generate()

Description copied from interface: IDataGenerator

Generate data before the test starts.

Specified by:

generate in interface IDataGenerator

cleanData

protected abstract void cleanData()

Generate method should be implemented to cleanup data before all other data are cleanup. In that method, you should have access to other generators and the result of the data generation.

cleanup

public final void cleanup()

Description copied from interface: IDataGenerator

Cleanup data after the test ends.

Specified by:

cleanup in interface IDataGenerator