Package net.jqwik.api
package net.jqwik.api
-
ClassDescriptionThe after-failure mode determines how a property behaves after it has been falsified.Arbitrary<T>The main interface for representing objects that can be generated and shrunk.Implementations of this class are used to provide single arbitraries for
ForAllparameters and parameter types annotated withFrom.Provide access to combinators through builder functionality.Functionality to manipulate a builder.Combinators.Combinator2<T1,T2> Combinator for two values.Combinators.Combinator3<T1,T2, T3> Combinator for three values.Combinators.Combinator4<T1,T2, T3, T4> Combinator for four values.Combinators.Combinator5<T1,T2, T3, T4, T5> Combinator for five values.Combinators.Combinator6<T1,T2, T3, T4, T5, T6> Combinator for six values.Combinators.Combinator7<T1,T2, T3, T4, T5, T6, T7> Combinator for seven values.Combinators.Combinator8<T1,T2, T3, T4, T5, T6, T7, T8> Combinator for eight values.Combinators.F2<T1,T2, R> Combinators.F3<T1,T2, T3, R> Combinators.F4<T1,T2, T3, T4, R> Combinators.F5<T1,T2, T3, T4, T5, R> Combinators.F6<T1,T2, T3, T4, T5, T6, R> Combinators.F7<T1,T2, T3, T4, T5, T6, T7, R> Combinators.F8<T1,T2, T3, T4, T5, T6, T7, T8, R> Combinator for any number of values.Used to annotate methods that can provide data points for property methods.Use@Disabled("reason to disable")to disable test container or test method during normal test execution.EdgeCases<T>The edge-cases mode determines if and when combined edge-cases of all parameters will be explicitly generated.Use@Exampleto mark methods that are simple, example-based test cases.Used only internally to run and compute exhaustive generation of parametersFalsifier<T>This interface is no longer used anywhere in jqwik's public API and could therefore be deprecated and moved to engine implementation.The fixed seed mode determines how jqwik should behave if a property has an explicitProperty.seed()specified.Used to annotate method parameters that will be provided by jqwik.Used to annotate type parameters within property parameters annotated with ForAll .Used to annotate property methods.Wraps a function to be generated.The generation mode defines the generation behaviour of a property.Base exception for exceptions that are thrown during the discovery phase and during setup of properties before they are actually run.Use@Label("a descriptive name")to give test classes, groups and methods a more readable label (aka display name).This annotation is necessary because Nullable cannot be applied to type usagesUse@Propertyto mark methods that serve as properties.Annotate a container class with@PropertyDefaultsif you want to set defaults ofPropertyattributes of all contained property methods.Used to annotate methods that can provide values for property method parameters.Determines how generated numerical values are generated and distributed across the allowed range and a center withing this range.Generator for BigInteger values which are behind all generated numeric values in jqwik.Use@Reportto specify what additional things should be reported when running a property.An interface that can be used to report additional information for a test element, i.e. a test container or property.Shrinkable<T>AShrinkingDistanceis a measure of how close a value is to the minimum value, aka target value.The shrinking mode defines the shrinking behaviour of a property.Use@Tag("a tag")to give test classes, groups and methods an (additional) tag which can later be used to select the set of tests to execute.Typed Tuples are very convenient containers to have, especially in the context of generating dependent values.Tuple.Tuple1<T1>Tuple.Tuple2<T1,T2> Tuple.Tuple3<T1,T2, T3> Tuple.Tuple4<T1,T2, T3, T4> Tuple.Tuple5<T1,T2, T3, T4, T5> Tuple.Tuple6<T1,T2, T3, T4, T5, T6> Tuple.Tuple7<T1,T2, T3, T4, T5, T6, T7> Tuple.Tuple8<T1,T2, T3, T4, T5, T6, T7, T8>