org.exparity.stub.stub

Class StubBuilder<T>

java.lang.Object

org.exparity.stub.stub.StubBuilder<T>

public class StubBuilder<T>
extends Object

Builder object for creating a stub object which returns random values for all calls

Author:

Stewart Bissett

Method Summary

Modifier and Type	Method and Description
static <T> StubBuilder<T>	aRandomStubOf(Class<T> type) Return an instance of a StubBuilder for the given type which is populated with random values.
static <T> StubBuilder<T>	aRandomStubOf(TypeReference<T> type) Return an instance of a StubBuilder for the given generic type which is populated with random values.
T	build() Build the configured instance.
StubBuilder<T>	collectionSizeOf(int size) Configure the builder to set the size of a collections.
StubBuilder<T>	collectionSizeRangeOf(int min, int max) Configure the builder to set the size of a collections to within a given range.
<X> StubBuilder<T>	factory(Class<X> type, ValueFactory<X> factory) Configure the builder to populate any properties of the given type with a value created by the supplied value factory.
<X> StubBuilder<T>	subtype(Class<X> supertype, Class<? extends X>... subtypes) Configure the builder to use any of of a particular subtype when instantiating a super type.
<X> StubBuilder<T>	subtype(Class<X> supertype, Class<? extends X> subtype) Configure the builder to use a particular subtype when instantiating a super type.
<V> StubBuilder<T>	with(Class<V> type, ValueFactory<V> factory) Configure the builder to populate any properties of the given type with a value created by the supplied value factory.

Methods inherited from class java.lang.Object

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

Method Detail

aRandomStubOf

public static <T> StubBuilder<T> aRandomStubOf(Class<T> type)

Return an instance of a StubBuilder for the given type which is populated with random values. For example:

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class).build()
 

Parameters:

type - the type to return the StubBuilder for

aRandomStubOf

public static <T> StubBuilder<T> aRandomStubOf(TypeReference<T> type)

Return an instance of a StubBuilder for the given generic type which is populated with random values. For example:

 MyType value = StubBuilder.aRandomInstanceOf(new TypeReference<MyType<String>>(){})
      .build()
 

Parameters:

type - the type to return the StubBuilder for

with

public <V> StubBuilder<T> with(Class<V> type,
                               ValueFactory<V> factory)

Configure the builder to populate any properties of the given type with a value created by the supplied value factory. For example

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class)
                        .with(Date.class, ValueFactories.oneOf(APR(5,1975), APR(5,1985)))
                        .build()
 

Parameters:

type - the type of property to use the factory for

factory - the factory to use to create the value

factory

public <X> StubBuilder<T> factory(Class<X> type,
                                  ValueFactory<X> factory)

Configure the builder to populate any properties of the given type with a value created by the supplied value factory. For example

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class)
                        .factory(Date.class, ValueFactories.oneOf(APR(5,1975), APR(5,1985)))
                        .build()
 

Parameters:

type - the type of property to use the factory for

factory - the factory to use to create the value

collectionSizeOf

public StubBuilder<T> collectionSizeOf(int size)

Configure the builder to set the size of a collections. For example

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeOf(5)
                        .build()
 

Parameters:

size - the size to create the collections

collectionSizeRangeOf

public StubBuilder<T> collectionSizeRangeOf(int min,
                                            int max)

Configure the builder to set the size of a collections to within a given range. For example

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeRangeOf(2,10)
                        .build()
 

Parameters:

min - the minimum size to create the collections

max - the maximum size to create the collections

subtype

public <X> StubBuilder<T> subtype(Class<X> supertype,
                                  Class<? extends X> subtype)

Configure the builder to use a particular subtype when instantiating a super type. For example

 ShapeSorter aSorter = StubBuilder.aRandomInstanceOf(ShapeSorter.class)
                        .subtype(Shape.class, Square.class)
                        .build()
 

Parameters:

supertype - the type of the super type

subtype - the subtype to use when instantiating the super type

subtype

public <X> StubBuilder<T> subtype(Class<X> supertype,
                                  Class<? extends X>... subtypes)

Configure the builder to use any of of a particular subtype when instantiating a super type. For example

 ShapeSorter aSorter = StubBuilder.aRandomInstanceOf(ShapeSorter.class)
                        .subtype(Shape.class, Square.class, Circle.class, Triangle.class)
                        .build()
 

Parameters:

supertype - the type of the super type

subtypes - the subtypes to pick from when instantiating the super type

build

public T build()

Build the configured instance. For example

 Person aPerson = StubBuilder.aRandomInstanceOf(Person.class).build()