com.neeve.util

Interface UtlObjectGraph.PopulationHelper

All Known Implementing Classes:

UtlObjectGraph.BasePopulationHelper

Enclosing class:

UtlObjectGraph

public static interface UtlObjectGraph.PopulationHelper

A helper interface to assist in object population.

Method Summary

Modifier and Type	Method and Description
Collection<?>	getFactoryObjects() Returns a collection of factory objects to help in creating new Objects.
Object	getNewInstance(Class<?> type, Stack<String> getterStack, Random random) Allows the helper to provide a new object instance that is perhaps more customized than that provided by the random populator.
Class<?>[]	getTypeParameters(Object o, Class<?> parameterizedType, Stack<String> getterStack) Used to retrieve the concrete types for initializing a class with
boolean	shouldPopulate(Class<?> type, Stack<String> getterStack, Random random) Called by the populator to test whether a field at the given stack should be populated.

Method Detail

getFactoryObjects

Collection<?> getFactoryObjects()

Returns a collection of factory objects to help in creating new Objects. The population methods will search for methods of the form create() methods to assist in insantiating new types.

Returns:

A set of facorties for creating objects to populate fields in the graph being populated.

getTypeParameters

Class<?>[] getTypeParameters(Object o,
                             Class<?> parameterizedType,
                             Stack<String> getterStack)

Used to retrieve the concrete types for initializing a class with

Parameters:

o - The generic object being populated.

parameterizedType - the parameterized type whose types need to be resolved

getterStack - The location in the stack from the root object being intialized.

Returns:

A helper for determining the generic type of a collection field in the graph.

shouldPopulate

boolean shouldPopulate(Class<?> type,
                       Stack<String> getterStack,
                       Random random)

Called by the populator to test whether a field at the given stack should be populated.

Parameters:

type - The type of the field.

getterStack - The field's path.

random - An instanct of random to allow for predictable randomization.

Returns:

true if the field should be populated, false otherwise.

getNewInstance

Object getNewInstance(Class<?> type,
                      Stack<String> getterStack,
                      Random random)

Allows the helper to provide a new object instance that is perhaps more customized than that provided by the random populator. The populator will still further populate the returned type with random data if it is:

• An array (in which case this method should return a new array without instantiating any of its members, customization of the members can be done when the array is descended into by the populator
• A collection, in which case its members will be constructed and inserted after the collection is returned
• A object matching the set of considered classes for the populator
• Not a primitive or built in type

Parameters:

type - The object type to create.

getterStack - The stack representing the accessor method from the root object to the getter.

random - A random seeded for use in population.

Returns:

a new instance or null if the populator should handle creating the field.