org.exparity.stub.builder

Class BeanBuilder<T>

java.lang.Object

org.exparity.stub.builder.BeanBuilder<T>

public class BeanBuilder<T>
extends java.lang.Object

Builder object for instantiating and populating objects which follow the Java beans standards conventions for getter/setters

Author:

Stewart Bissett

Method Summary

Methods

Modifier and Type	Method and Description
static <T> BeanBuilder<T>	anEmptyInstanceOf(java.lang.Class<T> type) Return an instance of a BeanBuilder for the given type which is populated with empty objects but collections, maps, etc which have empty objects.
static <T> BeanBuilder<T>	anEmptyInstanceOf(java.lang.Class<T> type, java.lang.String rootName) Return an instance of a BeanBuilder for the given type which is populated with empty objects but collections, maps, etc which have empty objects.
static <T> BeanBuilder<T>	anInstanceOf(java.lang.Class<T> type) Return an instance of a BeanBuilder for the given type which can then be populated with values either manually or automatically.
static <T> BeanBuilder<T>	anInstanceOf(java.lang.Class<T> type, java.lang.String rootName) Return an instance of a BeanBuilder for the given type which can then be populated with values either manually or automatically.
static <T> BeanBuilder<T>	aRandomInstanceOf(java.lang.Class<T> type) Return an instance of a BeanBuilder for the given type which is populated with random values.
static <T> BeanBuilder<T>	aRandomInstanceOf(java.lang.Class<T> type, java.lang.String rootName) Return an instance of a BeanBuilder for the given type which is populated with random values.
T	build() Build the configured instance.
BeanBuilder<T>	collectionSizeForPathOf(java.lang.String path, int size) Configure the builder to set the size of a collection for a path to within a given range.
BeanBuilder<T>	collectionSizeForPropertyOf(java.lang.String property, int size) Configure the builder to set the size of a collection at a path.
BeanBuilder<T>	collectionSizeOf(int size) Configure the builder to set the size of a collections.
BeanBuilder<T>	collectionSizeRangeForPathOf(java.lang.String path, int min, int max) Configure the builder to set the size of a collection at a path to within a given range.
BeanBuilder<T>	collectionSizeRangeForPropertyOf(java.lang.String property, int min, int max) Configure the builder to set the size of a collection at a path to within a given range.
BeanBuilder<T>	collectionSizeRangeOf(int min, int max) Configure the builder to set the size of a collections to within a given range.
BeanBuilder<T>	excludePath(java.lang.String path) Configure the builder to exclude the given path from being populated.
BeanBuilder<T>	excludeProperty(java.lang.String propertyName) Configure the builder to exclude the given property from being populated.
<X> BeanBuilder<T>	factory(java.lang.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.
BeanBuilder<T>	path(java.lang.String path, java.lang.Object value) Configure the builder to populate the given path with the supplied value.
BeanBuilder<T>	path(java.lang.String path, ValueFactory<?> factory) Configure the builder to populate the given path with a value created by the supplied value factory.
BeanBuilder<T>	property(java.lang.String propertyName, java.lang.Object value) Configure the builder to populate the given property with the supplied value.
BeanBuilder<T>	property(java.lang.String propertyName, ValueFactory<?> factory) Configure the builder to populate the given property with a value created by the supplied value factory.
<X> BeanBuilder<T>	subtype(java.lang.Class<X> supertype, java.lang.Class<? extends X>... subtypes) Configure the builder to use any of of a particular subtype when instantiating a super type.
<X> BeanBuilder<T>	subtype(java.lang.Class<X> supertype, java.lang.Class<? extends X> subtype) Configure the builder to use a particular subtype when instantiating a super type.
<V> BeanBuilder<T>	with(java.lang.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.
BeanBuilder<T>	with(java.lang.String propertyOrPathName, java.lang.Object value) Configure the builder to populate the given property or path with the supplied value.
BeanBuilder<T>	with(java.lang.String propertyOrPathName, ValueFactory<?> factory) Configure the builder to populate the given property or path 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

anInstanceOf

public static <T> BeanBuilder<T> anInstanceOf(java.lang.Class<T> type)

Return an instance of a BeanBuilder for the given type which can then be populated with values either manually or automatically. For example:

 
 Person aPerson = BeanBuilder.anInstanceOf(Person.class)
                .path("person.firstName", "Bob")
                .build()
 

Parameters:

type - the type to return the BeanBuilder for

anInstanceOf

public static <T> BeanBuilder<T> anInstanceOf(java.lang.Class<T> type,
                              java.lang.String rootName)

Return an instance of a BeanBuilder for the given type which can then be populated with values either manually or automatically. For example:

 Person aPerson = BeanBuilder.anInstanceOf(Person.class, "instance")
                        .path("instance.firstName", "Bob")
                        .build()
 

Parameters:

type - the type to return the BeanBuilder for

rootName - the name give to the root entity when referencing paths

anEmptyInstanceOf

public static <T> BeanBuilder<T> anEmptyInstanceOf(java.lang.Class<T> type)

Return an instance of a BeanBuilder for the given type which is populated with empty objects but collections, maps, etc which have empty objects. For example:

 
 Person aPerson = BeanBuilder.anEmptyInstanceOf(Person.class)
                .path("person.firstName", "Bob")
                .build();
 

Parameters:

type - the type to return the BeanBuilder for

anEmptyInstanceOf

public static <T> BeanBuilder<T> anEmptyInstanceOf(java.lang.Class<T> type,
                                   java.lang.String rootName)

Return an instance of a BeanBuilder for the given type which is populated with empty objects but collections, maps, etc which have empty objects. For example:

 Person aPerson = BeanBuilder.anEmptyInstanceOf(Person.class, "instance")
                        .path("instance.firstName", "Bob")
                        .build()
 

Parameters:

type - the type to return the BeanBuilder for

rootName - the name give to the root entity when referencing paths

aRandomInstanceOf

public static <T> BeanBuilder<T> aRandomInstanceOf(java.lang.Class<T> type)

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

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                .path("person.firstName", "Bob")
                .build()
 

Parameters:

type - the type to return the BeanBuilder for

aRandomInstanceOf

public static <T> BeanBuilder<T> aRandomInstanceOf(java.lang.Class<T> type,
                                   java.lang.String rootName)

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

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class,"instance")
                        .path("instance.firstName", "Bob")
                        .build()
 

Parameters:

type - the type to return the BeanBuilder for

with

public BeanBuilder<T> with(java.lang.String propertyOrPathName,
                  java.lang.Object value)

Configure the builder to populate the given property or path with the supplied value. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .with("firstName", "Bob")
                        .build()
 

Parameters:

propertyOrPathName - the property or path name to set the value on

value - the value to assign the property or path

with

public <V> BeanBuilder<T> with(java.lang.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 = BeanBuilder.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

with

public BeanBuilder<T> with(java.lang.String propertyOrPathName,
                  ValueFactory<?> factory)

Configure the builder to populate the given property or path with a value created by the supplied value factory. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .with("firstName", ValueFactories.oneOf("Bob", "Alice"))
                        .build()
 

Parameters:

propertyOrPathName - the property or path name to set the value on

factory - the factory to use to create the value

property

public BeanBuilder<T> property(java.lang.String propertyName,
                      java.lang.Object value)

Configure the builder to populate the given property with the supplied value. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .property("firstName", "Bob")
                        .build()
 

Parameters:

propertyName - the property to set the value on

value - the value to assign the property

property

public BeanBuilder<T> property(java.lang.String propertyName,
                      ValueFactory<?> factory)

Configure the builder to populate the given property with a value created by the supplied value factory. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .property("firstName", ValueFactories.oneOf("Bob", "Alice"))
                        .build()
 

Parameters:

propertyName - the property to set the value on

factory - the factory to use to create the value

factory

public <X> BeanBuilder<T> factory(java.lang.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 = BeanBuilder.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

excludeProperty

public BeanBuilder<T> excludeProperty(java.lang.String propertyName)

Configure the builder to exclude the given property from being populated. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .excludeProperty("firstName")
                        .build()
 

Parameters:

propertyName - the property to exclude

path

public BeanBuilder<T> path(java.lang.String path,
                  java.lang.Object value)

Configure the builder to populate the given path with the supplied value. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .path("person.firstName", "Bob")
                        .build()
 

Parameters:

path - the path to set the value on

value - the value to assign the path

path

public BeanBuilder<T> path(java.lang.String path,
                  ValueFactory<?> factory)

Configure the builder to populate the given path with a value created by the supplied value factory. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .path("person.firstName", ValueFactories.oneOf("Bob", "Alice"))
                        .build()
 

Parameters:

path - the path to set the value on

factory - the factory to use to create the value

excludePath

public BeanBuilder<T> excludePath(java.lang.String path)

Configure the builder to exclude the given path from being populated. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .excludeProperty("person.firstName")
                        .build()
 

Parameters:

path - the path to exclude

collectionSizeOf

public BeanBuilder<T> collectionSizeOf(int size)

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

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

Parameters:

size - the size to create the collections

collectionSizeRangeOf

public BeanBuilder<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 = BeanBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeRangeOf(2,10)
                        .build()
 

Parameters:

min - the minimum size to create the collections

max - the maximum size to create the collections

collectionSizeRangeForPropertyOf

public BeanBuilder<T> collectionSizeRangeForPropertyOf(java.lang.String property,
                                              int min,
                                              int max)

Configure the builder to set the size of a collection at a path to within a given range. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeRangeForPropertyOf("sublings", 1,3)
                        .build()
 

Parameters:

property - the name of the property to limit the collection size of

min - the minimum size to create the collections

max - the maximum size to create the collections

collectionSizeForPropertyOf

public BeanBuilder<T> collectionSizeForPropertyOf(java.lang.String property,
                                         int size)

Configure the builder to set the size of a collection at a path. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeForPropertyOf("sublings", 3)
                        .build()
 

Parameters:

property - the name of the property to limit the collection size of

size - the size to create the collection

collectionSizeForPathOf

public BeanBuilder<T> collectionSizeForPathOf(java.lang.String path,
                                     int size)

Configure the builder to set the size of a collection for a path to within a given range. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeForPathOf("person.sublings", 1, 3)
                        .build()
 

Parameters:

path - the path to limit the collection size of

size - the size to create the collection

collectionSizeRangeForPathOf

public BeanBuilder<T> collectionSizeRangeForPathOf(java.lang.String path,
                                          int min,
                                          int max)

Configure the builder to set the size of a collection at a path to within a given range. For example

 Person aPerson = BeanBuilder.aRandomInstanceOf(Person.class)
                        .collectionSizeRangeForPathOf("person.siblings", 1,3)
                        .build()
 

Parameters:

path - the name of the path to limit the collection size of

min - the minimum size to create the collection

max - the maximum size to create the collection

subtype

public <X> BeanBuilder<T> subtype(java.lang.Class<X> supertype,
                         java.lang.Class<? extends X> subtype)

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

 ShapeSorter aSorter = BeanBuilder.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> BeanBuilder<T> subtype(java.lang.Class<X> supertype,
                         java.lang.Class<? extends X>... subtypes)

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

 ShapeSorter aSorter = BeanBuilder.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 = BeanBuilder.aRandomInstanceOf(Person.class)
                        .path("person.firstName", "Bob")
                        .path("person.age", oneOf(25,35))
                        .build()