com.openpojo.random.service

Interface RandomGeneratorService

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultRandomGeneratorService

public interface RandomGeneratorService
extends Service

This service holds a registry for RandomGenerators.

Author:

oshoukry

Method Summary

Modifier and Type	Method and Description
RandomGenerator	getDefaultRandomGenerator() Returns the default registered RandomGenerator;
RandomGenerator	getRandomGeneratorByParameterizable(Parameterizable type) This retrieves the most appropriate ParameterizableRandomGenerator for a given Type.
RandomGenerator	getRandomGeneratorByType(Class<?> type) This retrieves the most appropriate RandomGenerator for a given Type.
Collection<Class<?>>	getRegisteredTypes() Get all registered types.
void	registerRandomGenerator(RandomGenerator randomGenerator) Register a RandomGenerator.
void	setDefaultRandomGenerator(RandomGenerator randomGenerator) This method set the RandomGenerator to use if non are registered for given type.

Methods inherited from interface com.openpojo.registry.Service

getName

Method Detail

registerRandomGenerator

void registerRandomGenerator(RandomGenerator randomGenerator)

Register a RandomGenerator. The RandomGenerator's getTypes will be invoked and all types returned will be registered against this RandomGenerator over-writing any prior registrations for given types.

Parameters:

randomGenerator - The random generator to register.

getRegisteredTypes

Collection<Class<?>> getRegisteredTypes()

Get all registered types.

Returns:

all the registered types in service.

setDefaultRandomGenerator

void setDefaultRandomGenerator(RandomGenerator randomGenerator)

This method set the RandomGenerator to use if non are registered for given type. This randomGenerator's getTypes() return will be ignored and not consulted for routing. There can only be one (1) default random generator.

Parameters:

randomGenerator - The random generator to register.

getDefaultRandomGenerator

RandomGenerator getDefaultRandomGenerator()

Returns the default registered RandomGenerator;

Returns:

the default registered random generator.

getRandomGeneratorByType

RandomGenerator getRandomGeneratorByType(Class<?> type)

This retrieves the most appropriate RandomGenerator for a given Type. If there is more than one possible random generator valid for a given type, one will randomly be selected. The only reason multiple may exist is due to inheritance, for example if you register two random generators one to handle LinkedList, and one to handle Set, and request a randomGenerator for type "Collection", either of those randomGenerators could be used. However, if there is a random generator registered for Collection, that will be the one used.

Parameters:

type - The type used to lookup the most appropriate RandomGenerator.

Returns:

The random generator to handle generating random values for requested type.

getRandomGeneratorByParameterizable

RandomGenerator getRandomGeneratorByParameterizable(Parameterizable type)

This retrieves the most appropriate ParameterizableRandomGenerator for a given Type. If there is more than one possible random generator valid for a given type, one will randomly be selected. The only reason multiple may exist is due to inheritance, for example if you register two random generators one to handle LinkedList, and one to handle Set, and request a randomGenerator for type "Collection", either of those randomGenerators could be used. However, if there is a random generator registered for Collection, that will be the one used.

Parameters:

type - The parameterized type used to lookup the most appropriate RandomGenerator.

Returns:

The parameterized random generator to handle generating random values for requested type.