Package com.github.nylle.javafixture

Class SpecimenBuilder<T>

java.lang.Object

com.github.nylle.javafixture.SpecimenBuilder<T>

All Implemented Interfaces:

ISpecimenBuilder<T>

public class SpecimenBuilder<T>
extends Object
implements ISpecimenBuilder<T>

Constructor Summary

Constructors

Constructor	Description
SpecimenBuilder(SpecimenType<T> type, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
T	create()
Stream<T>	createMany()
Stream<T>	createMany(int size)	Creates a Stream of objects based on this ISpecimenBuilder<T> with the specified size
Optional<T>	createOptional()
<U> ISpecimenBuilder<T>	with(SpecimenType<U> type, U value)	Sets all fields with the specified type to the specified value during object creation.
<U> ISpecimenBuilder<T>	with(Class<U> type, U value)	Sets all fields with the specified type to the specified value during object creation.
ISpecimenBuilder<T>	with(String fieldName, Object value)	Sets the field with the specified name to the specified value during object creation
ISpecimenBuilder<T>	with(Consumer<T> function)	Applies the specified function to the created object
ISpecimenBuilder<T>	without(String fieldName)	Omits the field with the specified name during object creation Primitives will receive their respective default-value, objects will be null

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecimenBuilder

public SpecimenBuilder(SpecimenType<T> type,
                       Configuration configuration)

Method Detail

create

public T create()

Specified by:

create in interface ISpecimenBuilder<T>

Returns:

a new object based on this ISpecimenBuilder<T>

createOptional

public Optional<T> createOptional()

Specified by:

createOptional in interface ISpecimenBuilder<T>

Returns:

a new Optional<T> based on this ISpecimenBuilder<T>

createMany

public Stream<T> createMany()

Specified by:

createMany in interface ISpecimenBuilder<T>

Returns:

a Stream of objects based on this ISpecimenBuilder<T>

createMany

public Stream<T> createMany(int size)

Creates a Stream of objects based on this ISpecimenBuilder<T> with the specified size

Specified by:

createMany in interface ISpecimenBuilder<T>

Parameters:

size - the size of the Stream to be created

Returns:

a Stream of objects based on this ISpecimenBuilder<T>

with

public ISpecimenBuilder<T> with(Consumer<T> function)

Applies the specified function to the created object

Specified by:

with in interface ISpecimenBuilder<T>

Parameters:

function - a function to customise the created object

Returns:

this builder for further customisation

with

public ISpecimenBuilder<T> with(String fieldName,
                                Object value)

Sets the field with the specified name to the specified value during object creation

Specified by:

with in interface ISpecimenBuilder<T>

Parameters:

fieldName - the name of the field to be set

value - the value to be set to the field

Returns:

this builder for further customisation

with

public <U> ISpecimenBuilder<T> with(Class<U> type,
                                    U value)

Sets all fields with the specified type to the specified value during object creation.

Specified by:

with in interface ISpecimenBuilder<T>

Type Parameters:

U - the type of the value

Parameters:

type - the type of the fields to be set

value - the value to be set to the fields

Returns:

this builder for further customisation

with

public <U> ISpecimenBuilder<T> with(SpecimenType<U> type,
                                    U value)

Sets all fields with the specified type to the specified value during object creation.

Specified by:

with in interface ISpecimenBuilder<T>

Type Parameters:

U - the type of the value

Parameters:

type - the type of the fields to be set

value - the value to be set to the fields

Returns:

this builder for further customisation

without

public ISpecimenBuilder<T> without(String fieldName)

Omits the field with the specified name during object creation Primitives will receive their respective default-value, objects will be null

Specified by:

without in interface ISpecimenBuilder<T>

Parameters:

fieldName - the name of the field to be set

Returns:

this builder for further customisation