Package net.jqwik.api
Annotation Interface Property
@Target({METHOD,ANNOTATION_TYPE})
@Retention(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.
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionint
The maximum ratio of tried versus actually checked property runs in case you are using Assumptions.Controls how shrinking is done when falsified property is found.int
Tries are the test runs with different parameters.Controls how to behave if aseed()
is present. -
Field Summary
-
Field Details
-
TRIES_NOT_SET
static final int TRIES_NOT_SET- See Also:
-
MAX_DISCARD_RATIO_NOT_SET
static final int MAX_DISCARD_RATIO_NOT_SET- See Also:
-
SEED_NOT_SET
- See Also:
-
STEREOTYPE_NOT_SET
- See Also:
-
-
Element Details
-
tries
int triesTries 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, inProperty
annotation.- Returns:
- number of tries to run
- Default:
- 0
-
maxDiscardRatio
int maxDiscardRatioThe 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
String seed- Default:
- ""
-
shrinking
ShrinkingMode shrinkingControls 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:
- NOT_SET
-
stereotype
String stereotype- Default:
- ""
-
generation
- Default:
- NOT_SET
-
afterFailure
- Default:
- NOT_SET
-
edgeCases
- Default:
- NOT_SET
-
whenFixedSeed
Controls how to behave if aseed()
is present.Default value is the value from the global
jqwik.seeds.whenfixed
configuration property.- Returns:
- the fixed seed mode
- Default:
- NOT_SET
-