Package net.jqwik.api.sessions

Class JqwikSession

java.lang.Object

net.jqwik.api.sessions.JqwikSession

@API(status=MAINTAINED,
     since="1.8.0")
public class JqwikSession
extends Object

JqwikSession is the abstraction to give users of Arbitrary.sample() and Arbitrary.sampleStream() outside the jqwik lifecycle more control over the lifecycle. This has also influence on memory heap usage since an un-finished session will aggregate state, e.g. through caching and other stores.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JqwikSession.JqwikSessionFacade
static interface	JqwikSession.Runnable

Constructor Summary

Constructors

Constructor	Description
JqwikSession()

Method Summary

Modifier and Type	Method	Description
static void	finish()
static void	finishTry()
static Optional<Random>	getRandom()	Returns the Random instance associated with the current session.
static boolean	isActive()
static void	run(String randomSeed, JqwikSession.Runnable runnable)	Runs a given JqwikSession.Runnable in a new session with a given random seed.
static void	run(JqwikSession.Runnable runnable)
static void	start()
static void	start(String randomSeed)	Starts a new session with a given random seed.

Methods inherited from class java.lang.Object

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

Constructor Details

JqwikSession

public JqwikSession()

Method Details

start

public static void start()

isActive

public static boolean isActive()

finish

public static void finish()

finishTry

public static void finishTry()

run

public static void run(JqwikSession.Runnable runnable)

getRandom

@API(status=EXPERIMENTAL,
     since="1.9.1")
public static Optional<Random> getRandom()

Returns the Random instance associated with the current session.

Returns:

a Random instance if a session is active, otherwise an empty Optional

start

@API(status=EXPERIMENTAL,
     since="1.9.1")
public static void start(String randomSeed)

Starts a new session with a given random seed. Currently seeds must be strings that can be parsed by Long.parseLong(String).

run

@API(status=EXPERIMENTAL,
     since="1.9.1")
public static void run(String randomSeed,
 JqwikSession.Runnable runnable)

Runs a given JqwikSession.Runnable in a new session with a given random seed. Currently seeds must be strings that can be parsed by Long.parseLong(String).