org.bbottema.loremipsumobjects.typefactories

Class LoremIpsumObjectFactory<T>

java.lang.Object

org.bbottema.loremipsumobjects.typefactories.LoremIpsumObjectFactory<T>

Direct Known Subclasses:

ClassBasedFactory, ConstructorBasedFactory, FixedInstanceFactory, MethodBasedFactory, RandomArrayFactory, RandomBigDecimalFactory, RandomBooleanFactory, RandomEnumFactory, RandomFactoryFactory, RandomLocalDateFactory, RandomLocalDateTimeFactory, RandomOptionalFactory, RandomPrimitiveFactory, RandomStringFactory, RandomUuidFactory

public abstract class LoremIpsumObjectFactory<T>
extends Object

Defines the interface for creating a dummy instance. A default implementation is provided for validation purposes (always returns true by default).

Constructor Summary

Constructors

Constructor and Description
LoremIpsumObjectFactory()

Method Summary

Modifier and Type	Method and Description
T	createLoremIpsumObject() Delegates to createLoremIpsumObject(LoremIpsumConfig) with the default bindings.
T	createLoremIpsumObject(@Nullable LoremIpsumConfig loremIpsumConfig) Starts a new chain for the creation of a dummy with an empty list of known class instances and empty list of exceptions.
T	createLoremIpsumObject(@Nullable Type[] genericMetaData, @Nullable Map<String,ClassUsageInfo<?>> knownInstances, LoremIpsumConfig loremIpsumConfig, @Nullable List<Exception> exceptions) Creates a new instance of one of the following: the requested type, a sub type of the requested type or, if the requested type is an interface definition, a suitable implementation.
boolean	isValidForType(Class<? super T> clazz) Default implementation returns true.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoremIpsumObjectFactory

public LoremIpsumObjectFactory()

Method Detail

isValidForType

public boolean isValidForType(Class<? super T> clazz)

Default implementation returns true. Should be used when a factory knows beforehand when it will be unable to produce an instance of the requested type.

createLoremIpsumObject

@Nullable
public final T createLoremIpsumObject()

Delegates to createLoremIpsumObject(LoremIpsumConfig) with the default bindings.

createLoremIpsumObject

@Nullable
public final T createLoremIpsumObject(@Nullable
                                                @Nullable LoremIpsumConfig loremIpsumConfig)

Starts a new chain for the creation of a dummy with an empty list of known class instances and empty list of exceptions.

Parameters:

loremIpsumConfig - A list of bindings to which a factory may defer dummy creation to.

Returns:

See createLoremIpsumObject(Type[], Map, LoremIpsumConfig, List).

createLoremIpsumObject

@Nullable
public T createLoremIpsumObject(@Nullable
                                          @Nullable Type[] genericMetaData,
                                          @Nullable
                                          @Nullable Map<String,ClassUsageInfo<?>> knownInstances,
                                          LoremIpsumConfig loremIpsumConfig,
                                          @Nullable
                                          @Nullable List<Exception> exceptions)

Creates a new instance of one of the following: the requested type, a sub type of the requested type or, if the requested type is an interface definition, a suitable implementation. Should return null if nothing can be found. In case of method/constructor errors due to generated test data falling out of a range or causing a timeout, the process is retried a few times for each step (for example when a method really wants a small numbers, but a large number is generated the first time).

If there are known exceptions (reflection exceptions when invoking a Constructor for example), don't throw them, but record them in the given exceptions list. Not all failures are counted towards complete failures.

Parameters:

genericMetaData - Can be null. Should be non-null when requested type is a List or Map.

knownInstances - A list of previously created and populated objects for a specific type.

loremIpsumConfig - A list of bindings to which a factory may defer dummy creation to.

exceptions - A list in which to store exceptions so they can be logged at some later point. This is done so, because not all exceptions are bad (in case a factory is trying to find a useful constructor, invocations are allowed to fail if a suitable constructor can be found otherwise).

Returns:

A new instance of the given type.