com.neeve.util

Class UtlObjectGraph.BasePopulationHelper

java.lang.Object

com.neeve.util.UtlObjectGraph.BasePopulationHelper

All Implemented Interfaces:

UtlObjectGraph.PopulationHelper

Enclosing class:

UtlObjectGraph

public static class UtlObjectGraph.BasePopulationHelper
extends Object
implements UtlObjectGraph.PopulationHelper

A helper base class to assist in object population.

Subclasses may extend this class to override individual methods.

Constructor Summary

Constructors

Constructor and Description
BasePopulationHelper()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePopulationHelper

public BasePopulationHelper()

Method Detail

getFactoryObjects

public Collection<?> getFactoryObjects()

Description copied from interface: UtlObjectGraph.PopulationHelper

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.

Specified by:

getFactoryObjects in interface UtlObjectGraph.PopulationHelper

Returns:

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

getTypeParameters

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

Description copied from interface: UtlObjectGraph.PopulationHelper

Used to retrieve the concrete types for initializing a class with

Specified by:

getTypeParameters in interface UtlObjectGraph.PopulationHelper

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

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

Description copied from interface: UtlObjectGraph.PopulationHelper

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

Specified by:

shouldPopulate in interface UtlObjectGraph.PopulationHelper

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

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

Description copied from interface: UtlObjectGraph.PopulationHelper

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

Specified by:

getNewInstance in interface UtlObjectGraph.PopulationHelper

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.