io.github.glytching.junit.extension.random

Annotation Type Random

@Retention(value=RUNTIME)
 @Target(value={FIELD,PARAMETER,ANNOTATION_TYPE})
 @Documented
public @interface Random

Allows the caller to customise the random generation of a given type.

Usage example:

  // create a random instance of String
  @Random String anyString;

  // create a random, fully populated instance of MyDomainObject
  @Random private DomainObject fullyPopulatedDomainObject;

  // create a random, partially populated instance of MyDomainObject, ignoring these fields: "wotsits", "id", "nestedDomainObject.address"
  @Random(excludes = {"wotsits", "id", "nestedDomainObject.address"}) MyDomainObject partiallyPopulatedDomainObject;

  // create a List containing the default size of randomly generated instances of String
  @Random(type = String.class) List anyStrings;

  // create a Stream containing two randomly generated instances of MyDomainObject
  @Random(size = 2, type = MyDomainObject.class) Stream anyStrings;
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	excludes When generating a random type you may want to exclude some properties
int	size When generating a collection of random type you may want to limit its size.
Class<?>	type When generating a collection of random type you'll want to tell the generator what that type is.

Element Detail

excludes

public abstract String[] excludes

When generating a random type you may want to exclude some properties

Returns:

an array of property names to be excluded when generating a random instance of a given type

Default:

"[]"

size

public abstract int size

When generating a collection of random type you may want to limit its size.

Returns:

the desired size of any collections within the randomly generated type

Default:

10

type

public abstract Class<?> type

When generating a collection of random type you'll want to tell the generator what that type is.

Returns:

the type of a randomly generated generic collection

Default:

java.lang.Object.class