Package net.jqwik.api
-
Interface Summary Interface Description Arbitrary<T> The main interface for representing objects that can be generated and shrunk.ArbitrarySupplier<T> Implementations of this class are used to provide single arbitraries forForAllparameters and parameter types annotated withFrom.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> EdgeCases<T> EdgeCases.Config<T> ExhaustiveGenerator<T> 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.RandomDistribution Determines how generated numerical values are generated and distributed across the allowed range and a center withing this range.RandomDistribution.RandomNumericGenerator Generator for BigInteger values which are behind all generated numeric values in jqwik.RandomGenerator<T> Reporter An interface that can be used to report additional information for a test element, i.e. a test container or property.SampleReportingFormat Shrinkable<T> Tuple Typed Tuples are very convenient containers to have, especially in the context of generating dependent values. -
Enum Summary Enum Description AfterFailureMode The after-failure mode determines how a property behaves after it has been falsified.EdgeCasesMode The edge-cases mode determines if and when combined edge-cases of all parameters will be explicitly generated.FixedSeedMode The fixed seed mode determines how jqwik should behave if a property has an explicitProperty.seed()specified.GenerationMode The generation mode defines the generation behaviour of a property.Reporting ShrinkingMode The shrinking mode defines the shrinking behaviour of a property. -
Exception Summary Exception Description CannotFindArbitraryException JqwikException Base exception for exceptions that are thrown during the discovery phase and during setup of properties before they are actually run.TooManyFilterMissesException -
Annotation Types Summary Annotation Type Description Data Used to annotate methods that can provide data points for property methods.Disabled Use@Disabled("reason to disable")to disable test container or test method during normal test execution.Example Use@Exampleto mark methods that are simple, example-based test cases.ForAll Used to annotate method parameters that will be provided by jqwik.From Used to annotate type parameters within property parameters annotated with ForAll .FromData Used to annotate property methods.Group Label Use@Label("a descriptive name")to give test classes, groups and methods a more readable label (aka display name).NonNullApi NullableType This annotation is necessary because Nullable cannot be applied to type usagesProperty Use@Propertyto mark methods that serve as properties.PropertyDefaults Annotate a container class with@PropertyDefaultsif you want to set defaults ofPropertyattributes of all contained property methods.Provide Used to annotate methods that can provide values for property method parameters.Report Use@Reportto specify what additional things should be reported when running a property.Tag 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.TagList