io.github.benas.randombeans.api

Interface RandomizerContext

public interface RandomizerContext

A context object for a Randomizer. This interface provides information about the randomization context.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentField() Return the full path to the current field being randomized (starting from the first field in the root type).
java.lang.Object	getCurrentObject() Return the currently randomized object in the object graph.
java.util.Set<java.lang.String>	getExcludedFields() Get the set of excluded fields (varargs of EnhancedRandom.nextObject(Class, String...)).
EnhancedRandomParameters	getParameters() Return the currently used parameters by the enclosing EnhancedRandom.
int	getRandomizationDepth() Get the current level in the hierarchy of the object graph.
java.lang.Object	getRootObject() Return the root object being randomized (instance of getType().
java.lang.Class<?>	getType() Return the target type (first parameter of EnhancedRandom.nextObject(Class, String...)).

Method Detail

getType

java.lang.Class<?> getType()

Return the target type (first parameter of EnhancedRandom.nextObject(Class, String...)).

Returns:

target type

getExcludedFields

java.util.Set<java.lang.String> getExcludedFields()

Get the set of excluded fields (varargs of EnhancedRandom.nextObject(Class, String...)).

Returns:

set of excluded fields

getRootObject

java.lang.Object getRootObject()

Return the root object being randomized (instance of getType().

Returns:

root object being randomized

getCurrentObject

java.lang.Object getCurrentObject()

Return the currently randomized object in the object graph.

Returns:

currently randomized object

getCurrentField

java.lang.String getCurrentField()

Return the full path to the current field being randomized (starting from the first field in the root type).

Returns:

full path to the current field being randomized

getRandomizationDepth

int getRandomizationDepth()

Get the current level in the hierarchy of the object graph.

Returns:

current level in the hierarchy of the object graph.

getParameters

EnhancedRandomParameters getParameters()

Return the currently used parameters by the enclosing EnhancedRandom.

Returns:

currently used parameters