net.jqwik.api

Annotation Type Property

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Testable
 @API(status=STABLE,
     since="1.0")
public @interface Property

Use @Property to mark methods that serve as properties. Those methods usually have one or more parameters annotated with ForAll.

They are executed (tried) several times, either until they fail or until the configured number of tries() has been reached.

Just like methods annotated with Example example, annotated methods must not be private. They can either return Boolean, boolean or void.

For more info, you can have a look at the user guide, optional-property-parameters.

See Also:

Example, ShrinkingMode, GenerationMode, AfterFailureMode, EdgeCasesMode, Data

Field Summary

Fields

Modifier and Type	Fields and Description
static int	MAX_DISCARD_RATIO_NOT_SET
static java.lang.String	SEED_NOT_SET
static java.lang.String	STEREOTYPE_NOT_SET
static int	TRIES_NOT_SET

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AfterFailureMode	afterFailure
EdgeCasesMode	edgeCases
GenerationMode	generation
int	maxDiscardRatio The maximum ratio of tried versus actually checked property runs in case you are using Assumptions.
java.lang.String	seed
ShrinkingMode	shrinking Controls how shrinking is done when falsified property is found.
java.lang.String	stereotype
int	tries Tries are the test runs with different parameters.
FixedSeedMode	whenFixedSeed Controls how to behave if a seed() is present.

Field Detail

TRIES_NOT_SET

public static final int TRIES_NOT_SET

MAX_DISCARD_RATIO_NOT_SET

public static final int MAX_DISCARD_RATIO_NOT_SET

SEED_NOT_SET

public static final java.lang.String SEED_NOT_SET

STEREOTYPE_NOT_SET

public static final java.lang.String STEREOTYPE_NOT_SET

Element Detail

tries

public abstract int tries

Tries are the test runs with different parameters. By default it is 1000. You can override globally in the property file (see jqwik.properties, or here, in Property annotation.

Returns:

number of tries to run

Default:

0

maxDiscardRatio

public abstract int maxDiscardRatio

The maximum ratio of tried versus actually checked property runs in case you are using Assumptions. If the ratio is exceeded jqwik will report this property as a failure.

The default is 5 which can be overridden in jqwik.properties.

Returns:

the maximum ration

Default:

0

seed

public abstract java.lang.String seed

Default:

""

shrinking

public abstract ShrinkingMode shrinking

Controls how shrinking is done when falsified property is found.

Default value is ShrinkingMode.BOUNDED, i.e. shrinking is tried to a depth of 1000 steps maximum per value.

Returns:

the shrinking mode

Default:

net.jqwik.api.ShrinkingMode.NOT_SET

stereotype

public abstract java.lang.String stereotype

Default:

""

generation

@API(status=MAINTAINED,
     since="1.0")
public abstract GenerationMode generation

Default:

net.jqwik.api.GenerationMode.NOT_SET

afterFailure

@API(status=MAINTAINED,
     since="1.0")
public abstract AfterFailureMode afterFailure

Default:

net.jqwik.api.AfterFailureMode.NOT_SET

edgeCases

@API(status=MAINTAINED,
     since="1.8.0")
public abstract EdgeCasesMode edgeCases

Default:

net.jqwik.api.EdgeCasesMode.NOT_SET

whenFixedSeed

@API(status=MAINTAINED,
     since="1.4.0")
public abstract FixedSeedMode whenFixedSeed

Controls how to behave if a seed() is present.

Default value is the value from the global jqwik.seeds.whenfixed configuration property.

Returns:

the fixed seed mode

Default:

net.jqwik.api.FixedSeedMode.NOT_SET