From f32110cb5f61e072e7055f5b3eed56b13487ecbf Mon Sep 17 00:00:00 2001 From: Johannes Link Date: Sat, 22 Jun 2019 10:09:15 +0200 Subject: [PATCH] Generated 1.1.6 documentation --- TODO.md | 2 - .../main/java/net/jqwik/api/Functions.java | 2 +- build.gradle | 2 +- docs/_layouts/default.html | 2 +- docs/docs/1.1.6/javadoc/allclasses-frame.html | 155 + .../1.1.6/javadoc/allclasses-noframe.html | 155 + docs/docs/1.1.6/javadoc/constant-values.html | 193 ++ docs/docs/1.1.6/javadoc/deprecated-list.html | 146 + docs/docs/1.1.6/javadoc/help-doc.html | 223 ++ docs/docs/1.1.6/javadoc/index-all.html | 2071 +++++++++++++ docs/docs/1.1.6/javadoc/index.html | 75 + .../net/jqwik/api/AfterFailureMode.html | 403 +++ .../api/Arbitraries.ArbitrariesFacade.html | 644 ++++ .../javadoc/net/jqwik/api/Arbitraries.html | 1134 +++++++ .../jqwik/api/Arbitrary.ArbitraryFacade.html | 343 +++ .../javadoc/net/jqwik/api/Arbitrary.html | 595 ++++ .../1.1.6/javadoc/net/jqwik/api/Assume.html | 272 ++ .../api/CannotFindArbitraryException.html | 286 ++ .../api/Combinators.BuilderCombinator.html | 254 ++ .../api/Combinators.CombinableBuilder.html | 241 ++ .../jqwik/api/Combinators.Combinator2.html | 252 ++ .../jqwik/api/Combinators.Combinator3.html | 252 ++ .../jqwik/api/Combinators.Combinator4.html | 252 ++ .../jqwik/api/Combinators.Combinator5.html | 252 ++ .../jqwik/api/Combinators.Combinator6.html | 252 ++ .../jqwik/api/Combinators.Combinator7.html | 252 ++ .../jqwik/api/Combinators.Combinator8.html | 252 ++ .../api/Combinators.CombinatorsFacade.html | 291 ++ .../javadoc/net/jqwik/api/Combinators.F2.html | 233 ++ .../javadoc/net/jqwik/api/Combinators.F3.html | 235 ++ .../javadoc/net/jqwik/api/Combinators.F4.html | 237 ++ .../javadoc/net/jqwik/api/Combinators.F5.html | 239 ++ .../javadoc/net/jqwik/api/Combinators.F6.html | 241 ++ .../javadoc/net/jqwik/api/Combinators.F7.html | 243 ++ .../javadoc/net/jqwik/api/Combinators.F8.html | 245 ++ .../jqwik/api/Combinators.ListCombinator.html | 252 ++ .../javadoc/net/jqwik/api/Combinators.html | 578 ++++ .../1.1.6/javadoc/net/jqwik/api/Data.html | 222 ++ .../1.1.6/javadoc/net/jqwik/api/Disabled.html | 223 ++ .../1.1.6/javadoc/net/jqwik/api/Example.html | 180 ++ ...veGenerator.ExhaustiveGeneratorFacade.html | 334 ++ .../net/jqwik/api/ExhaustiveGenerator.html | 340 ++ .../javadoc/net/jqwik/api/FacadeLoader.html | 284 ++ .../jqwik/api/FalsificationResult.Status.html | 355 +++ .../net/jqwik/api/FalsificationResult.html | 410 +++ .../javadoc/net/jqwik/api/Falsifier.html | 267 ++ .../1.1.6/javadoc/net/jqwik/api/ForAll.html | 229 ++ .../1.1.6/javadoc/net/jqwik/api/FromData.html | 224 ++ .../jqwik/api/Functions.FunctionWrapper.html | 255 ++ .../jqwik/api/Functions.FunctionsFacade.html | 289 ++ .../javadoc/net/jqwik/api/Functions.html | 275 ++ .../javadoc/net/jqwik/api/GenerationMode.html | 405 +++ .../1.1.6/javadoc/net/jqwik/api/Group.html | 167 + .../javadoc/net/jqwik/api/JqwikException.html | 289 ++ .../1.1.6/javadoc/net/jqwik/api/Label.html | 222 ++ .../1.1.6/javadoc/net/jqwik/api/Property.html | 444 +++ .../1.1.6/javadoc/net/jqwik/api/Provide.html | 222 ++ ...RandomGenerator.RandomGeneratorFacade.html | 374 +++ .../net/jqwik/api/RandomGenerator.html | 382 +++ .../1.1.6/javadoc/net/jqwik/api/Report.html | 220 ++ .../javadoc/net/jqwik/api/Reporting.html | 354 +++ .../api/Shrinkable.ShrinkableFacade.html | 325 ++ .../javadoc/net/jqwik/api/Shrinkable.html | 361 +++ .../net/jqwik/api/ShrinkingDistance.html | 398 +++ .../javadoc/net/jqwik/api/ShrinkingMode.html | 371 +++ ...nkingSequence.ShrinkingSequenceFacade.html | 319 ++ .../net/jqwik/api/ShrinkingSequence.html | 321 ++ .../api/Statistics.StatisticsFacade.html | 273 ++ .../javadoc/net/jqwik/api/Statistics.html | 302 ++ .../1.1.6/javadoc/net/jqwik/api/Table.html | 377 +++ .../docs/1.1.6/javadoc/net/jqwik/api/Tag.html | 237 ++ .../1.1.6/javadoc/net/jqwik/api/TagList.html | 214 ++ .../api/TooManyFilterMissesException.html | 272 ++ .../javadoc/net/jqwik/api/Tuple.Tuple1.html | 359 +++ .../javadoc/net/jqwik/api/Tuple.Tuple2.html | 374 +++ .../javadoc/net/jqwik/api/Tuple.Tuple3.html | 386 +++ .../javadoc/net/jqwik/api/Tuple.Tuple4.html | 398 +++ .../javadoc/net/jqwik/api/Tuple.Tuple5.html | 410 +++ .../javadoc/net/jqwik/api/Tuple.Tuple6.html | 422 +++ .../javadoc/net/jqwik/api/Tuple.Tuple7.html | 434 +++ .../javadoc/net/jqwik/api/Tuple.Tuple8.html | 442 +++ .../1.1.6/javadoc/net/jqwik/api/Tuple.html | 466 +++ .../api/arbitraries/BigDecimalArbitrary.html | 320 ++ .../api/arbitraries/BigIntegerArbitrary.html | 304 ++ .../jqwik/api/arbitraries/ByteArbitrary.html | 304 ++ .../api/arbitraries/CharacterArbitrary.html | 375 +++ .../api/arbitraries/DoubleArbitrary.html | 320 ++ .../jqwik/api/arbitraries/FloatArbitrary.html | 320 ++ .../api/arbitraries/IntegerArbitrary.html | 304 ++ .../jqwik/api/arbitraries/LongArbitrary.html | 304 ++ .../jqwik/api/arbitraries/ShortArbitrary.html | 304 ++ .../api/arbitraries/SizableArbitrary.html | 288 ++ .../api/arbitraries/StringArbitrary.html | 414 +++ .../jqwik/api/arbitraries/TypeArbitrary.html | 409 +++ .../jqwik/api/arbitraries/package-frame.html | 31 + .../api/arbitraries/package-summary.html | 209 ++ .../jqwik/api/arbitraries/package-tree.html | 146 + .../ArbitraryConfigurationException.html | 232 ++ .../configurators/ArbitraryConfigurator.html | 288 ++ .../ArbitraryConfiguratorBase.html | 334 ++ .../SelfConfiguringArbitrary.html | 249 ++ .../api/configurators/package-frame.html | 29 + .../api/configurators/package-summary.html | 187 ++ .../jqwik/api/configurators/package-tree.html | 161 + .../net/jqwik/api/constraints/AlphaChars.html | 178 ++ .../net/jqwik/api/constraints/BigRange.html | 251 ++ .../net/jqwik/api/constraints/ByteRange.html | 251 ++ .../net/jqwik/api/constraints/CharRange.html | 263 ++ .../jqwik/api/constraints/CharRangeList.html | 214 ++ .../net/jqwik/api/constraints/Chars.html | 227 ++ .../net/jqwik/api/constraints/CharsList.html | 214 ++ .../jqwik/api/constraints/DoubleRange.html | 251 ++ .../net/jqwik/api/constraints/FloatRange.html | 251 ++ .../net/jqwik/api/constraints/IntRange.html | 251 ++ .../net/jqwik/api/constraints/LongRange.html | 251 ++ .../net/jqwik/api/constraints/LowerChars.html | 178 ++ .../net/jqwik/api/constraints/Negative.html | 174 ++ .../net/jqwik/api/constraints/NotEmpty.html | 178 ++ .../jqwik/api/constraints/NumericChars.html | 179 ++ .../net/jqwik/api/constraints/Positive.html | 174 ++ .../net/jqwik/api/constraints/Scale.html | 222 ++ .../net/jqwik/api/constraints/ShortRange.html | 251 ++ .../net/jqwik/api/constraints/Size.html | 265 ++ .../jqwik/api/constraints/StringLength.html | 265 ++ .../net/jqwik/api/constraints/Unique.html | 175 ++ .../net/jqwik/api/constraints/UpperChars.html | 180 ++ .../net/jqwik/api/constraints/UseType.html | 234 ++ .../jqwik/api/constraints/UseTypeMode.html | 380 +++ .../net/jqwik/api/constraints/Whitespace.html | 178 ++ .../net/jqwik/api/constraints/WithNull.html | 227 ++ .../jqwik/api/constraints/package-frame.html | 48 + .../api/constraints/package-summary.html | 300 ++ .../jqwik/api/constraints/package-tree.html | 167 + .../domains/AbstractDomainContextBase.html | 397 +++ .../javadoc/net/jqwik/api/domains/Domain.html | 299 ++ .../DomainContext.DomainContextFacade.html | 274 ++ .../api/domains/DomainContext.Global.html | 323 ++ .../net/jqwik/api/domains/DomainContext.html | 299 ++ .../net/jqwik/api/domains/DomainList.html | 214 ++ .../net/jqwik/api/domains/package-frame.html | 31 + .../jqwik/api/domains/package-summary.html | 194 ++ .../net/jqwik/api/domains/package-tree.html | 146 + .../jqwik/api/lifecycle/AddLifecycleHook.html | 215 ++ .../api/lifecycle/AroundPropertyHook.html | 333 ++ .../lifecycle/ContainerLifecycleContext.html | 194 ++ .../jqwik/api/lifecycle/LifecycleContext.html | 239 ++ .../jqwik/api/lifecycle/LifecycleHook.html | 238 ++ .../jqwik/api/lifecycle/LifecycleHooks.html | 214 ++ .../PropertyExecutionResult.Status.html | 371 +++ .../lifecycle/PropertyExecutionResult.html | 373 +++ .../jqwik/api/lifecycle/PropertyExecutor.html | 227 ++ .../lifecycle/PropertyLifecycleContext.html | 260 ++ .../SkipExecutionHook.SkipResult.html | 307 ++ .../api/lifecycle/SkipExecutionHook.html | 314 ++ .../jqwik/api/lifecycle/package-frame.html | 40 + .../jqwik/api/lifecycle/package-summary.html | 239 ++ .../net/jqwik/api/lifecycle/package-tree.html | 173 ++ .../javadoc/net/jqwik/api/package-frame.html | 99 + .../net/jqwik/api/package-summary.html | 491 +++ .../javadoc/net/jqwik/api/package-tree.html | 276 ++ .../ArbitraryProvider.SubtypeProvider.html | 200 ++ .../api/providers/ArbitraryProvider.html | 308 ++ .../providers/TypeUsage.TypeUsageFacade.html | 302 ++ .../net/jqwik/api/providers/TypeUsage.html | 593 ++++ .../jqwik/api/providers/package-frame.html | 26 + .../jqwik/api/providers/package-summary.html | 168 + .../net/jqwik/api/providers/package-tree.html | 145 + .../net/jqwik/api/stateful/Action.html | 263 ++ .../api/stateful/ActionSequence.RunState.html | 367 +++ .../jqwik/api/stateful/ActionSequence.html | 299 ++ .../api/stateful/ActionSequenceArbitrary.html | 298 ++ .../net/jqwik/api/stateful/Invariant.html | 228 ++ .../net/jqwik/api/stateful/package-frame.html | 27 + .../jqwik/api/stateful/package-summary.html | 171 ++ .../net/jqwik/api/stateful/package-tree.html | 154 + docs/docs/1.1.6/javadoc/overview-frame.html | 28 + docs/docs/1.1.6/javadoc/overview-summary.html | 164 + docs/docs/1.1.6/javadoc/overview-tree.html | 369 +++ docs/docs/1.1.6/javadoc/package-list | 8 + docs/docs/1.1.6/javadoc/script.js | 30 + docs/docs/1.1.6/javadoc/serialized-form.html | 287 ++ docs/docs/1.1.6/javadoc/stylesheet.css | 574 ++++ docs/docs/1.1.6/user-guide.md | 2730 +++++++++++++++++ docs/docs/current/javadoc/index.html | 4 +- docs/docs/current/user-guide.md | 324 +- docs/release-notes.md | 12 +- 186 files changed, 53081 insertions(+), 170 deletions(-) create mode 100644 docs/docs/1.1.6/javadoc/allclasses-frame.html create mode 100644 docs/docs/1.1.6/javadoc/allclasses-noframe.html create mode 100644 docs/docs/1.1.6/javadoc/constant-values.html create mode 100644 docs/docs/1.1.6/javadoc/deprecated-list.html create mode 100644 docs/docs/1.1.6/javadoc/help-doc.html create mode 100644 docs/docs/1.1.6/javadoc/index-all.html create mode 100644 docs/docs/1.1.6/javadoc/index.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/AfterFailureMode.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.ArbitrariesFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.ArbitraryFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Assume.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/CannotFindArbitraryException.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.BuilderCombinator.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinableBuilder.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator2.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator3.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator4.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator5.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator6.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator7.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator8.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinatorsFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F2.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F3.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F4.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F5.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F6.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F7.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F8.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.ListCombinator.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Data.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Example.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.ExhaustiveGeneratorFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/FacadeLoader.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.Status.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Falsifier.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/FromData.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionWrapper.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionsFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/GenerationMode.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Group.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/JqwikException.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Label.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Property.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Provide.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.RandomGeneratorFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Report.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Reporting.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.ShrinkableFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingDistance.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingMode.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.ShrinkingSequenceFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.StatisticsFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Table.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tag.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/TagList.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/TooManyFilterMissesException.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple1.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple2.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple3.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple4.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple5.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple6.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple7.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple8.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurationException.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfiguratorBase.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/SelfConfiguringArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRangeList.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharsList.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/Domain.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.DomainContextFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.Global.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainList.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AddLifecycleHook.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AroundPropertyHook.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/ContainerLifecycleContext.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleContext.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHook.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHooks.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.Status.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutor.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyLifecycleContext.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.SkipResult.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.SubtypeProvider.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.TypeUsageFacade.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Action.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.RunState.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequenceArbitrary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Invariant.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-frame.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-summary.html create mode 100644 docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-tree.html create mode 100644 docs/docs/1.1.6/javadoc/overview-frame.html create mode 100644 docs/docs/1.1.6/javadoc/overview-summary.html create mode 100644 docs/docs/1.1.6/javadoc/overview-tree.html create mode 100644 docs/docs/1.1.6/javadoc/package-list create mode 100644 docs/docs/1.1.6/javadoc/script.js create mode 100644 docs/docs/1.1.6/javadoc/serialized-form.html create mode 100644 docs/docs/1.1.6/javadoc/stylesheet.css create mode 100644 docs/docs/1.1.6/user-guide.md diff --git a/TODO.md b/TODO.md index 0233e4fd9..8a0b540f9 100644 --- a/TODO.md +++ b/TODO.md @@ -1,7 +1,5 @@ - 1.1.6 - - Generate documentation - - Release - 1.2.0 diff --git a/api/src/main/java/net/jqwik/api/Functions.java b/api/src/main/java/net/jqwik/api/Functions.java index 71f57ae36..f1678f2da 100644 --- a/api/src/main/java/net/jqwik/api/Functions.java +++ b/api/src/main/java/net/jqwik/api/Functions.java @@ -5,7 +5,7 @@ import static org.apiguardian.api.API.Status.*; -@API(status = EXPERIMENTAL, since = "1.1.6") +@API(status = EXPERIMENTAL, since = "1.2.0") public class Functions { @API(status = INTERNAL) diff --git a/build.gradle b/build.gradle index 5dd335f78..3dd08856e 100644 --- a/build.gradle +++ b/build.gradle @@ -2,7 +2,7 @@ ext { junitPlatformVersion = '1.4.2' junitJupiterVersion = '5.4.2' moduleName = 'net.jqwik' - jqwikVersion = '1.1.6-SNAPSHOT' + jqwikVersion = '1.1.6' } allprojects { diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index d8a1575a7..facef4d73 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -22,7 +22,7 @@ View on GitHub

{{ site.title | default: site.github.repository_name }} - Latest Release: 1.1.5 + Latest Release: 1.1.6

Property-Based Testing in Java

diff --git a/docs/docs/1.1.6/javadoc/allclasses-frame.html b/docs/docs/1.1.6/javadoc/allclasses-frame.html new file mode 100644 index 000000000..d5e409d26 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/allclasses-frame.html @@ -0,0 +1,155 @@ + + + + + +All Classes (documentation 1.1.6 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/allclasses-noframe.html b/docs/docs/1.1.6/javadoc/allclasses-noframe.html new file mode 100644 index 000000000..a6a8cb730 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/allclasses-noframe.html @@ -0,0 +1,155 @@ + + + + + +All Classes (documentation 1.1.6 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/constant-values.html b/docs/docs/1.1.6/javadoc/constant-values.html new file mode 100644 index 000000000..f6d615afc --- /dev/null +++ b/docs/docs/1.1.6/javadoc/constant-values.html @@ -0,0 +1,193 @@ + + + + + +Constant Field Values (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

net.jqwik.*

+ + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/deprecated-list.html b/docs/docs/1.1.6/javadoc/deprecated-list.html new file mode 100644 index 000000000..74c87802b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/deprecated-list.html @@ -0,0 +1,146 @@ + + + + + +Deprecated List (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/help-doc.html b/docs/docs/1.1.6/javadoc/help-doc.html new file mode 100644 index 000000000..18f99db48 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/index-all.html b/docs/docs/1.1.6/javadoc/index-all.html new file mode 100644 index 000000000..006e7acf8 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/index-all.html @@ -0,0 +1,2071 @@ + + + + + +Index (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C D E F G H I J L M N O P R S T U V W  + + +

A

+
+
aborted(Throwable, String) - Static method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
AbstractDomainContextBase - Class in net.jqwik.api.domains
+
+
Subclass for easier implementation of DomainContext
+
+
AbstractDomainContextBase() - Constructor for class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
acceptTargetType(TypeUsage) - Method in class net.jqwik.api.configurators.ArbitraryConfiguratorBase
+
+
Override if configurator only works for certain types of domain objects
+
+
Action<M> - Interface in net.jqwik.api.stateful
+
+
An action class represents a state change that can be preformed on a model M.
+
+
ActionSequence<M> - Interface in net.jqwik.api.stateful
+
+
A sequence of Actions that can be run with a model of type M
+
+
ActionSequence.RunState - Enum in net.jqwik.api.stateful
+
 
+
ActionSequenceArbitrary<M> - Interface in net.jqwik.api.stateful
+
 
+
AddLifecycleHook - Annotation Type in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
AfterFailureMode - Enum in net.jqwik.api
+
+
The after-failure mode determines how a property behaves after it has been falsified.
+
+
all() - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all unicode chars to show up in generated values.
+
+
all() - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all unicode chars even noncharacters and private use characters + but only in plane 0 (aka Basic Multilingual Plane)
+
+
allValues() - Method in interface net.jqwik.api.Arbitrary
+
+
Create optional stream of all possible values this arbitrary could generate.
+
+
alpha() - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all alpha chars to show up in generated strings.
+
+
AlphaChars - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to upper and lower case chars.
+
+
andThen(Function<Shrinkable<T>, ShrinkingSequence<T>>) - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
andThen(ShrinkingSequence<T>, Function<Shrinkable<T>, ShrinkingSequence<T>>) - Method in class net.jqwik.api.ShrinkingSequence.ShrinkingSequenceFacade
+
 
+
annotatedElement() - Method in interface net.jqwik.api.lifecycle.LifecycleContext
+
 
+
append(ShrinkingDistance) - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
apply(T1, T2) - Method in interface net.jqwik.api.Combinators.F2
+
 
+
apply(T1, T2, T3) - Method in interface net.jqwik.api.Combinators.F3
+
 
+
apply(T1, T2, T3, T4) - Method in interface net.jqwik.api.Combinators.F4
+
 
+
apply(T1, T2, T3, T4, T5) - Method in interface net.jqwik.api.Combinators.F5
+
 
+
apply(T1, T2, T3, T4, T5, T6) - Method in interface net.jqwik.api.Combinators.F6
+
 
+
apply(T1, T2, T3, T4, T5, T6, T7) - Method in interface net.jqwik.api.Combinators.F7
+
 
+
apply(T1, T2, T3, T4, T5, T6, T7, T8) - Method in interface net.jqwik.api.Combinators.F8
+
 
+
Arbitraries - Class in net.jqwik.api
+
 
+
Arbitraries.ArbitrariesFacade - Class in net.jqwik.api
+
 
+
ArbitrariesFacade() - Constructor for class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
Arbitrary<T> - Interface in net.jqwik.api
+
+
The main interface for representing objects that can be generated and shrunk.
+
+
Arbitrary.ArbitraryFacade - Class in net.jqwik.api
+
 
+
ArbitraryConfigurationException - Exception in net.jqwik.api.configurators
+
 
+
ArbitraryConfigurator - Interface in net.jqwik.api.configurators
+
+
Implementors can modify any arbitrary before it's being used for value generation.
+
+
ArbitraryConfiguratorBase - Class in net.jqwik.api.configurators
+
+
Using this base class is the easiest way to make use of the configuration mechanism + described in ArbitraryConfigurator + + + Implementations must be registered in /META-INF/services/net.jqwik.api.configurators.ArbitraryConfigurator + so that they will be automatically considered for arbitrary configuration.
+
+
ArbitraryConfiguratorBase() - Constructor for class net.jqwik.api.configurators.ArbitraryConfiguratorBase
+
 
+
ArbitraryFacade() - Constructor for class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
ArbitraryProvider - Interface in net.jqwik.api.providers
+
+
Implementation of this class are used to provide default arbitraries to + ForAll parameters without an explicit provider reference.
+
+
ArbitraryProvider.SubtypeProvider - Interface in net.jqwik.api.providers
+
 
+
around(AroundPropertyHook) - Method in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
aroundProperty(PropertyLifecycleContext, PropertyExecutor) - Method in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
AroundPropertyHook - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
aroundPropertyProximity() - Method in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
array(Arbitrary<T>, Class<A>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
array(Class<A>) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type T[] using the existing arbitrary for generating the elements of the array.
+
+
as(Combinators.F2<T1, T2, R>) - Method in class net.jqwik.api.Combinators.Combinator2
+
 
+
as(Combinators.F3<T1, T2, T3, R>) - Method in class net.jqwik.api.Combinators.Combinator3
+
 
+
as(Combinators.F4<T1, T2, T3, T4, R>) - Method in class net.jqwik.api.Combinators.Combinator4
+
 
+
as(Combinators.F5<T1, T2, T3, T4, T5, R>) - Method in class net.jqwik.api.Combinators.Combinator5
+
 
+
as(Combinators.F6<T1, T2, T3, T4, T5, T6, R>) - Method in class net.jqwik.api.Combinators.Combinator6
+
 
+
as(Combinators.F7<T1, T2, T3, T4, T5, T6, T7, R>) - Method in class net.jqwik.api.Combinators.Combinator7
+
 
+
as(Combinators.F8<T1, T2, T3, T4, T5, T6, T7, T8, R>) - Method in class net.jqwik.api.Combinators.Combinator8
+
 
+
as(Function<List<T>, R>) - Method in class net.jqwik.api.Combinators.ListCombinator
+
 
+
ascii() - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all ascii chars to show up in generated values.
+
+
ascii() - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all ascii chars to show up in generated strings.
+
+
Assume - Class in net.jqwik.api
+
 
+
+ + + +

B

+
+
BASE - Static variable in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
between(BigDecimal, BigDecimal) - Method in interface net.jqwik.api.arbitraries.BigDecimalArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
between(BigInteger, BigInteger) - Method in interface net.jqwik.api.arbitraries.BigIntegerArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
between(byte, byte) - Method in interface net.jqwik.api.arbitraries.ByteArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounds of generated numbers.
+
+
between(char, char) - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Deprecated. +
Use CharacterArbitrary.range(char, char) instead.
+
+
+
between(double, double) - Method in interface net.jqwik.api.arbitraries.DoubleArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
between(float, float) - Method in interface net.jqwik.api.arbitraries.FloatArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
between(int, int) - Method in interface net.jqwik.api.arbitraries.IntegerArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
between(long, long) - Method in interface net.jqwik.api.arbitraries.LongArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounds of generated numbers.
+
+
between(short, short) - Method in interface net.jqwik.api.arbitraries.ShortArbitrary
+
+
Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
+
+
BigDecimalArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of BigDecimal values.
+
+
bigDecimals() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
bigDecimals() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type BigDecimal.
+
+
BigIntegerArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of BigInteger values.
+
+
bigIntegers() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
bigIntegers() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type BigInteger.
+
+
BigRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated "Big" number.
+
+
build(Function<B, T>) - Method in class net.jqwik.api.Combinators.BuilderCombinator
+
 
+
ByteArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Byte and byte values.
+
+
ByteRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated byte or Byte parameters.
+
+
bytes() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
bytes() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Byte.
+
+
+ + + +

C

+
+
canBeAssignedTo(TypeUsage) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Check if an instance can be assigned to another TypeUsage instance.
+
+
CannotFindArbitraryException - Exception in net.jqwik.api
+
 
+
CannotFindArbitraryException(TypeUsage) - Constructor for exception net.jqwik.api.CannotFindArbitraryException
+
 
+
CannotFindArbitraryException(TypeUsage, ForAll) - Constructor for exception net.jqwik.api.CannotFindArbitraryException
+
 
+
canProvideFor(TypeUsage) - Method in interface net.jqwik.api.providers.ArbitraryProvider
+
+
Return true if the provider is suitable for targetType
+
+
CharacterArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Character and char values.
+
+
CharRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to chars in the range + from from to to.
+
+
CharRangeList - Annotation Type in net.jqwik.api.constraints
+
 
+
chars() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
chars() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Character.
+
+
Chars - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to chars + contained in value.
+
+
CharsList - Annotation Type in net.jqwik.api.constraints
+
 
+
check(T) - Method in interface net.jqwik.api.stateful.Invariant
+
 
+
collect(Predicate<List<T>>) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type List<T> by adding elements of type T until condition until is fulfilled.
+
+
collect(Predicate<List<T>>) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
collect(RandomGenerator<T>, Predicate<List<T>>) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
collect(Object...) - Static method in class net.jqwik.api.Statistics
+
+
Call this method to record an entry for statistical data about generated values.
+
+
collect(Object...) - Method in class net.jqwik.api.Statistics.StatisticsFacade
+
 
+
Combinators - Class in net.jqwik.api
+
 
+
Combinators.BuilderCombinator<B> - Class in net.jqwik.api
+
 
+
Combinators.CombinableBuilder<B,T> - Class in net.jqwik.api
+
 
+
Combinators.Combinator2<T1,T2> - Class in net.jqwik.api
+
 
+
Combinators.Combinator3<T1,T2,T3> - Class in net.jqwik.api
+
 
+
Combinators.Combinator4<T1,T2,T3,T4> - Class in net.jqwik.api
+
 
+
Combinators.Combinator5<T1,T2,T3,T4,T5> - Class in net.jqwik.api
+
 
+
Combinators.Combinator6<T1,T2,T3,T4,T5,T6> - Class in net.jqwik.api
+
 
+
Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7> - Class in net.jqwik.api
+
 
+
Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8> - Class in net.jqwik.api
+
 
+
Combinators.CombinatorsFacade - Class in net.jqwik.api
+
 
+
Combinators.F2<T1,T2,R> - Interface in net.jqwik.api
+
 
+
Combinators.F3<T1,T2,T3,R> - Interface in net.jqwik.api
+
 
+
Combinators.F4<T1,T2,T3,T4,R> - Interface in net.jqwik.api
+
 
+
Combinators.F5<T1,T2,T3,T4,T5,R> - Interface in net.jqwik.api
+
 
+
Combinators.F6<T1,T2,T3,T4,T5,T6,R> - Interface in net.jqwik.api
+
 
+
Combinators.F7<T1,T2,T3,T4,T5,T6,T7,R> - Interface in net.jqwik.api
+
 
+
Combinators.F8<T1,T2,T3,T4,T5,T6,T7,T8,R> - Interface in net.jqwik.api
+
 
+
Combinators.ListCombinator<T> - Class in net.jqwik.api
+
 
+
CombinatorsFacade() - Constructor for class net.jqwik.api.Combinators.CombinatorsFacade
+
 
+
combine(Arbitrary<T1>, Arbitrary<T2>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 2 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 3 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>, Arbitrary<T4>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 4 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>, Arbitrary<T4>, Arbitrary<T5>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 5 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>, Arbitrary<T4>, Arbitrary<T5>, Arbitrary<T6>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 6 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>, Arbitrary<T4>, Arbitrary<T5>, Arbitrary<T6>, Arbitrary<T7>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 7 arbitraries into one.
+
+
combine(Arbitrary<T1>, Arbitrary<T2>, Arbitrary<T3>, Arbitrary<T4>, Arbitrary<T5>, Arbitrary<T6>, Arbitrary<T7>, Arbitrary<T8>) - Static method in class net.jqwik.api.Combinators
+
+
Combine 8 arbitraries into one.
+
+
combine(List<Arbitrary<T>>) - Static method in class net.jqwik.api.Combinators
+
+
Combine a list of arbitraries into one.
+
+
combine(List<AroundPropertyHook>) - Static method in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
combine(List<SkipExecutionHook>) - Static method in interface net.jqwik.api.lifecycle.SkipExecutionHook
+
 
+
combine(List<Shrinkable<T>>) - Static method in class net.jqwik.api.ShrinkingDistance
+
 
+
combineExhaustive(List<Arbitrary<Object>>, Function<List<Object>, R>) - Method in class net.jqwik.api.Combinators.CombinatorsFacade
+
 
+
combineShrinkables(List<Shrinkable<Object>>, Function<List<Object>, R>) - Method in class net.jqwik.api.Combinators.CombinatorsFacade
+
 
+
compareTo(ArbitraryConfigurator) - Method in interface net.jqwik.api.configurators.ArbitraryConfigurator
+
 
+
compareTo(FalsificationResult<T>) - Method in class net.jqwik.api.FalsificationResult
+
 
+
compareTo(AroundPropertyHook) - Method in interface net.jqwik.api.lifecycle.AroundPropertyHook
+
 
+
compareTo(SkipExecutionHook) - Method in interface net.jqwik.api.lifecycle.SkipExecutionHook
+
 
+
compareTo(Shrinkable<T>) - Method in interface net.jqwik.api.Shrinkable
+
 
+
compareTo(ShrinkingDistance) - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
configure(Arbitrary<T>, TypeUsage) - Method in interface net.jqwik.api.configurators.ArbitraryConfigurator
+
+
Configure a given arbitrary and return the configured instance.
+
+
configure(Arbitrary<T>, TypeUsage) - Method in class net.jqwik.api.configurators.ArbitraryConfiguratorBase
+
 
+
configure(ArbitraryConfigurator, TypeUsage) - Method in interface net.jqwik.api.configurators.SelfConfiguringArbitrary
+
+
Do all configuration yourself or delegate to ArbitraryConfigurator.configure(Arbitrary, TypeUsage) + of the configurator that's being handed in.
+
+
configure(Function<String, Optional<String>>) - Method in interface net.jqwik.api.lifecycle.LifecycleHook
+
 
+
constant(T) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will always generate the same value.
+
+
constantFunction(Class<?>, Arbitrary<?>) - Method in class net.jqwik.api.Functions.FunctionsFacade
+
 
+
containedIn(Reporting[]) - Method in enum net.jqwik.api.Reporting
+
 
+
containerClass() - Method in interface net.jqwik.api.lifecycle.PropertyLifecycleContext
+
 
+
ContainerLifecycleContext - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
create(Supplier<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will use a supplier to generate a value.
+
+
current() - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
+ + + +

D

+
+
Data - Annotation Type in net.jqwik.api
+
+
Used to annotate methods that can provide data points for property methods.
+
+
DEFAULT_STEREOTYPE - Static variable in annotation type net.jqwik.api.Property
+
 
+
defaultFor(Class<T>, Class<?>[]) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
defaultFor(TypeUsage) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
defaultFor(Class<T>, Class<?>...) - Static method in class net.jqwik.api.Arbitraries
+
+
Find a registered arbitrary that will be used to generate values of type T.
+
+
defaultFor(TypeUsage) - Static method in class net.jqwik.api.Arbitraries
+
+
Find a registered arbitrary that will be used to generate values of type T.
+
+
digit() - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all numeric chars (digits) to show up in generated values.
+
+
dimensions() - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
Disabled - Annotation Type in net.jqwik.api
+
+
Use @Disabled("reason to disable") to disable test container or test method + during normal test execution.
+
+
distance() - Method in class net.jqwik.api.FalsificationResult
+
 
+
distance() - Method in interface net.jqwik.api.Shrinkable
+
 
+
Domain - Annotation Type in net.jqwik.api.domains
+
+
Use @Domain(MyDomainContext.class) to use only + arbitrary providers and + arbitrary configurators + defined in given context class + + You can have many domains on the same element.
+
+
DomainContext - Interface in net.jqwik.api.domains
+
+
Class that implement this interface are used to annotate property methods or containers like this: + Domain(MyDomainContext.class).
+
+
DomainContext.DomainContextFacade - Class in net.jqwik.api.domains
+
 
+
DomainContext.Global - Class in net.jqwik.api.domains
+
 
+
DomainContextFacade() - Constructor for class net.jqwik.api.domains.DomainContext.DomainContextFacade
+
 
+
DomainList - Annotation Type in net.jqwik.api.domains
+
 
+
doNotSkip() - Static method in class net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult
+
 
+
dontShrink(Shrinkable<T>) - Static method in interface net.jqwik.api.ShrinkingSequence
+
 
+
dontShrink(Shrinkable<T>) - Method in class net.jqwik.api.ShrinkingSequence.ShrinkingSequenceFacade
+
 
+
DoubleArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Double and double values.
+
+
DoubleRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated double or Double parameters.
+
+
doubles() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
doubles() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Double.
+
+
+ + + +

E

+
+
ensureFunctionalType(Class<?>) - Method in class net.jqwik.api.Functions.FunctionsFacade
+
 
+
equals(Object) - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
equals(Object) - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
Example - Annotation Type in net.jqwik.api
+
+
Use @Example to mark methods that are simple, example-based + test cases.
+
+
execute() - Method in interface net.jqwik.api.lifecycle.PropertyExecutor
+
 
+
exhaustive() - Method in interface net.jqwik.api.Arbitrary
+
+
Create the exhaustive generator for an arbitrary
+
+
exhaustiveChoose(List<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
exhaustiveChoose(char[]) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
exhaustiveChoose(Class<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
exhaustiveCreate(Supplier<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
ExhaustiveGenerator<T> - Interface in net.jqwik.api
+
 
+
ExhaustiveGenerator.ExhaustiveGeneratorFacade - Class in net.jqwik.api
+
 
+
ExhaustiveGeneratorFacade() - Constructor for class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
exhaustiveShuffle(List<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
+ + + +

F

+
+
FacadeLoader - Class in net.jqwik.api
+
 
+
FacadeLoader() - Constructor for class net.jqwik.api.FacadeLoader
+
 
+
failed(Throwable, String, List<Object>) - Static method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
FalsificationResult<T> - Class in net.jqwik.api
+
 
+
FalsificationResult.Status - Enum in net.jqwik.api
+
 
+
falsified(Shrinkable<T>) - Static method in class net.jqwik.api.FalsificationResult
+
 
+
falsified(Shrinkable<T>, Throwable) - Static method in class net.jqwik.api.FalsificationResult
+
 
+
Falsifier<T> - Interface in net.jqwik.api
+
 
+
falsify(Shrinkable<T>) - Method in interface net.jqwik.api.Falsifier
+
 
+
filter(Predicate<T>) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but only allows + values that are accepted by the filterPredicate.
+
+
filter(ExhaustiveGenerator<T>, Predicate<T>) - Method in class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
filter(Predicate<T>) - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
filter(Predicate<T>) - Method in class net.jqwik.api.FalsificationResult
+
 
+
filter(Predicate<T>) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
filter(RandomGenerator<T>, Predicate<T>) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
filter(Predicate<T>) - Method in interface net.jqwik.api.Shrinkable
+
 
+
filter(Shrinkable<T>, Predicate<T>) - Method in class net.jqwik.api.Shrinkable.ShrinkableFacade
+
 
+
filtered(Shrinkable<T>) - Static method in class net.jqwik.api.FalsificationResult
+
 
+
finalModel() - Method in interface net.jqwik.api.stateful.ActionSequence
+
 
+
findAnnotation(Class<A>) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return an Optional of the first instance of a specific annotationType + if there is one (directly or indirectly through meta-annotations).
+
+
fixGenSize(int) - Method in interface net.jqwik.api.Arbitrary
+
+
Fix the genSize of an arbitrary so that it can no longer be influenced from outside
+
+
flatAs(Combinators.F2<T1, T2, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator2
+
 
+
flatAs(Combinators.F3<T1, T2, T3, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator3
+
 
+
flatAs(Combinators.F4<T1, T2, T3, T4, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator4
+
 
+
flatAs(Combinators.F5<T1, T2, T3, T4, T5, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator5
+
 
+
flatAs(Combinators.F6<T1, T2, T3, T4, T5, T6, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator6
+
 
+
flatAs(Combinators.F7<T1, T2, T3, T4, T5, T6, T7, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator7
+
 
+
flatAs(Combinators.F8<T1, T2, T3, T4, T5, T6, T7, T8, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.Combinator8
+
 
+
flatAs(Function<List<T>, Arbitrary<R>>) - Method in class net.jqwik.api.Combinators.ListCombinator
+
 
+
flatMap(Function<T, Arbitrary<U>>) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type U that uses the values of the existing arbitrary to create a new arbitrary + using the mapper function.
+
+
flatMap(Function<T, RandomGenerator<U>>) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
flatMap(Function<T, Arbitrary<U>>, int) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
flatMap(Shrinkable<T>, Function<T, RandomGenerator<U>>, long) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
flatMap(Shrinkable<T>, Function<T, Arbitrary<U>>, int, long) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
flatMap(Function<T, Arbitrary<U>>, int, long) - Method in interface net.jqwik.api.Shrinkable
+
 
+
flatMap(Shrinkable<T>, Function<T, Arbitrary<U>>, int, long) - Method in class net.jqwik.api.Shrinkable.ShrinkableFacade
+
 
+
flatMapExhaustiveGenerator(ExhaustiveGenerator<T>, Function<T, Arbitrary<U>>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
FloatArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Float and float values.
+
+
FloatRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated float or Float parameters.
+
+
floats() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
floats() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Float.
+
+
ForAll - Annotation Type in net.jqwik.api
+
+
Used to annotate method parameters that will be provided by jqwik.
+
+
forCollection(Collection<Shrinkable<T>>) - Static method in class net.jqwik.api.ShrinkingDistance
+
 
+
forEachValue(Consumer<? super T>) - Method in interface net.jqwik.api.Arbitrary
+
+
Iterate through each value this arbitrary can generate if - and only if - + exhaustive generation is possible.
+
+
forType(Class<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
forType(Class<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary for type T that will by default use the type's + public constructors and public factory methods.
+
+
forType(Type) - Static method in interface net.jqwik.api.providers.TypeUsage
+
 
+
forType(Type) - Method in class net.jqwik.api.providers.TypeUsage.TypeUsageFacade
+
 
+
frequency(Tuple.Tuple2<Integer, T>...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given values of the same type T.
+
+
frequency(List<Tuple.Tuple2<Integer, T>>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given values of the same type T.
+
+
frequencyOf(List<Tuple.Tuple2<Integer, Arbitrary<T>>>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
frequencyOf(Tuple.Tuple2<Integer, Arbitrary<T>>...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
+
+
frequencyOf(List<Tuple.Tuple2<Integer, Arbitrary<T>>>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
+
+
FromData - Annotation Type in net.jqwik.api
+
+
Used to annotate property methods.
+
+
fromGenerator(RandomGenerator<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary of type T from a corresponding generator of type T.
+
+
function(Class<?>) - Static method in class net.jqwik.api.Functions
+
+
Create a wrapper for functional types + i.e. types marked FunctionalInterface or representing a + SAM (single abstract method) type.
+
+
Functions - Class in net.jqwik.api
+
 
+
Functions.FunctionsFacade - Class in net.jqwik.api
+
 
+
Functions.FunctionWrapper - Class in net.jqwik.api
+
 
+
FunctionsFacade() - Constructor for class net.jqwik.api.Functions.FunctionsFacade
+
 
+
+ + + +

G

+
+
GenerationMode - Enum in net.jqwik.api
+
+
The generation mode defines the generation behaviour of a property.
+
+
generator(int) - Method in interface net.jqwik.api.Arbitrary
+
+
Create the random generator for an arbitrary
+
+
get1() - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
get2() - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
get3() - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
get4() - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
get5() - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
get6() - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
get7() - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
get8() - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
getAnnotations() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return all annotations of a parameter (or an annotated type argument).
+
+
getArbitraryConfigurators() - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
getArbitraryConfigurators() - Method in interface net.jqwik.api.domains.DomainContext
+
 
+
getArbitraryConfigurators() - Method in class net.jqwik.api.domains.DomainContext.Global
+
 
+
getArbitraryProviders() - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
getArbitraryProviders() - Method in interface net.jqwik.api.domains.DomainContext
+
 
+
getArbitraryProviders() - Method in class net.jqwik.api.domains.DomainContext.Global
+
 
+
getComponentType() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return an Optional of an array's component type - if it is an array.
+
+
getFalsifiedSample() - Method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
getLowerBounds() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return lower bounds if a generic type is a wildcard.
+
+
getRawType() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return the raw type which is usually the class or interface you see in a parameters or return values + specification.
+
+
getSeed() - Method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
getStatus() - Method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
getThrowable() - Method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
getTypeArgument(int) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return the type argument at a specific position.
+
+
getTypeArguments() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return the type arguments of a generic type in the order of there appearance in a type's declaration.
+
+
getUpperBounds() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return upper bounds if a generic type is a wildcard or type variable.
+
+
global() - Method in class net.jqwik.api.domains.DomainContext.DomainContextFacade
+
 
+
global() - Static method in interface net.jqwik.api.domains.DomainContext
+
 
+
Global() - Constructor for class net.jqwik.api.domains.DomainContext.Global
+
 
+
greaterOrEqual(BigDecimal) - Method in interface net.jqwik.api.arbitraries.BigDecimalArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
greaterOrEqual(BigInteger) - Method in interface net.jqwik.api.arbitraries.BigIntegerArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
greaterOrEqual(byte) - Method in interface net.jqwik.api.arbitraries.ByteArbitrary
+
+
Set the allowed lower min (included) bound of generated numbers.
+
+
greaterOrEqual(double) - Method in interface net.jqwik.api.arbitraries.DoubleArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
greaterOrEqual(float) - Method in interface net.jqwik.api.arbitraries.FloatArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
greaterOrEqual(int) - Method in interface net.jqwik.api.arbitraries.IntegerArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
greaterOrEqual(long) - Method in interface net.jqwik.api.arbitraries.LongArbitrary
+
+
Set the allowed lower min (included) bound of generated numbers.
+
+
greaterOrEqual(short) - Method in interface net.jqwik.api.arbitraries.ShortArbitrary
+
+
Set the allowed lower min (included) bounder of generated numbers.
+
+
Group - Annotation Type in net.jqwik.api
+
 
+
+ + + +

H

+
+
hashCode() - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
hashCode() - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
+ + + +

I

+
+
in(Combinators.F2<B, T, C>) - Method in class net.jqwik.api.Combinators.CombinableBuilder
+
 
+
init(FalsificationResult<T>) - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
injectNull(double) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of the same type but inject null values with a probability of nullProbability.
+
+
injectNull(ExhaustiveGenerator<T>) - Method in class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
injectNull() - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
injectNull(double) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
IntegerArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Integer and int values.
+
+
integers() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
integers() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Integer.
+
+
IntRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated int or Integer parameters.
+
+
Invariant<T> - Interface in net.jqwik.api.stateful
+
 
+
isAnnotated(Class<A>) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if the current instance is annotated (directly or indirectly through meta-annotations) + with a specific annotationType.
+
+
isArray() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a type is an array type.
+
+
isAssignableFrom(Class<?>) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Check if a given providedClass is assignable from this generic type.
+
+
isEnum() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a type is an enum type.
+
+
isGeneric() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a type has any type arguments itself.
+
+
isOfType(Class<?>) - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Check if an instance is of a specific raw type + + Most of the time this is what you want to do when checking for applicability of a + ArbitraryProvider.
+
+
isSkipped() - Method in class net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult
+
+
Whether execution of the context should be skipped.
+
+
isSmallerThan(Shrinkable<T>) - Method in interface net.jqwik.api.Shrinkable
+
 
+
isTypeVariable() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a generic type is a wildcard.
+
+
isTypeVariableOrWildcard() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a generic type is a type variable or a wildcard.
+
+
isUnique() - Method in interface net.jqwik.api.ExhaustiveGenerator
+
+
This is a hack to make unique work for exhaustive generation
+
+
isWildcard() - Method in interface net.jqwik.api.providers.TypeUsage
+
+
Return true if a generic type is a wildcard.
+
+
items() - Method in interface net.jqwik.api.Tuple
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
items() - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
iterator(Arbitrary<T>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
iterator() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type Iterable<T> using the existing arbitrary for generating the elements of the + stream.
+
+
+ + + +

J

+
+
JqwikException - Exception in net.jqwik.api
+
+
Base exception for exceptions that are thrown during the discovery phase + and during setup of properties before they are actually run.
+
+
JqwikException(String) - Constructor for exception net.jqwik.api.JqwikException
+
 
+
JqwikException(String, Throwable) - Constructor for exception net.jqwik.api.JqwikException
+
 
+
+ + + +

L

+
+
Label - Annotation Type in net.jqwik.api
+
+
Use @Label("a descriptive name") to give test classes, groups and methods + a more readable label (aka display name).
+
+
label() - Method in interface net.jqwik.api.lifecycle.LifecycleContext
+
 
+
lazy(Supplier<Arbitrary<T>>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
lazy(Supplier<Arbitrary<T>>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will evaluate arbitrarySupplier as soon as it is used for generating values.
+
+
lessOrEqual(BigDecimal) - Method in interface net.jqwik.api.arbitraries.BigDecimalArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
lessOrEqual(BigInteger) - Method in interface net.jqwik.api.arbitraries.BigIntegerArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
lessOrEqual(byte) - Method in interface net.jqwik.api.arbitraries.ByteArbitrary
+
+
Set the allowed upper max (included) bound of generated numbers.
+
+
lessOrEqual(double) - Method in interface net.jqwik.api.arbitraries.DoubleArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
lessOrEqual(float) - Method in interface net.jqwik.api.arbitraries.FloatArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
lessOrEqual(int) - Method in interface net.jqwik.api.arbitraries.IntegerArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
lessOrEqual(long) - Method in interface net.jqwik.api.arbitraries.LongArbitrary
+
+
Set the allowed upper max (included) bound of generated numbers.
+
+
lessOrEqual(short) - Method in interface net.jqwik.api.arbitraries.ShortArbitrary
+
+
Set the allowed upper max (included) bounder of generated numbers.
+
+
LifecycleContext - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
LifecycleHook<T extends LifecycleHook> - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
LifecycleHooks - Annotation Type in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
list(Arbitrary<T>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
list() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type List<T> using the existing arbitrary for generating the elements of the list.
+
+
load(Class<T>) - Static method in class net.jqwik.api.FacadeLoader
+
+
Load single implementation of an API facade.
+
+
LongArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Long and long values.
+
+
LongRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated long or BigInteger parameters.
+
+
longs() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
longs() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Long.
+
+
LowerChars - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to lower case chars.
+
+
+ + + +

M

+
+
map(Function<T, U>) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type U that maps the values of the original arbitrary using the mapper + function.
+
+
map(ExhaustiveGenerator<T>, Function<T, U>) - Method in class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
map(Function<T, U>) - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
map(Function<Shrinkable<T>, Shrinkable<U>>) - Method in class net.jqwik.api.FalsificationResult
+
 
+
map(Function<T, U>) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
map(Function<T, U>) - Method in interface net.jqwik.api.Shrinkable
+
 
+
map(Shrinkable<T>, Function<T, U>) - Method in class net.jqwik.api.Shrinkable.ShrinkableFacade
+
 
+
map(Function<FalsificationResult<T>, FalsificationResult<U>>) - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
map(ShrinkingSequence<T>, Function<FalsificationResult<T>, FalsificationResult<U>>) - Method in class net.jqwik.api.ShrinkingSequence.ShrinkingSequenceFacade
+
 
+
maps(Arbitrary<K>, Arbitrary<V>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
maps(Arbitrary<K>, Arbitrary<V>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary to create instances of Map.
+
+
mapValue(Function<T, U>) - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
mapValue(ShrinkingSequence<T>, Function<T, U>) - Method in class net.jqwik.api.ShrinkingSequence.ShrinkingSequenceFacade
+
 
+
MAX_DISCARD_RATIO_NOT_SET - Static variable in annotation type net.jqwik.api.Property
+
 
+
maxCount() - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
modify(TypeArbitrary<T>) - Method in enum net.jqwik.api.constraints.UseTypeMode
+
 
+
+ + + +

N

+
+
Negative - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated number to be less than 0.
+
+
net.jqwik.api - package net.jqwik.api
+
 
+
net.jqwik.api.arbitraries - package net.jqwik.api.arbitraries
+
 
+
net.jqwik.api.configurators - package net.jqwik.api.configurators
+
 
+
net.jqwik.api.constraints - package net.jqwik.api.constraints
+
 
+
net.jqwik.api.domains - package net.jqwik.api.domains
+
 
+
net.jqwik.api.lifecycle - package net.jqwik.api.lifecycle
+
 
+
net.jqwik.api.providers - package net.jqwik.api.providers
+
 
+
net.jqwik.api.stateful - package net.jqwik.api.stateful
+
 
+
next(Random) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
next(Runnable, Consumer<FalsificationResult<T>>) - Method in interface net.jqwik.api.ShrinkingSequence
+
 
+
NotEmpty - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the size of generated "sizable" types to be at least 1.
+
+
notFalsified(Shrinkable<T>) - Static method in class net.jqwik.api.FalsificationResult
+
 
+
nothing() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that never creates anything.
+
+
numeric() - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all numeric chars (digits) to show up in generated strings.
+
+
NumericChars - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to digits.
+
+
+ + + +

O

+
+
of(T...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose from a given array of values.
+
+
of(List<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose from a given list of values.
+
+
of(char[]) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary of character values.
+
+
of(Class<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary for enum values of type T.
+
+
of(Class<?>, TypeUsage...) - Static method in interface net.jqwik.api.providers.TypeUsage
+
 
+
of(Class<?>, TypeUsage...) - Method in class net.jqwik.api.providers.TypeUsage.TypeUsageFacade
+
 
+
of(long...) - Static method in class net.jqwik.api.ShrinkingDistance
+
 
+
of(E...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple1<T>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple2<T1, T2>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple3<T1, T2, T3>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple4<T1, T2, T3, T4>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple5<T1, T2, T3, T4, T5>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple6<T1, T2, T3, T4, T5, T6>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple7<T1, T2, T3, T4, T5, T6, T7>...) - Static method in class net.jqwik.api.Table
+
 
+
of(Tuple.Tuple8<T1, T2, T3, T4, T5, T6, T7, T8>...) - Static method in class net.jqwik.api.Table
+
 
+
of(T1) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3, T4) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3, T4, T5) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3, T4, T5, T6) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3, T4, T5, T6, T7) - Static method in interface net.jqwik.api.Tuple
+
 
+
of(T1, T2, T3, T4, T5, T6, T7, T8) - Static method in interface net.jqwik.api.Tuple
+
 
+
ofLength(int) - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Fix the length to length of generated strings.
+
+
ofMaxLength(int) - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Set the maximum allowed length maxLength (included) of generated strings.
+
+
ofMaxSize(int) - Method in interface net.jqwik.api.arbitraries.SizableArbitrary
+
+
Set upper size boundary maxSize (included).
+
+
ofMaxSize(int) - Method in interface net.jqwik.api.stateful.ActionSequenceArbitrary
+
 
+
ofMinLength(int) - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Set the minimum allowed length mixLength (included) of generated strings.
+
+
ofMinSize(int) - Method in interface net.jqwik.api.arbitraries.SizableArbitrary
+
+
Set lower size boundary minSize (included).
+
+
ofMinSize(int) - Method in interface net.jqwik.api.stateful.ActionSequenceArbitrary
+
 
+
ofScale(int) - Method in interface net.jqwik.api.arbitraries.BigDecimalArbitrary
+
+
Set the scale (maximum number of decimal places) to scale.
+
+
ofScale(int) - Method in interface net.jqwik.api.arbitraries.DoubleArbitrary
+
+
Set the scale (maximum number of decimal places) to scale.
+
+
ofScale(int) - Method in interface net.jqwik.api.arbitraries.FloatArbitrary
+
+
Set the scale (maximum number of decimal places) to scale.
+
+
ofSize(int) - Method in interface net.jqwik.api.arbitraries.SizableArbitrary
+
+
Fix the size to size.
+
+
ofSize(int) - Method in interface net.jqwik.api.stateful.ActionSequenceArbitrary
+
 
+
oneOf(List<Arbitrary<T>>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
oneOf(Arbitrary<T>, Arbitrary<T>...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
+
+
oneOf(List<Arbitrary<T>>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
+
+
optional() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type Optional<T> using the existing arbitrary for generating the elements of the + stream.
+
+
order() - Method in interface net.jqwik.api.configurators.ArbitraryConfigurator
+
+
Determines the order in which a configurator will be applied in regards to other configurators.
+
+
order() - Method in interface net.jqwik.api.lifecycle.SkipExecutionHook
+
 
+
+ + + +

P

+
+
plus(ShrinkingDistance) - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
Positive - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated number to be greater than 0.
+
+
precondition(M) - Method in interface net.jqwik.api.stateful.Action
+
+
If this method returns false, the action will not be performed.
+
+
priority() - Method in interface net.jqwik.api.providers.ArbitraryProvider
+
+
Providers with higher priority will replace providers with lower priority.
+
+
PRIORITY_NOT_SET - Static variable in annotation type net.jqwik.api.domains.Domain
+
 
+
Property - Annotation Type in net.jqwik.api
+
+
Use @Property to mark methods that serve as properties.
+
+
PropertyExecutionResult - Class in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
PropertyExecutionResult.Status - Enum in net.jqwik.api.lifecycle
+
+
Status of executing a single test or container.
+
+
PropertyExecutor - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
PropertyLifecycleContext - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
Provide - Annotation Type in net.jqwik.api
+
+
Used to annotate methods that can provide values for property method parameters.
+
+
provideFor(TypeUsage, ArbitraryProvider.SubtypeProvider) - Method in interface net.jqwik.api.providers.ArbitraryProvider
+
+
This is the method you must override in your own implementations of ArbitraryProvider.
+
+
+ + + +

R

+
+
randomChoose(List<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
randomChoose(char[]) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
randomChoose(Class<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
randomFrequency(List<Tuple.Tuple2<Integer, T>>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
RandomGenerator<T> - Interface in net.jqwik.api
+
 
+
RandomGenerator.RandomGeneratorFacade - Class in net.jqwik.api
+
 
+
RandomGeneratorFacade() - Constructor for class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
randoms() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary for Random objects.
+
+
randomSamples(T[]) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
randomShuffle(List<T>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
randomValue(Function<Random, T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will generate values of type T using a generator function.
+
+
range(char, char) - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all chars within min (included) and max (included) to show up in generated values.
+
+
reason() - Method in class net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult
+
+
Get the reason that execution of the context should be skipped, + if available.
+
+
recursive(Supplier<Arbitrary<T>>, Function<Arbitrary<T>, Arbitrary<T>>, int) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary by deterministic recursion.
+
+
registerArbitrary(TypeUsage, Arbitrary<?>) - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
registerArbitrary(Class<T>, Arbitrary<T>) - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
registerConfigurator(ArbitraryConfigurator) - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
registerProvider(ArbitraryProvider) - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
Report - Annotation Type in net.jqwik.api
+
+
Use @Report to specify what additional things should be reported + when running a property.
+
+
Reporting - Enum in net.jqwik.api
+
 
+
returns(Arbitrary<?>) - Method in class net.jqwik.api.Functions.FunctionWrapper
+
+
Create an arbitrary to create instances of functions represented by this wrapper.
+
+
run(M) - Method in interface net.jqwik.api.stateful.Action
+
+
Perform an action on model M and return the same model (if it has state) + or a new one representing the new state.
+
+
run(M) - Method in interface net.jqwik.api.stateful.ActionSequence
+
 
+
runActions() - Method in interface net.jqwik.api.stateful.ActionSequence
+
 
+
runState() - Method in interface net.jqwik.api.stateful.ActionSequence
+
 
+
+ + + +

S

+
+
samples(T...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will provide the sample values from first to last + and then start again at the beginning.
+
+
Scale - Annotation Type in net.jqwik.api.constraints
+
+
Use to constrain the maximum number of decimal places when generating decimal numbers.
+
+
SEED_NOT_SET - Static variable in annotation type net.jqwik.api.Property
+
 
+
SelfConfiguringArbitrary<T> - Interface in net.jqwik.api.configurators
+
+
An Arbitrary implementation can also implement this interface if it wants + to take over its own configuration which is usually being done by registered instances + of ArbitraryConfigurator.
+
+
sequences(Arbitrary<Action<M>>) - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
sequences(Arbitrary<Action<M>>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary to create a sequence of actions.
+
+
set(Arbitrary<T>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
set() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type Set<T> using the existing arbitrary for generating the elements of the set.
+
+
setDefaultPriority(int) - Method in class net.jqwik.api.domains.AbstractDomainContextBase
+
 
+
setDefaultPriority(int) - Method in interface net.jqwik.api.domains.DomainContext
+
 
+
ShortArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure the generation of Short and short values.
+
+
ShortRange - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the range of a generated short or Short parameters.
+
+
shorts() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
shorts() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type Short.
+
+
shouldBeSkipped(LifecycleContext) - Method in interface net.jqwik.api.lifecycle.SkipExecutionHook
+
 
+
shrink(Falsifier<T>) - Method in interface net.jqwik.api.Shrinkable
+
 
+
shrinkable() - Method in class net.jqwik.api.FalsificationResult
+
 
+
Shrinkable<T> - Interface in net.jqwik.api
+
 
+
Shrinkable.ShrinkableFacade - Class in net.jqwik.api
+
 
+
ShrinkableFacade() - Constructor for class net.jqwik.api.Shrinkable.ShrinkableFacade
+
 
+
ShrinkingDistance - Class in net.jqwik.api
+
 
+
ShrinkingMode - Enum in net.jqwik.api
+
+
The shrinking mode defines the shrinking behaviour of a property.
+
+
ShrinkingSequence<T> - Interface in net.jqwik.api
+
 
+
ShrinkingSequence.ShrinkingSequenceFacade - Class in net.jqwik.api
+
 
+
ShrinkingSequenceFacade() - Constructor for class net.jqwik.api.ShrinkingSequence.ShrinkingSequenceFacade
+
 
+
shrinkTowards(BigDecimal) - Method in interface net.jqwik.api.arbitraries.BigDecimalArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(BigInteger) - Method in interface net.jqwik.api.arbitraries.BigIntegerArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(int) - Method in interface net.jqwik.api.arbitraries.ByteArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(double) - Method in interface net.jqwik.api.arbitraries.DoubleArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(float) - Method in interface net.jqwik.api.arbitraries.FloatArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(int) - Method in interface net.jqwik.api.arbitraries.IntegerArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(long) - Method in interface net.jqwik.api.arbitraries.LongArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shrinkTowards(short) - Method in interface net.jqwik.api.arbitraries.ShortArbitrary
+
+
Set shrinking target to target which must be between the allowed bounds.
+
+
shuffle(T...) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will always generate a list which is a + permutation of the values handed to it.
+
+
shuffle(List<T>) - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that will always generate a list which is a + permutation of the values handed to it.
+
+
SizableArbitrary<U> - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure arbitraries that have size constraints for generated values, e.g. collections and arrays.
+
+
Size - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the size of generated "sizable" types.
+
+
size() - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
size() - Method in interface net.jqwik.api.Tuple
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
size() - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
skip(String) - Static method in class net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult
+
 
+
SkipExecutionHook - Interface in net.jqwik.api.lifecycle
+
+
Experimental feature.
+
+
SkipExecutionHook.SkipResult - Class in net.jqwik.api.lifecycle
+
 
+
Statistics - Class in net.jqwik.api
+
+
This class serves as a container for static methods to collect statistical + data about generated values within a property method.
+
+
Statistics() - Constructor for class net.jqwik.api.Statistics
+
 
+
Statistics.StatisticsFacade - Class in net.jqwik.api
+
 
+
StatisticsFacade() - Constructor for class net.jqwik.api.Statistics.StatisticsFacade
+
 
+
status() - Method in class net.jqwik.api.FalsificationResult
+
 
+
stream(Arbitrary<T>) - Method in class net.jqwik.api.Arbitrary.ArbitraryFacade
+
 
+
stream() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of type Stream<T> using the existing arbitrary for generating the elements of the + stream.
+
+
stream(Random) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
StringArbitrary - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure arbitraries that generate String values.
+
+
StringLength - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the length of generated Strings.
+
+
strings() - Method in class net.jqwik.api.Arbitraries.ArbitrariesFacade
+
 
+
strings() - Static method in class net.jqwik.api.Arbitraries
+
+
Create an arbitrary that generates values of type String.
+
+
successful() - Static method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
successful(String) - Static method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
+ + + +

T

+
+
Table - Class in net.jqwik.api
+
 
+
Table() - Constructor for class net.jqwik.api.Table
+
 
+
Tag - Annotation Type in net.jqwik.api
+
+
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 - Annotation Type in net.jqwik.api
+
 
+
targetMethod() - Method in interface net.jqwik.api.lifecycle.PropertyLifecycleContext
+
 
+
testInstance() - Method in interface net.jqwik.api.lifecycle.PropertyLifecycleContext
+
 
+
that(boolean) - Static method in class net.jqwik.api.Assume
+
+
If condition does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try.
+
+
that(Supplier<Boolean>) - Static method in class net.jqwik.api.Assume
+
+
If condition provided by conditionSupplier does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try.
+
+
then(SkipExecutionHook) - Method in interface net.jqwik.api.lifecycle.SkipExecutionHook
+
 
+
throwable() - Method in class net.jqwik.api.FalsificationResult
+
 
+
TooManyFilterMissesException - Exception in net.jqwik.api
+
 
+
TooManyFilterMissesException(String) - Constructor for exception net.jqwik.api.TooManyFilterMissesException
+
 
+
toString() - Method in class net.jqwik.api.lifecycle.PropertyExecutionResult
+
 
+
toString() - Method in class net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult
+
 
+
toString() - Method in class net.jqwik.api.ShrinkingDistance
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple1
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple2
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple3
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple4
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple5
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple6
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple7
+
 
+
toString() - Method in class net.jqwik.api.Tuple.Tuple8
+
 
+
TRIES_NOT_SET - Static variable in annotation type net.jqwik.api.Property
+
 
+
Tuple - Interface in net.jqwik.api
+
 
+
Tuple.Tuple1<T1> - Class in net.jqwik.api
+
 
+
Tuple.Tuple2<T1,T2> - Class in net.jqwik.api
+
 
+
Tuple.Tuple3<T1,T2,T3> - Class in net.jqwik.api
+
 
+
Tuple.Tuple4<T1,T2,T3,T4> - Class in net.jqwik.api
+
 
+
Tuple.Tuple5<T1,T2,T3,T4,T5> - Class in net.jqwik.api
+
 
+
Tuple.Tuple6<T1,T2,T3,T4,T5,T6> - Class in net.jqwik.api
+
 
+
Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7> - Class in net.jqwik.api
+
 
+
Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8> - Class in net.jqwik.api
+
 
+
TypeArbitrary<T> - Interface in net.jqwik.api.arbitraries
+
+
Fluent interface to configure arbitraries that try to generate instances + of a given type T from the type's available constructors and factory methods.
+
+
TypeUsage - Interface in net.jqwik.api.providers
+
+
An instance of TypeUsage describes the information available for parameter or return types.
+
+
TypeUsage.TypeUsageFacade - Class in net.jqwik.api.providers
+
 
+
TypeUsageFacade() - Constructor for class net.jqwik.api.providers.TypeUsage.TypeUsageFacade
+
 
+
+ + + +

U

+
+
unique() - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but will + never generate the same value twice.
+
+
Unique - Annotation Type in net.jqwik.api.constraints
+
+
Make a generated value to be unique withing the same try.
+
+
unique(ExhaustiveGenerator<T>) - Method in class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
unique() - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
unique(RandomGenerator<T>) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
unique() - Method in interface net.jqwik.api.RandomGenerator
+
 
+
unshrinkable(T) - Method in class net.jqwik.api.Shrinkable.ShrinkableFacade
+
 
+
unshrinkable(T) - Static method in interface net.jqwik.api.Shrinkable
+
 
+
UpperChars - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to upper and lower case chars.
+
+
use(Executable) - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add another creator (function or constructor) to be used + for generating values of type T
+
+
use(Arbitrary<T>) - Method in class net.jqwik.api.Combinators.BuilderCombinator
+
 
+
useAllConstructors() - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add all constructors (public, private or package scope) of class T to be used + for generating values of type T
+
+
useAllFactoryMethods() - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add all factory methods (static methods with return type T) + of class T to be used for generating values of type T
+
+
useConstructors(Predicate<? super Constructor<?>>) - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add all constructors (public, private or package scope) of class T to be used + for generating values of type T
+
+
useFactoryMethods(Predicate<Method>) - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add all factory methods (static methods with return type T) + of class T to be used for generating values of type T
+
+
usePublicConstructors() - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add public constructors of class T to be used + for generating values of type T
+
+
usePublicFactoryMethods() - Method in interface net.jqwik.api.arbitraries.TypeArbitrary
+
+
Add public factory methods (static methods with return type T) + of class T to be used for generating values of type T
+
+
UseType - Annotation Type in net.jqwik.api.constraints
+
+
Generate a value from the annotated class' or type's constructors or factory methods.
+
+
UseTypeMode - Enum in net.jqwik.api.constraints
+
 
+
+ + + +

V

+
+
value() - Method in class net.jqwik.api.FalsificationResult
+
 
+
value() - Method in interface net.jqwik.api.Shrinkable
+
 
+
valueOf(String) - Static method in enum net.jqwik.api.AfterFailureMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.constraints.UseTypeMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.FalsificationResult.Status
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.GenerationMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.lifecycle.PropertyExecutionResult.Status
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.Reporting
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.ShrinkingMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum net.jqwik.api.stateful.ActionSequence.RunState
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum net.jqwik.api.AfterFailureMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.constraints.UseTypeMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.FalsificationResult.Status
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.GenerationMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.lifecycle.PropertyExecutionResult.Status
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.Reporting
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.ShrinkingMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum net.jqwik.api.stateful.ActionSequence.RunState
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+ + + +

W

+
+
whitespace() - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all whitespace chars to show up in generated values.
+
+
whitespace() - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all chars that will return true for + Character.isWhitespace(char).
+
+
Whitespace - Annotation Type in net.jqwik.api.constraints
+
+
Constrain the chars used to generate Strings or Characters to chars + that will return true for Character.isWhitespace(char).
+
+
wildcard(TypeUsage) - Method in class net.jqwik.api.providers.TypeUsage.TypeUsageFacade
+
 
+
wildcard(TypeUsage) - Static method in interface net.jqwik.api.providers.TypeUsage
+
 
+
with(char...) - Method in interface net.jqwik.api.arbitraries.CharacterArbitrary
+
+
Allow all chars in chars show up in generated values.
+
+
withBuilder(Supplier<B>) - Static method in class net.jqwik.api.Combinators
+
+
Combine Arbitraries by means of a builder.
+
+
withBuilder(Arbitrary<B>) - Static method in class net.jqwik.api.Combinators
+
+
Combine Arbitraries by means of a builder.
+
+
withCharRange(char, char) - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all chars within from (included) and to (included) to show up in generated strings.
+
+
withChars(char...) - Method in interface net.jqwik.api.arbitraries.StringArbitrary
+
+
Allow all chars in chars to show up in generated strings.
+
+
withEdgeCases(RandomGenerator<T>, int, List<Shrinkable<T>>) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
withEdgeCases(int, List<Shrinkable<T>>) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
withFilter(Predicate<T>) - Method in interface net.jqwik.api.Falsifier
+
 
+
withInvariant(Invariant<M>) - Method in interface net.jqwik.api.stateful.ActionSequence
+
 
+
WithNull - Annotation Type in net.jqwik.api.constraints
+
+
Allows jqwik to inject null parameters into generated values.
+
+
withPostFilter(Predicate<T>) - Method in interface net.jqwik.api.Falsifier
+
 
+
withSamples(T...) - Method in interface net.jqwik.api.Arbitrary
+
+
Create a new arbitrary of the same type but inject values in samples first before continuing with standard + value generation.
+
+
withSamples(ExhaustiveGenerator<T>, T[]) - Method in class net.jqwik.api.ExhaustiveGenerator.ExhaustiveGeneratorFacade
+
 
+
withSamples(T[]) - Method in interface net.jqwik.api.ExhaustiveGenerator
+
 
+
withSamples(RandomGenerator<T>, T[]) - Method in class net.jqwik.api.RandomGenerator.RandomGeneratorFacade
+
 
+
withSamples(T...) - Method in interface net.jqwik.api.RandomGenerator
+
 
+
+A B C D E F G H I J L M N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/index.html b/docs/docs/1.1.6/javadoc/index.html new file mode 100644 index 000000000..eac401618 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/index.html @@ -0,0 +1,75 @@ + + + + + +documentation 1.1.6 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/AfterFailureMode.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/AfterFailureMode.html new file mode 100644 index 000000000..c2a4764ee --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/AfterFailureMode.html @@ -0,0 +1,403 @@ + + + + + +AfterFailureMode (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Enum AfterFailureMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<AfterFailureMode>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public enum AfterFailureMode
+extends java.lang.Enum<AfterFailureMode>
    +
    The after-failure mode determines how a property behaves after it has been falsified. + It can be set in Property.afterFailure() for any property method; default is PREVIOUS_SEED.
    +
    +
    See Also:
    +
    Property
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      NOT_SET 
      PREVIOUS_SEED +
      Use the previous random seed that already detected a failure.
      +
      RANDOM_SEED +
      Use new random seed.
      +
      SAMPLE_FIRST +
      Run the property with just the previous falsified and shrunk sample first, + if that succeeds run property default behaviour, i.e. data-driven or random seed.
      +
      SAMPLE_ONLY +
      Run the property with just the previous falsified and shrunk sample.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static AfterFailureModevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static AfterFailureMode[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        RANDOM_SEED

        +
        public static final AfterFailureMode RANDOM_SEED
        +
        Use new random seed.
        +
        • +
      + + + +
        +
      • +

        PREVIOUS_SEED

        +
        public static final AfterFailureMode PREVIOUS_SEED
        +
        Use the previous random seed that already detected a failure.
        +
        • +
      + + + +
        +
      • +

        SAMPLE_ONLY

        +
        public static final AfterFailureMode SAMPLE_ONLY
        +
        Run the property with just the previous falsified and shrunk sample. + + Only works if sample data could be serialized. + Will use previous seed otherwise.
        +
        • +
      + + + +
        +
      • +

        SAMPLE_FIRST

        +
        public static final AfterFailureMode SAMPLE_FIRST
        +
        Run the property with just the previous falsified and shrunk sample first, + if that succeeds run property default behaviour, i.e. data-driven or random seed. + + Only works if sample data could be serialized. + Will use previous seed otherwise.
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static AfterFailureMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (AfterFailureMode c : AfterFailureMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static AfterFailureMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.ArbitrariesFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.ArbitrariesFacade.html new file mode 100644 index 000000000..4060d7c8e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.ArbitrariesFacade.html @@ -0,0 +1,644 @@ + + + + + +Arbitraries.ArbitrariesFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Arbitraries.ArbitrariesFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Arbitraries
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class Arbitraries.ArbitrariesFacade
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArbitrariesFacade

        +
        public ArbitrariesFacade()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html new file mode 100644 index 000000000..74c564751 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html @@ -0,0 +1,1134 @@ + + + + + +Arbitraries (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Arbitraries

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=STABLE,
+     since="1.0")
+public class Arbitraries
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static BigDecimalArbitrarybigDecimals() +
      Create an arbitrary that generates values of type BigDecimal.
      +
      static BigIntegerArbitrarybigIntegers() +
      Create an arbitrary that generates values of type BigInteger.
      +
      static ByteArbitrarybytes() +
      Create an arbitrary that generates values of type Byte.
      +
      static CharacterArbitrarychars() +
      Create an arbitrary that generates values of type Character.
      +
      static <T> Arbitrary<T>constant(T value) +
      Create an arbitrary that will always generate the same value.
      +
      static <T> Arbitrary<T>create(java.util.function.Supplier<T> supplier) +
      Create an arbitrary that will use a supplier to generate a value.
      +
      static <T> Arbitrary<T>defaultFor(java.lang.Class<T> type, + java.lang.Class<?>... typeParameters) +
      Find a registered arbitrary that will be used to generate values of type T.
      +
      static <T> Arbitrary<T>defaultFor(TypeUsage typeUsage) +
      Find a registered arbitrary that will be used to generate values of type T.
      +
      static DoubleArbitrarydoubles() +
      Create an arbitrary that generates values of type Double.
      +
      static FloatArbitraryfloats() +
      Create an arbitrary that generates values of type Float.
      +
      static <T> TypeArbitrary<T>forType(java.lang.Class<T> targetType) +
      Create an arbitrary for type T that will by default use the type's + public constructors and public factory methods.
      +
      static <T> Arbitrary<T>frequency(java.util.List<Tuple.Tuple2<java.lang.Integer,T>> frequencies) +
      Create an arbitrary that will randomly choose between all given values of the same type T.
      +
      static <T> Arbitrary<T>frequency(Tuple.Tuple2<java.lang.Integer,T>... frequencies) +
      Create an arbitrary that will randomly choose between all given values of the same type T.
      +
      static <T> Arbitrary<T>frequencyOf(java.util.List<Tuple.Tuple2<java.lang.Integer,Arbitrary<T>>> frequencies) +
      Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
      +
      static <T> Arbitrary<T>frequencyOf(Tuple.Tuple2<java.lang.Integer,Arbitrary<T>>... frequencies) +
      Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
      +
      static <T> Arbitrary<T>fromGenerator(RandomGenerator<T> generator) +
      Create an arbitrary of type T from a corresponding generator of type T.
      +
      static IntegerArbitraryintegers() +
      Create an arbitrary that generates values of type Integer.
      +
      static <T> Arbitrary<T>lazy(java.util.function.Supplier<Arbitrary<T>> arbitrarySupplier) +
      Create an arbitrary that will evaluate arbitrarySupplier as soon as it is used for generating values.
      +
      static LongArbitrarylongs() +
      Create an arbitrary that generates values of type Long.
      +
      static <K,V> SizableArbitrary<java.util.Map<K,V>>maps(Arbitrary<K> keysArbitrary, + Arbitrary<V> valuesArbitrary) +
      Create an arbitrary to create instances of Map.
      +
      static Arbitrary<java.lang.Void>nothing() +
      Create an arbitrary that never creates anything.
      +
      static Arbitrary<java.lang.Character>of(char[] values) +
      Create an arbitrary of character values.
      +
      static <T extends java.lang.Enum>
      Arbitrary<T>      		of(java.lang.Class<T> enumClass) +
      Create an arbitrary for enum values of type T.
      +
      static <T> Arbitrary<T>of(java.util.List<T> values) +
      Create an arbitrary that will randomly choose from a given list of values.
      +
      static <T> Arbitrary<T>of(T... values) +
      Create an arbitrary that will randomly choose from a given array of values.
      +
      static <T> Arbitrary<T>oneOf(Arbitrary<T> first, + Arbitrary<T>... rest) +
      Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
      +
      static <T> Arbitrary<T>oneOf(java.util.List<Arbitrary<T>> all) +
      Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
      +
      static Arbitrary<java.util.Random>randoms() +
      Create an arbitrary for Random objects.
      +
      static <T> Arbitrary<T>randomValue(java.util.function.Function<java.util.Random,T> generator) +
      Create an arbitrary that will generate values of type T using a generator function.
      +
      static <T> Arbitrary<T>recursive(java.util.function.Supplier<Arbitrary<T>> base, + java.util.function.Function<Arbitrary<T>,Arbitrary<T>> recur, + int depth) +
      Create an arbitrary by deterministic recursion.
      +
      static <T> Arbitrary<T>samples(T... samples) +
      Create an arbitrary that will provide the sample values from first to last + and then start again at the beginning.
      +
      static <M> ActionSequenceArbitrary<M>sequences(Arbitrary<Action<M>> actionArbitrary) +
      Create an arbitrary to create a sequence of actions.
      +
      static ShortArbitraryshorts() +
      Create an arbitrary that generates values of type Short.
      +
      static <T> Arbitrary<java.util.List<T>>shuffle(java.util.List<T> values) +
      Create an arbitrary that will always generate a list which is a + permutation of the values handed to it.
      +
      static <T> Arbitrary<java.util.List<T>>shuffle(T... values) +
      Create an arbitrary that will always generate a list which is a + permutation of the values handed to it.
      +
      static StringArbitrarystrings() +
      Create an arbitrary that generates values of type String.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        fromGenerator

        +
        public static <T> Arbitrary<T> fromGenerator(RandomGenerator<T> generator)
        +
        Create an arbitrary of type T from a corresponding generator of type T.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        generator - The generator to be used for generating the values
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        randomValue

        +
        public static <T> Arbitrary<T> randomValue(java.util.function.Function<java.util.Random,T> generator)
        +
        Create an arbitrary that will generate values of type T using a generator function. + The generated values are unshrinkable.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        generator - The generator function to be used for generating the values
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        randoms

        +
        public static Arbitrary<java.util.Random> randoms()
        +
        Create an arbitrary for Random objects.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        @SafeVarargs
+public static <T> Arbitrary<T> of(T... values)
        +
        Create an arbitrary that will randomly choose from a given array of values. + A generated value will be shrunk towards the start of the array.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        values - The array of values to choose from
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T> Arbitrary<T> of(java.util.List<T> values)
        +
        Create an arbitrary that will randomly choose from a given list of values. + A generated value will be shrunk towards the start of the list.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        values - The list of values to choose from
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static Arbitrary<java.lang.Character> of(char[] values)
        +
        Create an arbitrary of character values.
        +
        +
        Parameters:
        +
        values - The array of characters to choose from.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T extends java.lang.Enum> Arbitrary<T> of(java.lang.Class<T> enumClass)
        +
        Create an arbitrary for enum values of type T.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        enumClass - The enum class.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        oneOf

        +
        @SafeVarargs
+public static <T> Arbitrary<T> oneOf(Arbitrary<T> first,
+                                                  Arbitrary<T>... rest)
        +
        Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        first - The first arbitrary to choose form
        +
        rest - An array of arbitraries to choose from
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        oneOf

        +
        public static <T> Arbitrary<T> oneOf(java.util.List<Arbitrary<T>> all)
        +
        Create an arbitrary that will randomly choose between all given arbitraries of the same type T.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        all - A list of arbitraries to choose from
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        frequency

        +
        @SafeVarargs
+public static <T> Arbitrary<T> frequency(Tuple.Tuple2<java.lang.Integer,T>... frequencies)
        +
        Create an arbitrary that will randomly choose between all given values of the same type T. + The probability distribution is weighted with the first parameter of the tuple.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        frequencies - An array of tuples of which the first parameter gives the weight and the second the value.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        frequency

        +
        public static <T> Arbitrary<T> frequency(java.util.List<Tuple.Tuple2<java.lang.Integer,T>> frequencies)
        +
        Create an arbitrary that will randomly choose between all given values of the same type T. + The probability distribution is weighted with the first parameter of the tuple.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        frequencies - A list of tuples of which the first parameter gives the weight and the second the value.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        frequencyOf

        +
        @SafeVarargs
+public static <T> Arbitrary<T> frequencyOf(Tuple.Tuple2<java.lang.Integer,Arbitrary<T>>... frequencies)
        +
        Create an arbitrary that will randomly choose between all given arbitraries of the same type T. + The probability distribution is weighted with the first parameter of the tuple.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        frequencies - An array of tuples of which the first parameter gives the weight and the second the arbitrary.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        frequencyOf

        +
        public static <T> Arbitrary<T> frequencyOf(java.util.List<Tuple.Tuple2<java.lang.Integer,Arbitrary<T>>> frequencies)
        +
        Create an arbitrary that will randomly choose between all given arbitraries of the same type T. + The probability distribution is weighted with the first parameter of the tuple.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        frequencies - A list of tuples of which the first parameter gives the weight and the second the arbitrary.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        integers

        +
        public static IntegerArbitrary integers()
        +
        Create an arbitrary that generates values of type Integer.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        longs

        +
        public static LongArbitrary longs()
        +
        Create an arbitrary that generates values of type Long.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        bigIntegers

        +
        public static BigIntegerArbitrary bigIntegers()
        +
        Create an arbitrary that generates values of type BigInteger.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        floats

        +
        public static FloatArbitrary floats()
        +
        Create an arbitrary that generates values of type Float.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        bigDecimals

        +
        public static BigDecimalArbitrary bigDecimals()
        +
        Create an arbitrary that generates values of type BigDecimal.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        doubles

        +
        public static DoubleArbitrary doubles()
        +
        Create an arbitrary that generates values of type Double.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        bytes

        +
        public static ByteArbitrary bytes()
        +
        Create an arbitrary that generates values of type Byte.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        shorts

        +
        public static ShortArbitrary shorts()
        +
        Create an arbitrary that generates values of type Short.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        strings

        +
        public static StringArbitrary strings()
        +
        Create an arbitrary that generates values of type String.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        chars

        +
        public static CharacterArbitrary chars()
        +
        Create an arbitrary that generates values of type Character.
        +
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + + + +
        +
      • +

        samples

        +
        @SafeVarargs
+public static <T> Arbitrary<T> samples(T... samples)
        +
        Create an arbitrary that will provide the sample values from first to last + and then start again at the beginning. Shrinking of samples is tried + towards the start of the samples.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        samples - The array of sample values
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <T> Arbitrary<T> constant(T value)
        +
        Create an arbitrary that will always generate the same value.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        value - The value to "generate"
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        @API(status=MAINTAINED,
+     since="1.1.1")
+public static <T> Arbitrary<T> create(java.util.function.Supplier<T> supplier)
        +
        Create an arbitrary that will use a supplier to generate a value. + The difference to constant(Object) is that the value + is freshly generated for each try of a property. + + For exhaustive shrinking all generated values are supposed to have identical behaviour, + i.e. that means that only one value is generated per combination.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        supplier - The supplier use to generate a value
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + + + +
        +
      • +

        shuffle

        +
        public static <T> Arbitrary<java.util.List<T>> shuffle(T... values)
        +
        Create an arbitrary that will always generate a list which is a + permutation of the values handed to it. Permutations will + not be shrunk.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        values - The values to permute
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        shuffle

        +
        public static <T> Arbitrary<java.util.List<T>> shuffle(java.util.List<T> values)
        +
        Create an arbitrary that will always generate a list which is a + permutation of the values handed to it. Permutations will + not be shrunk.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        values - The values to permute
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        defaultFor

        +
        public static <T> Arbitrary<T> defaultFor(java.lang.Class<T> type,
+                                          java.lang.Class<?>... typeParameters)
        +
        Find a registered arbitrary that will be used to generate values of type T. + All default arbitrary providers and all registered arbitrary providers are considered. + This is more or less the same mechanism that jqwik uses to find arbitraries for + property method parameters.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        type - The type of the value to find an arbitrary for
        +
        typeParameters - The type parameters if type is a generic type
        +
        Returns:
        +
        a new arbitrary instance
        +
        Throws:
        +
        CannotFindArbitraryException - if there is no registered arbitrary provider to serve this type
        +
        +
        • +
      + + + +
        +
      • +

        defaultFor

        +
        @API(status=MAINTAINED,
+     since="1.1")
+public static <T> Arbitrary<T> defaultFor(TypeUsage typeUsage)
        +
        Find a registered arbitrary that will be used to generate values of type T. + All default arbitrary providers and all registered arbitrary providers are considered. + This is more or less the same mechanism that jqwik uses to find arbitraries for + property method parameters.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        typeUsage - The type of the value to find an arbitrary for
        +
        Returns:
        +
        a new arbitrary instance
        +
        Throws:
        +
        CannotFindArbitraryException - if there is no registered arbitrary provider to serve this type
        +
        +
        • +
      + + + +
        +
      • +

        forType

        +
        @API(status=EXPERIMENTAL,
+     since="1.1")
+public static <T> TypeArbitrary<T> forType(java.lang.Class<T> targetType)
        +
        Create an arbitrary for type T that will by default use the type's + public constructors and public factory methods.
        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        targetType - The class of the type to create an arbitrary for
        +
        Returns:
        +
        a new arbitrary instance
        +
        See Also:
        +
        TypeArbitrary
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <T> Arbitrary<T> lazy(java.util.function.Supplier<Arbitrary<T>> arbitrarySupplier)
        +
        Create an arbitrary that will evaluate arbitrarySupplier as soon as it is used for generating values. +

        + This is useful (and necessary) when arbitrary providing functions use other arbitrary providing functions + in a recursive way. Without the use of lazy() this would result in a stack overflow.

        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        arbitrarySupplier - The supplier function being used to generate an arbitrary
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        recursive

        +
        public static <T> Arbitrary<T> recursive(java.util.function.Supplier<Arbitrary<T>> base,
+                                         java.util.function.Function<Arbitrary<T>,Arbitrary<T>> recur,
+                                         int depth)
        +
        Create an arbitrary by deterministic recursion. +

        + This is useful (and necessary) when arbitrary providing functions use other arbitrary providing functions + in a recursive way. Without the use of lazy() this would result in a stack overflow.

        +
        +
        Type Parameters:
        +
        T - The type of values to generate
        +
        Parameters:
        +
        base - The supplier returning the recursion's base case
        +
        recur - The function to extend the base case
        +
        depth - The number of times to invoke recursion
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        sequences

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public static <M> ActionSequenceArbitrary<M> sequences(Arbitrary<Action<M>> actionArbitrary)
        +
        Create an arbitrary to create a sequence of actions. Useful for stateful testing.
        +
        +
        Type Parameters:
        +
        M - The type of actions to generate
        +
        Parameters:
        +
        actionArbitrary - The arbitrary to generate individual actions.
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        maps

        +
        @API(status=MAINTAINED,
+     since="1.1.6")
+public static <K,V> SizableArbitrary<java.util.Map<K,V>> maps(Arbitrary<K> keysArbitrary,
+                                                                                                          Arbitrary<V> valuesArbitrary)
        +
        Create an arbitrary to create instances of Map. + The generated maps are mutable.
        +
        +
        Parameters:
        +
        keysArbitrary - The arbitrary to generate the keys
        +
        valuesArbitrary - The arbitrary to generate the values
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        nothing

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.6")
+public static Arbitrary<java.lang.Void> nothing()
        +
        Create an arbitrary that never creates anything. Sometimes useful + when generating arbitraries of "functions" that have void as return type.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.ArbitraryFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.ArbitraryFacade.html new file mode 100644 index 000000000..1dd1f2fc9 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.ArbitraryFacade.html @@ -0,0 +1,343 @@ + + + + + +Arbitrary.ArbitraryFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Arbitrary.ArbitraryFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    Arbitrary<T>
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class Arbitrary.ArbitraryFacade
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html new file mode 100644 index 000000000..d4a180f02 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html @@ -0,0 +1,595 @@ + + + + + +Arbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Arbitrary<T>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static class Arbitrary.ArbitraryFacade 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethod and Description
      default java.util.Optional<java.util.stream.Stream<T>>allValues() +
      Create optional stream of all possible values this arbitrary could generate.
      +
      default <A> SizableArbitrary<A>array(java.lang.Class<A> arrayClass) +
      Create a new arbitrary of type T[] using the existing arbitrary for generating the elements of the array.
      +
      default Arbitrary<java.util.List<T>>collect(java.util.function.Predicate<java.util.List<T>> until) +
      Create a new arbitrary of type List<T> by adding elements of type T until condition until is fulfilled.
      +
      default java.util.Optional<ExhaustiveGenerator<T>>exhaustive() +
      Create the exhaustive generator for an arbitrary
      +
      default Arbitrary<T>filter(java.util.function.Predicate<T> filterPredicate) +
      Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but only allows + values that are accepted by the filterPredicate.
      +
      default Arbitrary<T>fixGenSize(int genSize) +
      Fix the genSize of an arbitrary so that it can no longer be influenced from outside
      +
      default <U> Arbitrary<U>flatMap(java.util.function.Function<T,Arbitrary<U>> mapper) +
      Create a new arbitrary of type U that uses the values of the existing arbitrary to create a new arbitrary + using the mapper function.
      +
      default voidforEachValue(java.util.function.Consumer<? super T> action) +
      Iterate through each value this arbitrary can generate if - and only if - + exhaustive generation is possible.
      +
      RandomGenerator<T>generator(int genSize) +
      Create the random generator for an arbitrary
      +
      default Arbitrary<T>injectNull(double nullProbability) +
      Create a new arbitrary of the same type but inject null values with a probability of nullProbability.
      +
      default SizableArbitrary<java.util.Iterator<T>>iterator() +
      Create a new arbitrary of type Iterable<T> using the existing arbitrary for generating the elements of the + stream.
      +
      default SizableArbitrary<java.util.List<T>>list() +
      Create a new arbitrary of type List<T> using the existing arbitrary for generating the elements of the list.
      +
      default <U> Arbitrary<U>map(java.util.function.Function<T,U> mapper) +
      Create a new arbitrary of type U that maps the values of the original arbitrary using the mapper + function.
      +
      default Arbitrary<java.util.Optional<T>>optional() +
      Create a new arbitrary of type Optional<T> using the existing arbitrary for generating the elements of the + stream.
      +
      default SizableArbitrary<java.util.Set<T>>set() +
      Create a new arbitrary of type Set<T> using the existing arbitrary for generating the elements of the set.
      +
      default SizableArbitrary<java.util.stream.Stream<T>>stream() +
      Create a new arbitrary of type Stream<T> using the existing arbitrary for generating the elements of the + stream.
      +
      default Arbitrary<T>unique() +
      Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but will + never generate the same value twice.
      +
      default Arbitrary<T>withSamples(T... samples) +
      Create a new arbitrary of the same type but inject values in samples first before continuing with standard + value generation.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        generator

        +
        RandomGenerator<T> generator(int genSize)
        +
        Create the random generator for an arbitrary
        +
        +
        Parameters:
        +
        genSize - a very unspecific configuration parameter that can be used + to influence the configuration and behaviour of a random generator + if and only if the generator wants to be influenced. + Many generators are independent of genSize. + + The default value of genSize is the number of tries configured + for a property. Use fixGenSize(int) to fix + the parameter for a given arbitrary.
        +
        Returns:
        +
        a new random generator instance
        +
        +
        • +
      + + + +
        +
      • +

        exhaustive

        +
        default java.util.Optional<ExhaustiveGenerator<T>> exhaustive()
        +
        Create the exhaustive generator for an arbitrary
        +
        +
        Returns:
        +
        a new exhaustive generator or Optional.empty() if it cannot be created.
        +
        +
        • +
      + + + +
        +
      • +

        allValues

        +
        default java.util.Optional<java.util.stream.Stream<T>> allValues()
        +
        Create optional stream of all possible values this arbitrary could generate. + This is only possible if the arbitrary is available for exhaustive generation.
        +
        +
        Returns:
        +
        optional stream of all possible values
        +
        +
        • +
      + + + +
        +
      • +

        forEachValue

        +
        @API(status=MAINTAINED,
+     since="1.1.2")
+default void forEachValue(java.util.function.Consumer<? super T> action)
        +
        Iterate through each value this arbitrary can generate if - and only if - + exhaustive generation is possible. This method can be used for example + to make assertions about a set of values described by an arbitrary.
        +
        +
        Parameters:
        +
        action - the consumer function to be invoked for each value
        +
        Throws:
        +
        java.lang.AssertionError - if exhaustive generation is not possible
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        default Arbitrary<T> filter(java.util.function.Predicate<T> filterPredicate)
        +
        Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but only allows + values that are accepted by the filterPredicate.
        +
        +
        Throws:
        +
        JqwikException - if filtering will fail to come up with a value after 10000 tries
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        default <U> Arbitrary<U> map(java.util.function.Function<T,U> mapper)
        +
        Create a new arbitrary of type U that maps the values of the original arbitrary using the mapper + function.
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        default <U> Arbitrary<U> flatMap(java.util.function.Function<T,Arbitrary<U>> mapper)
        +
        Create a new arbitrary of type U that uses the values of the existing arbitrary to create a new arbitrary + using the mapper function.
        +
        • +
      + + + +
        +
      • +

        injectNull

        +
        default Arbitrary<T> injectNull(double nullProbability)
        +
        Create a new arbitrary of the same type but inject null values with a probability of nullProbability.
        +
        • +
      + + + +
        +
      • +

        unique

        +
        default Arbitrary<T> unique()
        +
        Create a new arbitrary of the same type T that creates and shrinks the original arbitrary but will + never generate the same value twice.
        +
        +
        Throws:
        +
        JqwikException - if filtering will fail to come up with a value after 10000 tries
        +
        +
        • +
      + + + + + +
        +
      • +

        withSamples

        +
        default Arbitrary<T> withSamples(T... samples)
        +
        Create a new arbitrary of the same type but inject values in samples first before continuing with standard + value generation.
        +
        • +
      + + + +
        +
      • +

        fixGenSize

        +
        @API(status=EXPERIMENTAL,
+     since="1.0")
+default Arbitrary<T> fixGenSize(int genSize)
        +
        Fix the genSize of an arbitrary so that it can no longer be influenced from outside
        +
        • +
      + + + +
        +
      • +

        list

        +
        default SizableArbitrary<java.util.List<T>> list()
        +
        Create a new arbitrary of type List<T> using the existing arbitrary for generating the elements of the list.
        +
        • +
      + + + +
        +
      • +

        set

        +
        default SizableArbitrary<java.util.Set<T>> set()
        +
        Create a new arbitrary of type Set<T> using the existing arbitrary for generating the elements of the set.
        +
        • +
      + + + +
        +
      • +

        stream

        +
        default SizableArbitrary<java.util.stream.Stream<T>> stream()
        +
        Create a new arbitrary of type Stream<T> using the existing arbitrary for generating the elements of the + stream.
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        default SizableArbitrary<java.util.Iterator<T>> iterator()
        +
        Create a new arbitrary of type Iterable<T> using the existing arbitrary for generating the elements of the + stream.
        +
        • +
      + + + +
        +
      • +

        array

        +
        default <A> SizableArbitrary<A> array(java.lang.Class<A> arrayClass)
        +
        Create a new arbitrary of type T[] using the existing arbitrary for generating the elements of the array.
        +
        +
        Parameters:
        +
        arrayClass - The arrays class to create, e.g. String[].class. This is required due to limitations in Java's + reflection capabilities.
        +
        +
        • +
      + + + +
        +
      • +

        optional

        +
        default Arbitrary<java.util.Optional<T>> optional()
        +
        Create a new arbitrary of type Optional<T> using the existing arbitrary for generating the elements of the + stream. + + The new arbitrary also generates Optional.empty() values with a probability of 0.05 (i.e. 1 in 20).
        +
        • +
      + + + +
        +
      • +

        collect

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+default Arbitrary<java.util.List<T>> collect(java.util.function.Predicate<java.util.List<T>> until)
        +
        Create a new arbitrary of type List<T> by adding elements of type T until condition until is fulfilled.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Assume.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Assume.html new file mode 100644 index 000000000..420b3e36d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Assume.html @@ -0,0 +1,272 @@ + + + + + +Assume (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Assume

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=STABLE,
+     since="1.0")
+public class Assume
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidthat(boolean condition) +
      If condition does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try.
      +
      static voidthat(java.util.function.Supplier<java.lang.Boolean> conditionSupplier) +
      If condition provided by conditionSupplier does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        that

        +
        public static void that(boolean condition)
        +
        If condition does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try. + + Assumptions are typically positioned at the beginning of a property method.
        +
        +
        Parameters:
        +
        condition -
        +
        +
        • +
      + + + +
        +
      • +

        that

        +
        public static void that(java.util.function.Supplier<java.lang.Boolean> conditionSupplier)
        +
        If condition provided by conditionSupplier does not hold, the current property method will be aborted, + i.e., it will not be executed but not counted as a try. + + Assumptions are typically positioned at the beginning of a property method.
        +
        +
        Parameters:
        +
        conditionSupplier -
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/CannotFindArbitraryException.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/CannotFindArbitraryException.html new file mode 100644 index 000000000..6c208bc7e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/CannotFindArbitraryException.html @@ -0,0 +1,286 @@ + + + + + +CannotFindArbitraryException (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class CannotFindArbitraryException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class CannotFindArbitraryException
+extends JqwikException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CannotFindArbitraryException

        +
        public CannotFindArbitraryException(TypeUsage typeUsage)
        +
        • +
      + + + +
        +
      • +

        CannotFindArbitraryException

        +
        public CannotFindArbitraryException(TypeUsage typeUsage,
+                                    ForAll forAll)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.BuilderCombinator.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.BuilderCombinator.html new file mode 100644 index 000000000..925a8e94c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.BuilderCombinator.html @@ -0,0 +1,254 @@ + + + + + +Combinators.BuilderCombinator (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.BuilderCombinator<B>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.1.1")
+public static class Combinators.BuilderCombinator<B>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinableBuilder.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinableBuilder.html new file mode 100644 index 000000000..108554174 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinableBuilder.html @@ -0,0 +1,241 @@ + + + + + +Combinators.CombinableBuilder (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.CombinableBuilder<B,T>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.1.1")
+public static class Combinators.CombinableBuilder<B,T>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator2.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator2.html new file mode 100644 index 000000000..35aebf144 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator2.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator2 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator2<T1,T2>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator2<T1,T2>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator3.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator3.html new file mode 100644 index 000000000..a7d4239fd --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator3.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator3 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator3<T1,T2,T3>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator3<T1,T2,T3>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator4.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator4.html new file mode 100644 index 000000000..612aa43ba --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator4.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator4 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator4<T1,T2,T3,T4>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator4<T1,T2,T3,T4>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator5.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator5.html new file mode 100644 index 000000000..a81df01be --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator5.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator5 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator5<T1,T2,T3,T4,T5>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator5<T1,T2,T3,T4,T5>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator6.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator6.html new file mode 100644 index 000000000..fd398c233 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator6.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator6 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator6<T1,T2,T3,T4,T5,T6>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator6<T1,T2,T3,T4,T5,T6>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator7.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator7.html new file mode 100644 index 000000000..147059cf7 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator7.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator7 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator8.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator8.html new file mode 100644 index 000000000..429d0e28c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.Combinator8.html @@ -0,0 +1,252 @@ + + + + + +Combinators.Combinator8 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinatorsFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinatorsFacade.html new file mode 100644 index 000000000..60d2b8172 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.CombinatorsFacade.html @@ -0,0 +1,291 @@ + + + + + +Combinators.CombinatorsFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.CombinatorsFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class Combinators.CombinatorsFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CombinatorsFacade() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract <R> java.util.Optional<ExhaustiveGenerator<R>>combineExhaustive(java.util.List<Arbitrary<java.lang.Object>> arbitraries, + java.util.function.Function<java.util.List<java.lang.Object>,R> combineFunction) 
      abstract <R> Shrinkable<R>combineShrinkables(java.util.List<Shrinkable<java.lang.Object>> shrinkables, + java.util.function.Function<java.util.List<java.lang.Object>,R> combineFunction) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CombinatorsFacade

        +
        public CombinatorsFacade()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        combineShrinkables

        +
        public abstract <R> Shrinkable<R> combineShrinkables(java.util.List<Shrinkable<java.lang.Object>> shrinkables,
+                                                     java.util.function.Function<java.util.List<java.lang.Object>,R> combineFunction)
        +
        • +
      + + + +
        +
      • +

        combineExhaustive

        +
        public abstract <R> java.util.Optional<ExhaustiveGenerator<R>> combineExhaustive(java.util.List<Arbitrary<java.lang.Object>> arbitraries,
+                                                                                 java.util.function.Function<java.util.List<java.lang.Object>,R> combineFunction)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F2.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F2.html new file mode 100644 index 000000000..15f23c719 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F2.html @@ -0,0 +1,233 @@ + + + + + +Combinators.F2 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F2<T1,T2,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F2<T1,T2,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F3.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F3.html new file mode 100644 index 000000000..b2d434033 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F3.html @@ -0,0 +1,235 @@ + + + + + +Combinators.F3 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F3<T1,T2,T3,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F3<T1,T2,T3,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F4.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F4.html new file mode 100644 index 000000000..83c1619d1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F4.html @@ -0,0 +1,237 @@ + + + + + +Combinators.F4 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F4<T1,T2,T3,T4,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F4<T1,T2,T3,T4,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F5.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F5.html new file mode 100644 index 000000000..8593aae96 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F5.html @@ -0,0 +1,239 @@ + + + + + +Combinators.F5 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F5<T1,T2,T3,T4,T5,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F5<T1,T2,T3,T4,T5,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F6.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F6.html new file mode 100644 index 000000000..baa893141 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F6.html @@ -0,0 +1,241 @@ + + + + + +Combinators.F6 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F6<T1,T2,T3,T4,T5,T6,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F6<T1,T2,T3,T4,T5,T6,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F7.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F7.html new file mode 100644 index 000000000..ca30357f5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F7.html @@ -0,0 +1,243 @@ + + + + + +Combinators.F7 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F7<T1,T2,T3,T4,T5,T6,T7,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F7<T1,T2,T3,T4,T5,T6,T7,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F8.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F8.html new file mode 100644 index 000000000..bb89a522f --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.F8.html @@ -0,0 +1,245 @@ + + + + + +Combinators.F8 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Combinators.F8<T1,T2,T3,T4,T5,T6,T7,T8,R>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=INTERNAL)
+public static interface Combinators.F8<T1,T2,T3,T4,T5,T6,T7,T8,R>
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.ListCombinator.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.ListCombinator.html new file mode 100644 index 000000000..5a7b83ab1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.ListCombinator.html @@ -0,0 +1,252 @@ + + + + + +Combinators.ListCombinator (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators.ListCombinator<T>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Combinators
    +
    +
    +
    +
    public static class Combinators.ListCombinator<T>
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <R> Arbitrary<R>as(java.util.function.Function<java.util.List<T>,R> combinator) 
      <R> Arbitrary<R>flatAs(java.util.function.Function<java.util.List<T>,Arbitrary<R>> flatCombinator) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        as

        +
        public <R> Arbitrary<R> as(java.util.function.Function<java.util.List<T>,R> combinator)
        +
        • +
      + + + +
        +
      • +

        flatAs

        +
        public <R> Arbitrary<R> flatAs(java.util.function.Function<java.util.List<T>,Arbitrary<R>> flatCombinator)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html new file mode 100644 index 000000000..c5f7cf0b0 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html @@ -0,0 +1,578 @@ + + + + + +Combinators (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Combinators

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class Combinators
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Data.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Data.html new file mode 100644 index 000000000..73ba52ce8 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Data.html @@ -0,0 +1,222 @@ + + + + + +Data (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Data

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Data
    +
    Used to annotate methods that can provide data points for property methods. + Those methods must return an instance of Iterable. + + value is used as reference name. If it is not specified, the method's name is used instead.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html new file mode 100644 index 000000000..52a28012b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html @@ -0,0 +1,223 @@ + + + + + +Disabled (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Disabled

+
+
+
+
    +
  • +
    +
    +
    @Target(value={TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Disabled
    +
    Use @Disabled("reason to disable") to disable test container or test method + during normal test execution.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue +
      The reason this annotated test container or test method is disabled.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The reason this annotated test container or test method is disabled.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Example.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Example.html new file mode 100644 index 000000000..c520d2570 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Example.html @@ -0,0 +1,180 @@ + + + + + +Example (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Example

+
+
+
+
    +
  • +
    +
    +
    @Target(value=METHOD)
+ @Retention(value=RUNTIME)
+ @Documented
+ @Property(tries=1,
+          shrinking=OFF,
+          stereotype="Example")
+ @API(status=STABLE,
+     since="1.0")
+public @interface Example
    +
    Use @Example to mark methods that are simple, example-based + test cases. Those methods usually don't have any ForAll parameters. + They are executed only once. + + Just like methods annotated with Property example, annotated methods + must not be private. They can either return Boolean, boolean + or void.
    +
    +
    See Also:
    +
    Property
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.ExhaustiveGeneratorFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.ExhaustiveGeneratorFacade.html new file mode 100644 index 000000000..e56f55b06 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.ExhaustiveGeneratorFacade.html @@ -0,0 +1,334 @@ + + + + + +ExhaustiveGenerator.ExhaustiveGeneratorFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class ExhaustiveGenerator.ExhaustiveGeneratorFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    ExhaustiveGenerator<T>
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class ExhaustiveGenerator.ExhaustiveGeneratorFacade
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.html new file mode 100644 index 000000000..463360d5f --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ExhaustiveGenerator.html @@ -0,0 +1,340 @@ + + + + + +ExhaustiveGenerator (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface ExhaustiveGenerator<T>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Iterable<T>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ExhaustiveGenerator<T>
+extends java.lang.Iterable<T>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        maxCount

        +
        long maxCount()
        +
        +
        Returns:
        +
        the maximum number of values that will be generated
        +
        +
        • +
      + + + + + + + +
        +
      • +

        filter

        +
        default ExhaustiveGenerator<T> filter(java.util.function.Predicate<T> filterPredicate)
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        @API(status=INTERNAL)
+default boolean isUnique()
        +
        This is a hack to make unique work for exhaustive generation
        +
        • +
      + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/FacadeLoader.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/FacadeLoader.html new file mode 100644 index 000000000..47d11f042 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/FacadeLoader.html @@ -0,0 +1,284 @@ + + + + + +FacadeLoader (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class FacadeLoader

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=INTERNAL)
+public class FacadeLoader
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FacadeLoader() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> Tload(java.lang.Class<T> facadeClass) +
      Load single implementation of an API facade.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FacadeLoader

        +
        public FacadeLoader()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        load

        +
        public static <T> T load(java.lang.Class<T> facadeClass)
        +
        Load single implementation of an API facade. This should be registered as + service provider in the jqwik engine module. There must be exactly + one facade registered otherwise null will be returned and a severe error + is logged.
        +
        +
        Type Parameters:
        +
        T -
        +
        Parameters:
        +
        facadeClass -
        +
        Returns:
        +
        instance of facade
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.Status.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.Status.html new file mode 100644 index 000000000..f596588b2 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.Status.html @@ -0,0 +1,355 @@ + + + + + +FalsificationResult.Status (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Enum FalsificationResult.Status

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static FalsificationResult.StatusvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FalsificationResult.Status[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FalsificationResult.Status[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (FalsificationResult.Status c : FalsificationResult.Status.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FalsificationResult.Status valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.html new file mode 100644 index 000000000..ee15f51ca --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/FalsificationResult.html @@ -0,0 +1,410 @@ + + + + + +FalsificationResult (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class FalsificationResult<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<FalsificationResult<T>>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class FalsificationResult<T>
+extends java.lang.Object
+implements java.lang.Comparable<FalsificationResult<T>>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Falsifier.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Falsifier.html new file mode 100644 index 000000000..675dc03cd --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Falsifier.html @@ -0,0 +1,267 @@ + + + + + +Falsifier (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Falsifier<T>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.Predicate<T>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=STABLE,
+     since="1.0")
+public interface Falsifier<T>
+extends java.util.function.Predicate<T>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        withFilter

        +
        @API(status=INTERNAL)
+default Falsifier<T> withFilter(java.util.function.Predicate<T> filter)
        +
        • +
      + + + +
        +
      • +

        withPostFilter

        +
        @API(status=INTERNAL)
+default Falsifier<T> withPostFilter(java.util.function.Predicate<T> filter)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html new file mode 100644 index 000000000..4b21d29f9 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html @@ -0,0 +1,229 @@ + + + + + +ForAll (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type ForAll

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=STABLE,
+     since="1.0")
+public @interface ForAll
    +
    Used to annotate method parameters that will be provided by jqwik. + + Only works on methods annotated with @Property + + value is used as reference name to a method annotated with @Provide. + If it is not specified, only default providers are considered.
    +
    +
    See Also:
    +
    Property, +Provide
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/FromData.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/FromData.html new file mode 100644 index 000000000..25684e3a5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/FromData.html @@ -0,0 +1,224 @@ + + + + + +FromData (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type FromData

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface FromData
    +
    Used to annotate property methods. + + Only works on methods annotated with @Property + + value is used as reference name to a method annotated with @Data.
    +
    +
    See Also:
    +
    Property, +Data
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionWrapper.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionWrapper.html new file mode 100644 index 000000000..83a4c3d1a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionWrapper.html @@ -0,0 +1,255 @@ + + + + + +Functions.FunctionWrapper (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Functions.FunctionWrapper

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Functions
    +
    +
    +
    +
    public static class Functions.FunctionWrapper
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <T> Arbitrary<T>returns(Arbitrary<?> resultArbitrary) +
      Create an arbitrary to create instances of functions represented by this wrapper.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        returns

        +
        public <T> Arbitrary<T> returns(Arbitrary<?> resultArbitrary)
        +
        Create an arbitrary to create instances of functions represented by this wrapper. + + The generated functions are guaranteed to return the same result + given the same input values. + + Shrinking will consider constant functions.
        +
        +
        Type Parameters:
        +
        T - The exact functional type to generate
        +
        Parameters:
        +
        resultArbitrary - The arbitrary used to generate return values
        +
        Returns:
        +
        a new arbitrary instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionsFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionsFacade.html new file mode 100644 index 000000000..4aafe0d78 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.FunctionsFacade.html @@ -0,0 +1,289 @@ + + + + + +Functions.FunctionsFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Functions.FunctionsFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Functions
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class Functions.FunctionsFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FunctionsFacade() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract <T> Arbitrary<T>constantFunction(java.lang.Class<?> functionalType, + Arbitrary<?> resultArbitrary) 
      abstract voidensureFunctionalType(java.lang.Class<?> functionalType) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FunctionsFacade

        +
        public FunctionsFacade()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ensureFunctionalType

        +
        public abstract void ensureFunctionalType(java.lang.Class<?> functionalType)
        +
        • +
      + + + +
        +
      • +

        constantFunction

        +
        public abstract <T> Arbitrary<T> constantFunction(java.lang.Class<?> functionalType,
+                                                  Arbitrary<?> resultArbitrary)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.html new file mode 100644 index 000000000..5218b2baf --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Functions.html @@ -0,0 +1,275 @@ + + + + + +Functions (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Functions

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.2.0")
+public class Functions
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Functions.FunctionWrapperfunction(java.lang.Class<?> functionalType) +
      Create a wrapper for functional types + i.e. types marked FunctionalInterface or representing a + SAM (single abstract method) type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        function

        +
        public static Functions.FunctionWrapper function(java.lang.Class<?> functionalType)
        +
        Create a wrapper for functional types + i.e. types marked FunctionalInterface or representing a + SAM (single abstract method) type.
        +
        +
        Parameters:
        +
        functionalType - The class object of the functional type to generate
        +
        Returns:
        +
        a new function wrapper instance
        +
        Throws:
        +
        JqwikException - if functionalType is not a functional type
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/GenerationMode.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/GenerationMode.html new file mode 100644 index 000000000..05e174d4d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/GenerationMode.html @@ -0,0 +1,405 @@ + + + + + +GenerationMode (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Enum GenerationMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<GenerationMode>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public enum GenerationMode
+extends java.lang.Enum<GenerationMode>
    +
    The generation mode defines the generation behaviour of a property. + It can be set in Property.generation() for any property method; default is AUTO.
    +
    +
    See Also:
    +
    Property, +FromData
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      AUTO +
      Let jqwik choose which generation mode it prefers: + + If all arbitraries provide exhaustive generators and + if the multiplication of all maxCount() values is ≤ + Property.tries() use EXHAUSTIVE + + If the property has a FromData annotation + use DATA_DRIVEN + + In all other cases use RANDOMIZED +
      +
      DATA_DRIVEN +
      Use data specified in FromData annotation
      +
      EXHAUSTIVE +
      Use exhaustive generation.
      +
      RANDOMIZED +
      Use randomized value generation.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static GenerationModevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static GenerationMode[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        RANDOMIZED

        +
        public static final GenerationMode RANDOMIZED
        +
        Use randomized value generation.
        +
        • +
      + + + +
        +
      • +

        EXHAUSTIVE

        +
        public static final GenerationMode EXHAUSTIVE
        +
        Use exhaustive generation. Only possible if all used arbitraries can + provide exhaustive generators.
        +
        • +
      + + + +
        +
      • +

        DATA_DRIVEN

        +
        public static final GenerationMode DATA_DRIVEN
        +
        Use data specified in FromData annotation
        +
        • +
      + + + +
        +
      • +

        AUTO

        +
        public static final GenerationMode AUTO
        +
        Let jqwik choose which generation mode it prefers: +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static GenerationMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (GenerationMode c : GenerationMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static GenerationMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Group.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Group.html new file mode 100644 index 000000000..eb853561d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Group.html @@ -0,0 +1,167 @@ + + + + + +Group (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Group

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @Testable
+ @API(status=STABLE,
+     since="1.0")
+public @interface Group
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/JqwikException.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/JqwikException.html new file mode 100644 index 000000000..17136cb63 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/JqwikException.html @@ -0,0 +1,289 @@ + + + + + +JqwikException (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class JqwikException

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      JqwikException(java.lang.String message) 
      JqwikException(java.lang.String message, + java.lang.Throwable cause) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JqwikException

        +
        public JqwikException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        JqwikException

        +
        public JqwikException(java.lang.String message,
+                      java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Label.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Label.html new file mode 100644 index 000000000..5a2d13e30 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Label.html @@ -0,0 +1,222 @@ + + + + + +Label (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Label

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @Testable
+ @API(status=STABLE,
+     since="1.0")
+public @interface Label
    +
    Use @Label("a descriptive name") to give test classes, groups and methods + a more readable label (aka display name).
    +
    +
    See Also:
    +
    Property, +Group
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Property.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Property.html new file mode 100644 index 000000000..ef8ab4607 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Property.html @@ -0,0 +1,444 @@ + + + + + +Property (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
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 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.
    +
    +
    See Also:
    +
    Example, +ShrinkingMode, +GenerationMode, +AfterFailureMode, +Data
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      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
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        DEFAULT_STEREOTYPE

        +
        public static final java.lang.String DEFAULT_STEREOTYPE
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        tries

        +
        public abstract int tries
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxDiscardRatio

        +
        public abstract int maxDiscardRatio
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        seed

        +
        public abstract java.lang.String seed
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        shrinking

        +
        public abstract ShrinkingMode shrinking
        +
        +
        Default:
        +
        net.jqwik.api.ShrinkingMode.BOUNDED
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        stereotype

        +
        public abstract java.lang.String stereotype
        +
        +
        Default:
        +
        "Property"
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        generation

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public abstract GenerationMode generation
        +
        +
        Default:
        +
        net.jqwik.api.GenerationMode.AUTO
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        afterFailure

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public abstract AfterFailureMode afterFailure
        +
        +
        Default:
        +
        net.jqwik.api.AfterFailureMode.NOT_SET
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Provide.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Provide.html new file mode 100644 index 000000000..0554b1629 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Provide.html @@ -0,0 +1,222 @@ + + + + + +Provide (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Provide

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=STABLE,
+     since="1.0")
+public @interface Provide
    +
    Used to annotate methods that can provide values for property method parameters. Those methods must return an + instance of Arbitrary. + + value is used as reference name. If it is not specified, the method's name is used instead.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.RandomGeneratorFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.RandomGeneratorFacade.html new file mode 100644 index 000000000..3b6a726f9 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.RandomGeneratorFacade.html @@ -0,0 +1,374 @@ + + + + + +RandomGenerator.RandomGeneratorFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class RandomGenerator.RandomGeneratorFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    RandomGenerator<T>
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class RandomGenerator.RandomGeneratorFacade
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html new file mode 100644 index 000000000..b0b43e71b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html @@ -0,0 +1,382 @@ + + + + + +RandomGenerator (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface RandomGenerator<T>

+
+
+
+
    +
  • +
    +
    +
    @API(status=STABLE,
+     since="1.0")
+public interface RandomGenerator<T>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        next

        +
        Shrinkable<T> next(java.util.Random random)
        +
        +
        Parameters:
        +
        random - the source of randomness. Injected by jqwik itself.
        +
        Returns:
        +
        the next generated value wrapped within the Shrinkable interface. The method must ALWAYS return a next value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        default <U> RandomGenerator<U> map(java.util.function.Function<T,U> mapper)
        +
        • +
      + + + + + + + +
        +
      • +

        flatMap

        +
        default <U> RandomGenerator<U> flatMap(java.util.function.Function<T,Arbitrary<U>> mapper,
+                                       int genSize)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        default RandomGenerator<T> filter(java.util.function.Predicate<T> filterPredicate)
        +
        • +
      + + + +
        +
      • +

        injectNull

        +
        default RandomGenerator<T> injectNull(double nullProbability)
        +
        • +
      + + + + + + + + + + + + + + + + + +
        +
      • +

        stream

        +
        default java.util.stream.Stream<Shrinkable<T>> stream(java.util.Random random)
        +
        • +
      + + + +
        +
      • +

        collect

        +
        default RandomGenerator<java.util.List<T>> collect(java.util.function.Predicate<java.util.List<T>> until)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Report.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Report.html new file mode 100644 index 000000000..0db48a05e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Report.html @@ -0,0 +1,220 @@ + + + + + +Report (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Report

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Report
    +
    Use @Report to specify what additional things should be reported + when running a property.
    +
    +
    See Also:
    +
    Property
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Reporting[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Reporting.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Reporting.html new file mode 100644 index 000000000..ae2f380c6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Reporting.html @@ -0,0 +1,354 @@ + + + + + +Reporting (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Enum Reporting

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Reporting>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public enum Reporting
+extends java.lang.Enum<Reporting>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      FALSIFIED 
      GENERATED 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleancontainedIn(Reporting[] reporting) 
      static ReportingvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Reporting[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        GENERATED

        +
        public static final Reporting GENERATED
        +
        • +
      + + + +
        +
      • +

        FALSIFIED

        +
        public static final Reporting FALSIFIED
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Reporting[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Reporting c : Reporting.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Reporting valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        containedIn

        +
        public boolean containedIn(Reporting[] reporting)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.ShrinkableFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.ShrinkableFacade.html new file mode 100644 index 000000000..aa6d2b427 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.ShrinkableFacade.html @@ -0,0 +1,325 @@ + + + + + +Shrinkable.ShrinkableFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Shrinkable.ShrinkableFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    Shrinkable<T>
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class Shrinkable.ShrinkableFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ShrinkableFacade() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ShrinkableFacade

        +
        public ShrinkableFacade()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        unshrinkable

        +
        public abstract <T> Shrinkable<T> unshrinkable(T value)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public abstract <T,U> Shrinkable<U> map(Shrinkable<T> self,
+                                        java.util.function.Function<T,U> mapper)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public abstract <T> Shrinkable<T> filter(Shrinkable<T> self,
+                                         java.util.function.Predicate<T> filter)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public abstract <T,U> Shrinkable<U> flatMap(Shrinkable<T> self,
+                                            java.util.function.Function<T,Arbitrary<U>> flatMapper,
+                                            int tries,
+                                            long randomSeed)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.html new file mode 100644 index 000000000..406b36968 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Shrinkable.html @@ -0,0 +1,361 @@ + + + + + +Shrinkable (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Shrinkable<T>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Comparable<Shrinkable<T>>
    +
    +
    +
    +
    @API(status=STABLE,
+     since="1.0")
+public interface Shrinkable<T>
+extends java.lang.Comparable<Shrinkable<T>>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        unshrinkable

        +
        static <T> Shrinkable<T> unshrinkable(T value)
        +
        • +
      + + + +
        +
      • +

        value

        +
        T value()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        map

        +
        default <U> Shrinkable<U> map(java.util.function.Function<T,U> mapper)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        default Shrinkable<T> filter(java.util.function.Predicate<T> filter)
        +
        • +
      + + + +
        +
      • +

        compareTo

        +
        @API(status=INTERNAL)
+default int compareTo(Shrinkable<T> other)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<Shrinkable<T>>
        +
        +
        • +
      + + + +
        +
      • +

        isSmallerThan

        +
        @API(status=INTERNAL)
+default boolean isSmallerThan(Shrinkable<T> other)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        default <U> Shrinkable<U> flatMap(java.util.function.Function<T,Arbitrary<U>> flatMapper,
+                                  int tries,
+                                  long randomSeed)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingDistance.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingDistance.html new file mode 100644 index 000000000..a5292dccc --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingDistance.html @@ -0,0 +1,398 @@ + + + + + +ShrinkingDistance (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class ShrinkingDistance

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ShrinkingDistance>
    +
    +
    +
    +
    @API(status=STABLE,
+     since="1.0")
+public class ShrinkingDistance
+extends java.lang.Object
+implements java.lang.Comparable<ShrinkingDistance>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        of

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public static ShrinkingDistance of(long... distances)
        +
        • +
      + + + +
        +
      • +

        forCollection

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public static <T> ShrinkingDistance forCollection(java.util.Collection<Shrinkable<T>> elements)
        +
        • +
      + + + +
        +
      • +

        combine

        +
        @API(status=MAINTAINED,
+     since="1.0")
+public static <T> ShrinkingDistance combine(java.util.List<Shrinkable<T>> shrinkables)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + + + +
        +
      • +

        dimensions

        +
        @API(status=INTERNAL)
+public java.util.List<ShrinkingDistance> dimensions()
        +
        • +
      + + + +
        +
      • +

        size

        +
        @API(status=INTERNAL)
+public int size()
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingMode.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingMode.html new file mode 100644 index 000000000..6722848f6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingMode.html @@ -0,0 +1,371 @@ + + + + + +ShrinkingMode (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Enum ShrinkingMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ShrinkingMode>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public enum ShrinkingMode
+extends java.lang.Enum<ShrinkingMode>
    +
    The shrinking mode defines the shrinking behaviour of a property. + It can be set in Property.shrinking() for any property method; default is BOUNDED.
    +
    +
    See Also:
    +
    Property
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BOUNDED +
      Shrinking is tried to a depth of 1000 steps maximum per value.
      +
      FULL +
      Shrinking continues until no smaller value can be found that also falsifies the property.
      +
      OFF +
      No shrinking for falsified values.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ShrinkingModevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ShrinkingMode[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        OFF

        +
        public static final ShrinkingMode OFF
        +
        No shrinking for falsified values.
        +
        • +
      + + + +
        +
      • +

        BOUNDED

        +
        public static final ShrinkingMode BOUNDED
        +
        Shrinking is tried to a depth of 1000 steps maximum per value. + If shrinking has not finished by then, the best found value is taken and + bounded shrinking is reported through JUnit's reporting mechanism.
        +
        • +
      + + + +
        +
      • +

        FULL

        +
        public static final ShrinkingMode FULL
        +
        Shrinking continues until no smaller value can be found that also falsifies the property. + This might take very long or not end at all in rare cases.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ShrinkingMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ShrinkingMode c : ShrinkingMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ShrinkingMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.ShrinkingSequenceFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.ShrinkingSequenceFacade.html new file mode 100644 index 000000000..6a3ffd01c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.ShrinkingSequenceFacade.html @@ -0,0 +1,319 @@ + + + + + +ShrinkingSequence.ShrinkingSequenceFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class ShrinkingSequence.ShrinkingSequenceFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    ShrinkingSequence<T>
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class ShrinkingSequence.ShrinkingSequenceFacade
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.html new file mode 100644 index 000000000..815eab74a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/ShrinkingSequence.html @@ -0,0 +1,321 @@ + + + + + +ShrinkingSequence (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface ShrinkingSequence<T>

+
+
+
+
    +
  • +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ShrinkingSequence<T>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.StatisticsFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.StatisticsFacade.html new file mode 100644 index 000000000..88141384b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.StatisticsFacade.html @@ -0,0 +1,273 @@ + + + + + +Statistics.StatisticsFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Statistics.StatisticsFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Statistics
    +
    +
    +
    +
    public abstract static class Statistics.StatisticsFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StatisticsFacade() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract voidcollect(java.lang.Object... values) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StatisticsFacade

        +
        public StatisticsFacade()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        collect

        +
        public abstract void collect(java.lang.Object... values)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html new file mode 100644 index 000000000..f15c8652d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html @@ -0,0 +1,302 @@ + + + + + +Statistics (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api
+

Class Statistics

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class Statistics
+extends java.lang.Object
    +
    This class serves as a container for static methods to collect statistical + data about generated values within a property method.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Statistics() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidcollect(java.lang.Object... values) +
      Call this method to record an entry for statistical data about generated values.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Statistics

        +
        public Statistics()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        collect

        +
        public static void collect(java.lang.Object... values)
        +
        Call this method to record an entry for statistical data about generated values. + As soon as this method is called at least once in a property method, + the statistical data will be reported after the property has finished.
        +
        +
        Parameters:
        +
        values - Can be anything. The list of these values is considered + a key for the reported table of frequencies.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Table.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Table.html new file mode 100644 index 000000000..ba5ad96a4 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Table.html @@ -0,0 +1,377 @@ + + + + + +Table (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Class Table

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class Table
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Table() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> java.lang.Iterable<Tuple.Tuple1<E>>of(E... elements) 
      static <T> java.lang.Iterable<Tuple.Tuple1<T>>of(Tuple.Tuple1<T>... tuples) 
      static <T1,T2> java.lang.Iterable<Tuple.Tuple2<T1,T2>>of(Tuple.Tuple2<T1,T2>... tuples) 
      static <T1,T2,T3> java.lang.Iterable<Tuple.Tuple3<T1,T2,T3>>of(Tuple.Tuple3<T1,T2,T3>... tuples) 
      static <T1,T2,T3,T4>
      java.lang.Iterable<Tuple.Tuple4<T1,T2,T3,T4>>      		of(Tuple.Tuple4<T1,T2,T3,T4>... tuples) 
      static <T1,T2,T3,T4,T5>
      java.lang.Iterable<Tuple.Tuple5<T1,T2,T3,T4,T5>>      		of(Tuple.Tuple5<T1,T2,T3,T4,T5>... tuples) 
      static <T1,T2,T3,T4,T5,T6>
      java.lang.Iterable<Tuple.Tuple6<T1,T2,T3,T4,T5,T6>>      		of(Tuple.Tuple6<T1,T2,T3,T4,T5,T6>... tuples) 
      static <T1,T2,T3,T4,T5,T6,T7>
      java.lang.Iterable<Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>>      		of(Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>... tuples) 
      static <T1,T2,T3,T4,T5,T6,T7,T8>
      java.lang.Iterable<Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>>      		of(Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>... tuples) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Table

        +
        public Table()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        of

        +
        public static <E> java.lang.Iterable<Tuple.Tuple1<E>> of(E... elements)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3> java.lang.Iterable<Tuple.Tuple3<T1,T2,T3>> of(Tuple.Tuple3<T1,T2,T3>... tuples)
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3,T4> java.lang.Iterable<Tuple.Tuple4<T1,T2,T3,T4>> of(Tuple.Tuple4<T1,T2,T3,T4>... tuples)
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3,T4,T5> java.lang.Iterable<Tuple.Tuple5<T1,T2,T3,T4,T5>> of(Tuple.Tuple5<T1,T2,T3,T4,T5>... tuples)
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3,T4,T5,T6> java.lang.Iterable<Tuple.Tuple6<T1,T2,T3,T4,T5,T6>> of(Tuple.Tuple6<T1,T2,T3,T4,T5,T6>... tuples)
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3,T4,T5,T6,T7> java.lang.Iterable<Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>> of(Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>... tuples)
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static <T1,T2,T3,T4,T5,T6,T7,T8> java.lang.Iterable<Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>> of(Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>... tuples)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tag.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tag.html new file mode 100644 index 000000000..3b4cad912 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tag.html @@ -0,0 +1,237 @@ + + + + + +Tag (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type Tag

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @Repeatable(value=TagList.class)
+ @API(status=STABLE,
+     since="1.0")
+public @interface 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. +

    + You can have many tags on the same element. +

    + Tags on the JUnit platform must obey a few rules: +

      +
    • A tag must not be blank.
      • +
    • A trimmed tag must not contain whitespace.
      • +
    • A trimmed tag must not contain ISO control characters.
      • +
    • A trimmed tag must not contain any of the following + reserved characters. +
        +
      • ,: comma
        • +
      • (: left parenthesis
        • +
      • ): right parenthesis
        • +
      • &: ampersand
        • +
      • |: vertical bar
        • +
      • !: exclamation point
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/TagList.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/TagList.html new file mode 100644 index 000000000..c5f6191f2 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/TagList.html @@ -0,0 +1,214 @@ + + + + + +TagList (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api
+

Annotation Type TagList

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=STABLE,
+     since="1.0")
+public @interface TagList
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Tag[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Tag[] value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/TooManyFilterMissesException.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/TooManyFilterMissesException.html new file mode 100644 index 000000000..df417c499 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/TooManyFilterMissesException.html @@ -0,0 +1,272 @@ + + + + + +TooManyFilterMissesException (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class TooManyFilterMissesException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class TooManyFilterMissesException
+extends JqwikException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TooManyFilterMissesException

        +
        public TooManyFilterMissesException(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple1.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple1.html new file mode 100644 index 000000000..ae44349ca --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple1.html @@ -0,0 +1,359 @@ + + + + + +Tuple.Tuple1 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple1<T1>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple2
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple1<T1>
+extends java.lang.Object
+implements Tuple
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface Tuple
        +
        +
        • +
      + + + +
        +
      • +

        get1

        +
        public T1 get1()
        +
        • +
      + + + +
        +
      • +

        items

        +
        public java.util.List<java.lang.Object> items()
        +
        +
        Specified by:
        +
        items in interface Tuple
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple2.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple2.html new file mode 100644 index 000000000..90536c36b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple2.html @@ -0,0 +1,374 @@ + + + + + +Tuple.Tuple2 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple2<T1,T2>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple3
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple2<T1,T2>
+extends Tuple.Tuple1<T1>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple3.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple3.html new file mode 100644 index 000000000..8e83a68e6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple3.html @@ -0,0 +1,386 @@ + + + + + +Tuple.Tuple3 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple3<T1,T2,T3>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple4
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple3<T1,T2,T3>
+extends Tuple.Tuple2<T1,T2>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple4.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple4.html new file mode 100644 index 000000000..8870e55df --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple4.html @@ -0,0 +1,398 @@ + + + + + +Tuple.Tuple4 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple4<T1,T2,T3,T4>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple5
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple4<T1,T2,T3,T4>
+extends Tuple.Tuple3<T1,T2,T3>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple5.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple5.html new file mode 100644 index 000000000..a7fe87983 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple5.html @@ -0,0 +1,410 @@ + + + + + +Tuple.Tuple5 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple5<T1,T2,T3,T4,T5>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple6
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple5<T1,T2,T3,T4,T5>
+extends Tuple.Tuple4<T1,T2,T3,T4>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple6.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple6.html new file mode 100644 index 000000000..c9f80cbe0 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple6.html @@ -0,0 +1,422 @@ + + + + + +Tuple.Tuple6 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple6<T1,T2,T3,T4,T5,T6>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple7
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple6<T1,T2,T3,T4,T5,T6>
+extends Tuple.Tuple5<T1,T2,T3,T4,T5>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple7.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple7.html new file mode 100644 index 000000000..0d9d563ff --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple7.html @@ -0,0 +1,434 @@ + + + + + +Tuple.Tuple7 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Direct Known Subclasses:
    +
    Tuple.Tuple8
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>
+extends Tuple.Tuple6<T1,T2,T3,T4,T5,T6>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple8.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple8.html new file mode 100644 index 000000000..fc4c1fde5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.Tuple8.html @@ -0,0 +1,442 @@ + + + + + +Tuple.Tuple8 (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Class Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Cloneable, Tuple
    +
    +
    +
    Enclosing interface:
    +
    Tuple
    +
    +
    +
    +
    public static class Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>
+extends Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7>
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.html new file mode 100644 index 000000000..7570a1f15 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/Tuple.html @@ -0,0 +1,466 @@ + + + + + +Tuple (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api
+

Interface Tuple

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        size

        +
        int size()
        +
        • +
      + + + +
        +
      • +

        items

        +
        default java.util.List<java.lang.Object> items()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        of

        +
        static <T1,T2> Tuple.Tuple2<T1,T2> of(T1 v1,
+                                      T2 v2)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3> Tuple.Tuple3<T1,T2,T3> of(T1 v1,
+                                            T2 v2,
+                                            T3 v3)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3,T4> Tuple.Tuple4<T1,T2,T3,T4> of(T1 v1,
+                                                  T2 v2,
+                                                  T3 v3,
+                                                  T4 v4)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3,T4,T5> Tuple.Tuple5<T1,T2,T3,T4,T5> of(T1 v1,
+                                                        T2 v2,
+                                                        T3 v3,
+                                                        T4 v4,
+                                                        T5 v5)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3,T4,T5,T6> Tuple.Tuple6<T1,T2,T3,T4,T5,T6> of(T1 v1,
+                                                              T2 v2,
+                                                              T3 v3,
+                                                              T4 v4,
+                                                              T5 v5,
+                                                              T6 v6)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3,T4,T5,T6,T7> Tuple.Tuple7<T1,T2,T3,T4,T5,T6,T7> of(T1 v1,
+                                                                    T2 v2,
+                                                                    T3 v3,
+                                                                    T4 v4,
+                                                                    T5 v5,
+                                                                    T6 v6,
+                                                                    T7 v7)
        +
        • +
      + + + + + +
        +
      • +

        of

        +
        static <T1,T2,T3,T4,T5,T6,T7,T8> Tuple.Tuple8<T1,T2,T3,T4,T5,T6,T7,T8> of(T1 v1,
+                                                                          T2 v2,
+                                                                          T3 v3,
+                                                                          T4 v4,
+                                                                          T5 v5,
+                                                                          T6 v6,
+                                                                          T7 v7,
+                                                                          T8 v8)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html new file mode 100644 index 000000000..376f9237f --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html @@ -0,0 +1,320 @@ + + + + + +BigDecimalArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface BigDecimalArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.math.BigDecimal>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface BigDecimalArbitrary
+extends Arbitrary<java.math.BigDecimal>
    +
    Fluent interface to configure the generation of BigDecimal values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default BigDecimalArbitrary between(java.math.BigDecimal min,
+                                    java.math.BigDecimal max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        BigDecimalArbitrary greaterOrEqual(java.math.BigDecimal min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        BigDecimalArbitrary lessOrEqual(java.math.BigDecimal max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        ofScale

        +
        BigDecimalArbitrary ofScale(int scale)
        +
        Set the scale (maximum number of decimal places) to scale.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.5")
+BigDecimalArbitrary shrinkTowards(java.math.BigDecimal target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html new file mode 100644 index 000000000..3eaae1574 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html @@ -0,0 +1,304 @@ + + + + + +BigIntegerArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface BigIntegerArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.math.BigInteger>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface BigIntegerArbitrary
+extends Arbitrary<java.math.BigInteger>
    +
    Fluent interface to configure the generation of BigInteger values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default BigIntegerArbitrary between(java.math.BigInteger min,
+                                    java.math.BigInteger max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        BigIntegerArbitrary greaterOrEqual(java.math.BigInteger min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        BigIntegerArbitrary lessOrEqual(java.math.BigInteger max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+Arbitrary<java.math.BigInteger> shrinkTowards(java.math.BigInteger target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html new file mode 100644 index 000000000..8b663b0ee --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html @@ -0,0 +1,304 @@ + + + + + +ByteArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface ByteArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Byte>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ByteArbitrary
+extends Arbitrary<java.lang.Byte>
    +
    Fluent interface to configure the generation of Byte and byte values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default ByteArbitrary between(byte min,
+                              byte max)
        +
        Set the allowed lower min (included) and upper max (included) bounds of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        ByteArbitrary greaterOrEqual(byte min)
        +
        Set the allowed lower min (included) bound of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        ByteArbitrary lessOrEqual(byte max)
        +
        Set the allowed upper max (included) bound of generated numbers.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+Arbitrary<java.lang.Byte> shrinkTowards(int target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html new file mode 100644 index 000000000..26567023a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html @@ -0,0 +1,375 @@ + + + + + +CharacterArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface CharacterArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Character>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface CharacterArbitrary
+extends Arbitrary<java.lang.Character>
    +
    Fluent interface to configure the generation of Character and char values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        all

        +
        CharacterArbitrary all()
        +
        Allow all unicode chars to show up in generated values. + + Resets previous settings.
        +
        • +
      + + + +
        +
      • +

        between

        +
        @Deprecated
+ @API(status=DEPRECATED)
+default CharacterArbitrary between(char min,
+                                                                        char max)
        +
        Deprecated. Use range(char, char) instead.
        +
        Allow all chars within min (included) and max (included) to show up in generated values.
        +
        • +
      + + + +
        +
      • +

        with

        +
        @API(status=MAINTAINED,
+     since="1.1.3")
+CharacterArbitrary with(char... allowedChars)
        +
        Allow all chars in chars show up in generated values. + + Adds to all already allowed chars.
        +
        • +
      + + + +
        +
      • +

        range

        +
        @API(status=MAINTAINED,
+     since="1.1.3")
+CharacterArbitrary range(char min,
+                                                                     char max)
        +
        Allow all chars within min (included) and max (included) to show up in generated values. + + Adds to all already allowed chars.
        +
        • +
      + + + +
        +
      • +

        ascii

        +
        CharacterArbitrary ascii()
        +
        Allow all ascii chars to show up in generated values. + + Adds to all already allowed chars.
        +
        • +
      + + + +
        +
      • +

        digit

        +
        CharacterArbitrary digit()
        +
        Allow all numeric chars (digits) to show up in generated values. + + Adds to all already allowed chars.
        +
        • +
      + + + +
        +
      • +

        whitespace

        +
        @API(status=MAINTAINED,
+     since="1.1.3")
+CharacterArbitrary whitespace()
        +
        Allow all whitespace chars to show up in generated values. + + Adds to all already allowed chars.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html new file mode 100644 index 000000000..d916be486 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html @@ -0,0 +1,320 @@ + + + + + +DoubleArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface DoubleArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Double>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface DoubleArbitrary
+extends Arbitrary<java.lang.Double>
    +
    Fluent interface to configure the generation of Double and double values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default DoubleArbitrary between(double min,
+                                double max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        DoubleArbitrary greaterOrEqual(double min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        DoubleArbitrary lessOrEqual(double max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        ofScale

        +
        DoubleArbitrary ofScale(int scale)
        +
        Set the scale (maximum number of decimal places) to scale.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.5")
+DoubleArbitrary shrinkTowards(double target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html new file mode 100644 index 000000000..2e86defa1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html @@ -0,0 +1,320 @@ + + + + + +FloatArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface FloatArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Float>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface FloatArbitrary
+extends Arbitrary<java.lang.Float>
    +
    Fluent interface to configure the generation of Float and float values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default FloatArbitrary between(float min,
+                               float max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        FloatArbitrary greaterOrEqual(float min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        FloatArbitrary lessOrEqual(float max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        ofScale

        +
        FloatArbitrary ofScale(int scale)
        +
        Set the scale (maximum number of decimal places) to scale.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.5")
+FloatArbitrary shrinkTowards(float target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html new file mode 100644 index 000000000..791e979f6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html @@ -0,0 +1,304 @@ + + + + + +IntegerArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface IntegerArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Integer>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface IntegerArbitrary
+extends Arbitrary<java.lang.Integer>
    +
    Fluent interface to configure the generation of Integer and int values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default IntegerArbitrary between(int min,
+                                 int max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        IntegerArbitrary greaterOrEqual(int min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        IntegerArbitrary lessOrEqual(int max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+Arbitrary<java.lang.Integer> shrinkTowards(int target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html new file mode 100644 index 000000000..d1c3a17e1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html @@ -0,0 +1,304 @@ + + + + + +LongArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface LongArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Long>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface LongArbitrary
+extends Arbitrary<java.lang.Long>
    +
    Fluent interface to configure the generation of Long and long values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default LongArbitrary between(long min,
+                              long max)
        +
        Set the allowed lower min (included) and upper max (included) bounds of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        LongArbitrary greaterOrEqual(long min)
        +
        Set the allowed lower min (included) bound of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        LongArbitrary lessOrEqual(long max)
        +
        Set the allowed upper max (included) bound of generated numbers.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+LongArbitrary shrinkTowards(long target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html new file mode 100644 index 000000000..230001dcd --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html @@ -0,0 +1,304 @@ + + + + + +ShortArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface ShortArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.Short>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ShortArbitrary
+extends Arbitrary<java.lang.Short>
    +
    Fluent interface to configure the generation of Short and short values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        between

        +
        default ShortArbitrary between(short min,
+                               short max)
        +
        Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        greaterOrEqual

        +
        ShortArbitrary greaterOrEqual(short min)
        +
        Set the allowed lower min (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        lessOrEqual

        +
        ShortArbitrary lessOrEqual(short max)
        +
        Set the allowed upper max (included) bounder of generated numbers.
        +
        • +
      + + + +
        +
      • +

        shrinkTowards

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.4")
+Arbitrary<java.lang.Short> shrinkTowards(short target)
        +
        Set shrinking target to target which must be between the allowed bounds.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html new file mode 100644 index 000000000..a798c2e20 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html @@ -0,0 +1,288 @@ + + + + + +SizableArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface SizableArbitrary<U>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<U>
    +
    +
    +
    All Known Subinterfaces:
    +
    ActionSequenceArbitrary<M>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface SizableArbitrary<U>
+extends Arbitrary<U>
    +
    Fluent interface to configure arbitraries that have size constraints for generated values, e.g. collections and arrays.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ofSize

        +
        default SizableArbitrary<U> ofSize(int size)
        +
        Fix the size to size.
        +
        • +
      + + + +
        +
      • +

        ofMinSize

        +
        SizableArbitrary<U> ofMinSize(int minSize)
        +
        Set lower size boundary minSize (included).
        +
        • +
      + + + +
        +
      • +

        ofMaxSize

        +
        SizableArbitrary<U> ofMaxSize(int maxSize)
        +
        Set upper size boundary maxSize (included).
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html new file mode 100644 index 000000000..5f9980241 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html @@ -0,0 +1,414 @@ + + + + + +StringArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface StringArbitrary

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<java.lang.String>
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface StringArbitrary
+extends Arbitrary<java.lang.String>
    +
    Fluent interface to configure arbitraries that generate String values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        ofMaxLength

        +
        StringArbitrary ofMaxLength(int maxLength)
        +
        Set the maximum allowed length maxLength (included) of generated strings.
        +
        • +
      + + + +
        +
      • +

        ofMinLength

        +
        StringArbitrary ofMinLength(int minLength)
        +
        Set the minimum allowed length mixLength (included) of generated strings.
        +
        • +
      + + + +
        +
      • +

        ofLength

        +
        default StringArbitrary ofLength(int length)
        +
        Fix the length to length of generated strings.
        +
        • +
      + + + +
        +
      • +

        withChars

        +
        StringArbitrary withChars(char... chars)
        +
        Allow all chars in chars to show up in generated strings. + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        withCharRange

        +
        StringArbitrary withCharRange(char from,
+                              char to)
        +
        Allow all chars within from (included) and to (included) to show up in generated strings. + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        ascii

        +
        StringArbitrary ascii()
        +
        Allow all ascii chars to show up in generated strings. + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        alpha

        +
        StringArbitrary alpha()
        +
        Allow all alpha chars to show up in generated strings. + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        numeric

        +
        StringArbitrary numeric()
        +
        Allow all numeric chars (digits) to show up in generated strings. + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        whitespace

        +
        StringArbitrary whitespace()
        +
        Allow all chars that will return true for + Character.isWhitespace(char). + + Can be combined with other methods that allow chars.
        +
        • +
      + + + +
        +
      • +

        all

        +
        StringArbitrary all()
        +
        Allow all unicode chars even noncharacters and private use characters + but only in plane 0 (aka Basic Multilingual Plane)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html new file mode 100644 index 000000000..2f3e4a28e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html @@ -0,0 +1,409 @@ + + + + + +TypeArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.arbitraries
+

Interface TypeArbitrary<T>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Arbitrary<T>
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.1")
+public interface TypeArbitrary<T>
+extends Arbitrary<T>
    +
    Fluent interface to configure arbitraries that try to generate instances + of a given type T from the type's available constructors and factory methods. + +

    + When constructors and factory methods have parameters those parameters will be resolved + by searching for matching registered arbitrary providers. + The searching is performed either globally or in the property method's specified + domain contexts. +

    +
    +
    See Also:
    +
    Domain, +DomainContext
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        use

        +
        TypeArbitrary<T> use(java.lang.reflect.Executable creator)
        +
        Add another creator (function or constructor) to be used + for generating values of type T
        +
        +
        Parameters:
        +
        creator - The static function or constructor
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        usePublicConstructors

        +
        TypeArbitrary<T> usePublicConstructors()
        +
        Add public constructors of class T to be used + for generating values of type T
        +
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        useAllConstructors

        +
        TypeArbitrary<T> useAllConstructors()
        +
        Add all constructors (public, private or package scope) of class T to be used + for generating values of type T
        +
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        useConstructors

        +
        TypeArbitrary<T> useConstructors(java.util.function.Predicate<? super java.lang.reflect.Constructor<?>> filter)
        +
        Add all constructors (public, private or package scope) of class T to be used + for generating values of type T
        +
        +
        Parameters:
        +
        filter - Predicate to add only those constructors for which the predicate returns true
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        usePublicFactoryMethods

        +
        TypeArbitrary<T> usePublicFactoryMethods()
        +
        Add public factory methods (static methods with return type T) + of class T to be used for generating values of type T
        +
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        useAllFactoryMethods

        +
        TypeArbitrary<T> useAllFactoryMethods()
        +
        Add all factory methods (static methods with return type T) + of class T to be used for generating values of type T
        +
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        useFactoryMethods

        +
        TypeArbitrary<T> useFactoryMethods(java.util.function.Predicate<java.lang.reflect.Method> filter)
        +
        Add all factory methods (static methods with return type T) + of class T to be used for generating values of type T
        +
        +
        Parameters:
        +
        filter - Predicate to add only those factory methods for which the predicate returns true
        +
        Returns:
        +
        the same arbitrary instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-frame.html new file mode 100644 index 000000000..3bb3df44c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-frame.html @@ -0,0 +1,31 @@ + + + + + +net.jqwik.api.arbitraries (documentation 1.1.6 API) + + + + + +

net.jqwik.api.arbitraries

+
+

Interfaces

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-summary.html new file mode 100644 index 000000000..b4b31d95a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-summary.html @@ -0,0 +1,209 @@ + + + + + +net.jqwik.api.arbitraries (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.arbitraries

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-tree.html new file mode 100644 index 000000000..606455da3 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/package-tree.html @@ -0,0 +1,146 @@ + + + + + +net.jqwik.api.arbitraries Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.arbitraries

+Package Hierarchies: + +
+
+

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurationException.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurationException.html new file mode 100644 index 000000000..a226a5cdb --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurationException.html @@ -0,0 +1,232 @@ + + + + + +ArbitraryConfigurationException (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.configurators
+

Class ArbitraryConfigurationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public class ArbitraryConfigurationException
+extends JqwikException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html new file mode 100644 index 000000000..857b77ae5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html @@ -0,0 +1,288 @@ + + + + + +ArbitraryConfigurator (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.configurators
+

Interface ArbitraryConfigurator

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Comparable<ArbitraryConfigurator>
    +
    +
    +
    All Known Implementing Classes:
    +
    ArbitraryConfiguratorBase
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ArbitraryConfigurator
+extends java.lang.Comparable<ArbitraryConfigurator>
    +
    Implementors can modify any arbitrary before it's being used for value generation. + Most implementations use ArbitraryConfiguratorBase to derive from + +

    + Implementations must be registered in /META-INF/services/net.jqwik.api.configurators.ArbitraryConfigurator + so that they will be automatically considered for arbitrary configuration. +

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        configure

        +
        <T> Arbitrary<T> configure(Arbitrary<T> arbitrary,
+                           TypeUsage targetType)
        +
        Configure a given arbitrary and return the configured instance.
        +
        +
        Parameters:
        +
        arbitrary - The arbitrary instance to be configured
        +
        targetType - The type of the object to be generated by the arbitrary
        +
        Returns:
        +
        the newly configured arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        order

        +
        default int order()
        +
        Determines the order in which a configurator will be applied in regards to other configurators. + Default value is 100. Use lower values to enforce earlier application and + higher values for later application.
        +
        +
        Returns:
        +
        the order
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfiguratorBase.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfiguratorBase.html new file mode 100644 index 000000000..799192f7d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfiguratorBase.html @@ -0,0 +1,334 @@ + + + + + +ArbitraryConfiguratorBase (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.configurators
+

Class ArbitraryConfiguratorBase

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArbitraryConfiguratorBase

        +
        public ArbitraryConfiguratorBase()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        configure

        +
        public <T> Arbitrary<T> configure(Arbitrary<T> arbitrary,
+                                  TypeUsage targetType)
        +
        Description copied from interface: ArbitraryConfigurator
        +
        Configure a given arbitrary and return the configured instance.
        +
        +
        Specified by:
        +
        configure in interface ArbitraryConfigurator
        +
        Parameters:
        +
        arbitrary - The arbitrary instance to be configured
        +
        targetType - The type of the object to be generated by the arbitrary
        +
        Returns:
        +
        the newly configured arbitrary instance
        +
        +
        • +
      + + + +
        +
      • +

        acceptTargetType

        +
        protected boolean acceptTargetType(TypeUsage targetType)
        +
        Override if configurator only works for certain types of domain objects
        +
        +
        Parameters:
        +
        targetType - The concrete domain type to be generated
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/SelfConfiguringArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/SelfConfiguringArbitrary.html new file mode 100644 index 000000000..9416f7b1b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/SelfConfiguringArbitrary.html @@ -0,0 +1,249 @@ + + + + + +SelfConfiguringArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.configurators
+

Interface SelfConfiguringArbitrary<T>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-frame.html new file mode 100644 index 000000000..f8e04eee5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-frame.html @@ -0,0 +1,29 @@ + + + + + +net.jqwik.api.configurators (documentation 1.1.6 API) + + + + + +

net.jqwik.api.configurators

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-summary.html new file mode 100644 index 000000000..3bee1af6e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-summary.html @@ -0,0 +1,187 @@ + + + + + +net.jqwik.api.configurators (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.configurators

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-tree.html new file mode 100644 index 000000000..3e5589abd --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/configurators/package-tree.html @@ -0,0 +1,161 @@ + + + + + +net.jqwik.api.configurators Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.configurators

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html new file mode 100644 index 000000000..831211d9a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html @@ -0,0 +1,178 @@ + + + + + +AlphaChars (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type AlphaChars

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @LowerChars
+ @UpperChars
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface AlphaChars
    +
    Constrain the chars used to generate Strings or Characters to upper and lower case chars. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html new file mode 100644 index 000000000..ef0c9d87c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html @@ -0,0 +1,251 @@ + + + + + +BigRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type BigRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface BigRange
    +
    Constrain the range of a generated "Big" number. +

    + Applies to BigInteger and BigDecimal parameters which are also annotated with @ForAll.

    +
    +
    See Also:
    +
    ForAll, +ByteRange, +ShortRange, +IntRange, +LongRange, +FloatRange, +DoubleRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringmax 
      java.lang.Stringmin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract java.lang.String min
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract java.lang.String max
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html new file mode 100644 index 000000000..c76db6ce0 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html @@ -0,0 +1,251 @@ + + + + + +ByteRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type ByteRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface ByteRange
    +
    Constrain the range of a generated byte or Byte parameters. + + Applies to byte or Byte parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ShortRange, +IntRange, +LongRange, +FloatRange, +DoubleRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      bytemax 
      bytemin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract byte min
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract byte max
        +
        +
        Default:
        +
        127
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html new file mode 100644 index 000000000..20dafcfa6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html @@ -0,0 +1,263 @@ + + + + + +CharRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type CharRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Repeatable(value=CharRangeList.class)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface CharRange
    +
    Constrain the chars used to generate Strings or Characters to chars in the range + from from to to. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll, +Chars
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      charto 
      +
      • +
    + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      charfrom 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        to

        +
        public abstract char to
        +
        • +
      +
      • +
    + +
      +
    • + + +
        +
      • +

        from

        +
        public abstract char from
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRangeList.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRangeList.html new file mode 100644 index 000000000..ede6ce44d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRangeList.html @@ -0,0 +1,214 @@ + + + + + +CharRangeList (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type CharRangeList

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface CharRangeList
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      CharRange[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html new file mode 100644 index 000000000..5b83df05a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html @@ -0,0 +1,227 @@ + + + + + +Chars (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Chars

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Repeatable(value=CharsList.class)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Chars
    +
    Constrain the chars used to generate Strings or Characters to chars + contained in value. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll, +CharRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      char[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract char[] value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharsList.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharsList.html new file mode 100644 index 000000000..2e3fba68a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharsList.html @@ -0,0 +1,214 @@ + + + + + +CharsList (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type CharsList

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface CharsList
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Chars[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Chars[] value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html new file mode 100644 index 000000000..43e6d4e7d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html @@ -0,0 +1,251 @@ + + + + + +DoubleRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type DoubleRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface DoubleRange
    +
    Constrain the range of a generated double or Double parameters. + + Applies to double or Double parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ByteRange, +ShortRange, +IntRange, +LongRange, +FloatRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      doublemax 
      doublemin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract double min
        +
        +
        Default:
        +
        0.0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract double max
        +
        +
        Default:
        +
        1.7976931348623157E308
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html new file mode 100644 index 000000000..59e4f4126 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html @@ -0,0 +1,251 @@ + + + + + +FloatRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type FloatRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface FloatRange
    +
    Constrain the range of a generated float or Float parameters. + + Applies to float or Float parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ByteRange, +ShortRange, +IntRange, +LongRange, +DoubleRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      floatmax 
      floatmin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract float min
        +
        +
        Default:
        +
        0.0f
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract float max
        +
        +
        Default:
        +
        3.4028234663852886E38f
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html new file mode 100644 index 000000000..625f9f594 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html @@ -0,0 +1,251 @@ + + + + + +IntRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type IntRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface IntRange
    +
    Constrain the range of a generated int or Integer parameters. + + Applies to int or Integer parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ByteRange, +ShortRange, +LongRange, +FloatRange, +DoubleRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmax 
      intmin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract int min
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract int max
        +
        +
        Default:
        +
        2147483647
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html new file mode 100644 index 000000000..48fd3a677 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html @@ -0,0 +1,251 @@ + + + + + +LongRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type LongRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface LongRange
    +
    Constrain the range of a generated long or BigInteger parameters. + + Applies to long or Long parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ByteRange, +ShortRange, +IntRange, +FloatRange, +DoubleRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      longmax 
      longmin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract long min
        +
        +
        Default:
        +
        0L
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract long max
        +
        +
        Default:
        +
        9223372036854775807L
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html new file mode 100644 index 000000000..d30ff15e5 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html @@ -0,0 +1,178 @@ + + + + + +LowerChars (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type LowerChars

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @CharRange(from=97,
+           to=122)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface LowerChars
    +
    Constrain the chars used to generate Strings or Characters to lower case chars. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html new file mode 100644 index 000000000..e78f411d2 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html @@ -0,0 +1,174 @@ + + + + + +Negative (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Negative

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Negative
    +
    Constrain the range of a generated number to be less than 0. + + Applies to numeric parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +Positive
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html new file mode 100644 index 000000000..114ca8b21 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html @@ -0,0 +1,178 @@ + + + + + +NotEmpty (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type NotEmpty

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Size(min=1)
+ @StringLength(min=1)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface NotEmpty
    +
    Constrain the size of generated "sizable" types to be at least 1. + + Applies to String, List, Set, Stream, and arrays which are also annotated with @ForAll. + + Can be combined with @Size(max=XXX) or @StringLength(max=XXX).
    +
    +
    See Also:
    +
    ForAll, +Size
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html new file mode 100644 index 000000000..b4dea1649 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html @@ -0,0 +1,179 @@ + + + + + +NumericChars (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type NumericChars

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @CharRange(from=48,
+           to=57)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface NumericChars
    +
    Constrain the chars used to generate Strings or Characters to digits. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll, +AlphaChars
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html new file mode 100644 index 000000000..6924ce483 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html @@ -0,0 +1,174 @@ + + + + + +Positive (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Positive

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Positive
    +
    Constrain the range of a generated number to be greater than 0. + + Applies to numeric parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +Negative
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html new file mode 100644 index 000000000..f426c883d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html @@ -0,0 +1,222 @@ + + + + + +Scale (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Scale

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Scale
    +
    Use to constrain the maximum number of decimal places when generating decimal numbers. + If not specified the scale is 2 by default. + + Applies to Float, Double and BigDecimal parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      intvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract int value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html new file mode 100644 index 000000000..7fcbd8751 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html @@ -0,0 +1,251 @@ + + + + + +ShortRange (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type ShortRange

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface ShortRange
    +
    Constrain the range of a generated short or Short parameters. + + Applies to short or Short parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll, +ByteRange, +IntRange, +LongRange, +FloatRange, +DoubleRange, +BigRange
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      shortmax 
      shortmin 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract short min
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract short max
        +
        +
        Default:
        +
        32767
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html new file mode 100644 index 000000000..beb978237 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html @@ -0,0 +1,265 @@ + + + + + +Size (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Size

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Size
    +
    Constrain the size of generated "sizable" types. + + Applies to List, Set, Stream, and arrays which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmax 
      intmin 
      intvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract int min
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract int max
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        value

        +
        public abstract int value
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html new file mode 100644 index 000000000..1d4c1e8ca --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html @@ -0,0 +1,265 @@ + + + + + +StringLength (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type StringLength

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface StringLength
    +
    Constrain the length of generated Strings. + + Applies to String parameters which are also annotated with @ForAll.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmax 
      intmin 
      intvalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract int value
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        min

        +
        public abstract int min
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        max

        +
        public abstract int max
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html new file mode 100644 index 000000000..e3038c214 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html @@ -0,0 +1,175 @@ + + + + + +Unique (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Unique

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Unique
    +
    Make a generated value to be unique withing the same try. + +

    + Applies to any embedded types of a parameter that is annotated with @ForAll. +

    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html new file mode 100644 index 000000000..6a46ce41c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html @@ -0,0 +1,180 @@ + + + + + +UpperChars (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type UpperChars

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @CharRange(from=65,
+           to=90)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface UpperChars
    +
    Constrain the chars used to generate Strings or Characters to upper and lower case chars. + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll, +LowerChars, +AlphaChars
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html new file mode 100644 index 000000000..788ddf527 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html @@ -0,0 +1,234 @@ + + + + + +UseType (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type UseType

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=EXPERIMENTAL,
+     since="1.1")
+public @interface UseType
    +
    Generate a value from the annotated class' or type's constructors or factory methods. + +

    + Applies to any parameter that is annotated with @ForAll. + Only the raw type of a parameter is considered. + Parameterized and generic types are forbidden. +

    + +

    + If no value is given, the default is to use public constructors and + factory methods from the annotated type. +

    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      UseTypeMode[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract UseTypeMode[] value
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html new file mode 100644 index 000000000..a55442be6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html @@ -0,0 +1,380 @@ + + + + + +UseTypeMode (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Enum UseTypeMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<UseTypeMode>
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.1")
+public enum UseTypeMode
+extends java.lang.Enum<UseTypeMode>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        CONSTRUCTORS

        +
        public static final UseTypeMode CONSTRUCTORS
        +
        • +
      + + + +
        +
      • +

        FACTORIES

        +
        public static final UseTypeMode FACTORIES
        +
        • +
      + + + +
        +
      • +

        PUBLIC_CONSTRUCTORS

        +
        public static final UseTypeMode PUBLIC_CONSTRUCTORS
        +
        • +
      + + + +
        +
      • +

        PUBLIC_FACTORIES

        +
        public static final UseTypeMode PUBLIC_FACTORIES
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static UseTypeMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (UseTypeMode c : UseTypeMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static UseTypeMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html new file mode 100644 index 000000000..4555edaf7 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html @@ -0,0 +1,178 @@ + + + + + +Whitespace (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type Whitespace

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface Whitespace
    +
    Constrain the chars used to generate Strings or Characters to chars + that will return true for Character.isWhitespace(char). + + Applies to String or Character parameters which are also annotated with @ForAll. + + When used with String parameters it can be combined with other char constraining annotations. + In that case the set of possible characters is expanded by each annotation.
    +
    +
    See Also:
    +
    ForAll, +Chars
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html new file mode 100644 index 000000000..581843dad --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html @@ -0,0 +1,227 @@ + + + + + +WithNull (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.constraints
+

Annotation Type WithNull

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,PARAMETER,TYPE_USE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=MAINTAINED,
+     since="1.0")
+public @interface WithNull
    +
    Allows jqwik to inject null parameters into generated values. + + Applies to any parameter which is also annotated with @ForAll. + + value specifies the probability between 0 and 1.0 to use for injecting null values.
    +
    +
    See Also:
    +
    ForAll
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      doublevalue 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract double value
        +
        +
        Default:
        +
        0.1
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-frame.html new file mode 100644 index 000000000..b56da9450 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-frame.html @@ -0,0 +1,48 @@ + + + + + +net.jqwik.api.constraints (documentation 1.1.6 API) + + + + + +

net.jqwik.api.constraints

+
+

Enums

+ +

Annotation Types

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-summary.html new file mode 100644 index 000000000..fea5e8969 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-summary.html @@ -0,0 +1,300 @@ + + + + + +net.jqwik.api.constraints (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.constraints

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-tree.html new file mode 100644 index 000000000..492f13c30 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/constraints/package-tree.html @@ -0,0 +1,167 @@ + + + + + +net.jqwik.api.constraints Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.constraints

+Package Hierarchies: + +
+
+

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html new file mode 100644 index 000000000..af6c5a5d1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html @@ -0,0 +1,397 @@ + + + + + +AbstractDomainContextBase (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.domains
+

Class AbstractDomainContextBase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DomainContext
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.1")
+public abstract class AbstractDomainContextBase
+extends java.lang.Object
+implements DomainContext
    +
    Subclass for easier implementation of DomainContext
    +
    +
    See Also:
    +
    DomainContext
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/Domain.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/Domain.html new file mode 100644 index 000000000..90e8677c2 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/Domain.html @@ -0,0 +1,299 @@ + + + + + +Domain (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api.domains
+

Annotation Type Domain

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @Repeatable(value=DomainList.class)
+ @API(status=EXPERIMENTAL,
+     since="1.1")
+public @interface Domain
    +
    Use @Domain(MyDomainContext.class) to use only + arbitrary providers and + arbitrary configurators + defined in given context class +

    + You can have many domains on the same element. Providers and configurators + from all domains will be considered. +

    + The priority of ArbitraryProviders and ArbitraryConfigurators can be changed + using priority

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeFields and Description
      static intPRIORITY_NOT_SET 
      +
      • +
    + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Class<? extends DomainContext>value 
      +
      • +
    + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intpriority 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PRIORITY_NOT_SET

        +
        public static final int PRIORITY_NOT_SET
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.Class<? extends DomainContext> value
        +
        • +
      +
      • +
    + +
      +
    • + + +
        +
      • +

        priority

        +
        @API(status=EXPERIMENTAL,
+     since="1.1.1")
+public abstract int priority
        +
        +
        Default:
        +
        -2147483648
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.DomainContextFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.DomainContextFacade.html new file mode 100644 index 000000000..b5d0616b1 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.DomainContextFacade.html @@ -0,0 +1,274 @@ + + + + + +DomainContext.DomainContextFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.domains
+

Class DomainContext.DomainContextFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    DomainContext
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class DomainContext.DomainContextFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract DomainContextglobal() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DomainContextFacade

        +
        public DomainContextFacade()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.Global.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.Global.html new file mode 100644 index 000000000..479baa9e3 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.Global.html @@ -0,0 +1,323 @@ + + + + + +DomainContext.Global (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.domains
+

Class DomainContext.Global

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DomainContext
    +
    +
    +
    Enclosing interface:
    +
    DomainContext
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.1")
+public static class DomainContext.Global
+extends java.lang.Object
+implements DomainContext
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html new file mode 100644 index 000000000..5a8547939 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html @@ -0,0 +1,299 @@ + + + + + +DomainContext (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.domains
+

Interface DomainContext

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setDefaultPriority

        +
        default void setDefaultPriority(int priority)
        +
        • +
      + + + +
        +
      • +

        getArbitraryProviders

        +
        java.util.List<ArbitraryProvider> getArbitraryProviders()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainList.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainList.html new file mode 100644 index 000000000..63e5e66a2 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainList.html @@ -0,0 +1,214 @@ + + + + + +DomainList (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.domains
+

Annotation Type DomainList

+
+
+
+
    +
  • +
    +
    +
    @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
+ @Retention(value=RUNTIME)
+ @Documented
+ @API(status=EXPERIMENTAL,
+     since="1.1")
+public @interface DomainList
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Domain[]value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Domain[] value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-frame.html new file mode 100644 index 000000000..29a6adc0c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-frame.html @@ -0,0 +1,31 @@ + + + + + +net.jqwik.api.domains (documentation 1.1.6 API) + + + + + +

net.jqwik.api.domains

+
+

Interfaces

+ +

Classes

+ +

Annotation Types

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-summary.html new file mode 100644 index 000000000..9670b4d2a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-summary.html @@ -0,0 +1,194 @@ + + + + + +net.jqwik.api.domains (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.domains

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-tree.html new file mode 100644 index 000000000..46f31421c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/domains/package-tree.html @@ -0,0 +1,146 @@ + + + + + +net.jqwik.api.domains Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.domains

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AddLifecycleHook.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AddLifecycleHook.html new file mode 100644 index 000000000..9d9daf42f --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AddLifecycleHook.html @@ -0,0 +1,215 @@ + + + + + +AddLifecycleHook (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Annotation Type AddLifecycleHook

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,METHOD,TYPE})
+ @Retention(value=RUNTIME)
+ @Repeatable(value=LifecycleHooks.class)
+ @API(status=EXPERIMENTAL,
+     since="1.0")
+public @interface AddLifecycleHook
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Class<? extends LifecycleHook>value 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.Class<? extends LifecycleHook> value
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AroundPropertyHook.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AroundPropertyHook.html new file mode 100644 index 000000000..df4fa4e18 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/AroundPropertyHook.html @@ -0,0 +1,333 @@ + + + + + +AroundPropertyHook (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface AroundPropertyHook

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/ContainerLifecycleContext.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/ContainerLifecycleContext.html new file mode 100644 index 000000000..ca9dfd8fc --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/ContainerLifecycleContext.html @@ -0,0 +1,194 @@ + + + + + +ContainerLifecycleContext (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface ContainerLifecycleContext

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    LifecycleContext
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+public interface ContainerLifecycleContext
+extends LifecycleContext
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleContext.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleContext.html new file mode 100644 index 000000000..f18c638f8 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleContext.html @@ -0,0 +1,239 @@ + + + + + +LifecycleContext (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface LifecycleContext

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        label

        +
        java.lang.String label()
        +
        • +
      + + + +
        +
      • +

        annotatedElement

        +
        java.util.Optional<java.lang.reflect.AnnotatedElement> annotatedElement()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHook.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHook.html new file mode 100644 index 000000000..293a9d164 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHook.html @@ -0,0 +1,238 @@ + + + + + +LifecycleHook (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface LifecycleHook<T extends LifecycleHook>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Comparable<T>
    +
    +
    +
    All Known Subinterfaces:
    +
    AroundPropertyHook, SkipExecutionHook
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+public interface LifecycleHook<T extends LifecycleHook>
+extends java.lang.Comparable<T>
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Default Methods 
      Modifier and TypeMethod and Description
      default voidconfigure(java.util.function.Function<java.lang.String,java.util.Optional<java.lang.String>> parameters) 
      +
        +
      • + + +

        Methods inherited from interface java.lang.Comparable

        +compareTo
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        configure

        +
        default void configure(java.util.function.Function<java.lang.String,java.util.Optional<java.lang.String>> parameters)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHooks.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHooks.html new file mode 100644 index 000000000..ac943311c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/LifecycleHooks.html @@ -0,0 +1,214 @@ + + + + + +LifecycleHooks (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Annotation Type LifecycleHooks

+
+
+
+
    +
  • +
    +
    +
    @Target(value={ANNOTATION_TYPE,METHOD,TYPE})
+ @Retention(value=RUNTIME)
+ @API(status=EXPERIMENTAL,
+     since="1.0")
+public @interface LifecycleHooks
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      AddLifecycleHook[]value 
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.Status.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.Status.html new file mode 100644 index 000000000..5b9450eb0 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.Status.html @@ -0,0 +1,371 @@ + + + + + +PropertyExecutionResult.Status (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Enum PropertyExecutionResult.Status

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ABORTED +
      Indicates that the execution of a property was + aborted (started but not finished).
      +
      FAILED +
      Indicates that the execution of a property has + failed.
      +
      SUCCESSFUL +
      Indicates that the execution of a property was + successful.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static PropertyExecutionResult.StatusvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static PropertyExecutionResult.Status[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static PropertyExecutionResult.Status[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (PropertyExecutionResult.Status c : PropertyExecutionResult.Status.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static PropertyExecutionResult.Status valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.html new file mode 100644 index 000000000..de02d9a03 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutionResult.html @@ -0,0 +1,373 @@ + + + + + +PropertyExecutionResult (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Class PropertyExecutionResult

+
+
+ +
+
    +
  • +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+public class PropertyExecutionResult
+extends java.lang.Object
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        failed

        +
        public static PropertyExecutionResult failed(java.lang.Throwable throwable,
+                                             java.lang.String seed,
+                                             java.util.List<java.lang.Object> sample)
        +
        • +
      + + + +
        +
      • +

        aborted

        +
        public static PropertyExecutionResult aborted(java.lang.Throwable throwable,
+                                              java.lang.String seed)
        +
        • +
      + + + +
        +
      • +

        getSeed

        +
        public java.util.Optional<java.lang.String> getSeed()
        +
        • +
      + + + +
        +
      • +

        getFalsifiedSample

        +
        public java.util.Optional<java.util.List<java.lang.Object>> getFalsifiedSample()
        +
        • +
      + + + + + + + +
        +
      • +

        getThrowable

        +
        public java.util.Optional<java.lang.Throwable> getThrowable()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutor.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutor.html new file mode 100644 index 000000000..c4327935d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyExecutor.html @@ -0,0 +1,227 @@ + + + + + +PropertyExecutor (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface PropertyExecutor

+
+
+
+
    +
  • +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+public interface PropertyExecutor
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyLifecycleContext.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyLifecycleContext.html new file mode 100644 index 000000000..6e3505acb --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/PropertyLifecycleContext.html @@ -0,0 +1,260 @@ + + + + + +PropertyLifecycleContext (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface PropertyLifecycleContext

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    LifecycleContext
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+public interface PropertyLifecycleContext
+extends LifecycleContext
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        targetMethod

        +
        java.lang.reflect.Method targetMethod()
        +
        • +
      + + + +
        +
      • +

        containerClass

        +
        java.lang.Class containerClass()
        +
        • +
      + + + +
        +
      • +

        testInstance

        +
        java.lang.Object testInstance()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.SkipResult.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.SkipResult.html new file mode 100644 index 000000000..d8e8f9e2c --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.SkipResult.html @@ -0,0 +1,307 @@ + + + + + +SkipExecutionHook.SkipResult (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Class SkipExecutionHook.SkipResult

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    SkipExecutionHook
    +
    +
    +
    +
    public static class SkipExecutionHook.SkipResult
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        isSkipped

        +
        public boolean isSkipped()
        +
        Whether execution of the context should be skipped.
        +
        +
        Returns:
        +
        true if the execution should be skipped
        +
        +
        • +
      + + + +
        +
      • +

        reason

        +
        public java.util.Optional<java.lang.String> reason()
        +
        Get the reason that execution of the context should be skipped, + if available.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.html new file mode 100644 index 000000000..cb277bbc7 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/SkipExecutionHook.html @@ -0,0 +1,314 @@ + + + + + +SkipExecutionHook (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.lifecycle
+

Interface SkipExecutionHook

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Comparable<SkipExecutionHook>, LifecycleHook<SkipExecutionHook>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @API(status=EXPERIMENTAL,
+     since="1.0")
+ @FunctionalInterface
+public interface SkipExecutionHook
+extends LifecycleHook<SkipExecutionHook>
    +
    Experimental feature. Not ready for public usage yet.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-frame.html new file mode 100644 index 000000000..5301b10bb --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-frame.html @@ -0,0 +1,40 @@ + + + + + +net.jqwik.api.lifecycle (documentation 1.1.6 API) + + + + + +

net.jqwik.api.lifecycle

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Annotation Types

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-summary.html new file mode 100644 index 000000000..4772cf140 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-summary.html @@ -0,0 +1,239 @@ + + + + + +net.jqwik.api.lifecycle (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.lifecycle

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-tree.html new file mode 100644 index 000000000..3e92d960e --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/lifecycle/package-tree.html @@ -0,0 +1,173 @@ + + + + + +net.jqwik.api.lifecycle Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.lifecycle

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-frame.html new file mode 100644 index 000000000..19e2cc95b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-frame.html @@ -0,0 +1,99 @@ + + + + + +net.jqwik.api (documentation 1.1.6 API) + + + + + +

net.jqwik.api

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-summary.html new file mode 100644 index 000000000..dadffdc6a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-summary.html @@ -0,0 +1,491 @@ + + + + + +net.jqwik.api (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-tree.html new file mode 100644 index 000000000..aff3acfd9 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/package-tree.html @@ -0,0 +1,276 @@ + + + + + +net.jqwik.api Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.SubtypeProvider.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.SubtypeProvider.html new file mode 100644 index 000000000..1146c648a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.SubtypeProvider.html @@ -0,0 +1,200 @@ + + + + + +ArbitraryProvider.SubtypeProvider (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.providers
+

Interface ArbitraryProvider.SubtypeProvider

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.Function<TypeUsage,java.util.Set<Arbitrary<?>>>
    +
    +
    +
    Enclosing interface:
    +
    ArbitraryProvider
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public static interface ArbitraryProvider.SubtypeProvider
+extends java.util.function.Function<TypeUsage,java.util.Set<Arbitrary<?>>>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from interface java.util.function.Function

        +andThen, apply, compose, identity
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html new file mode 100644 index 000000000..aa9892e96 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html @@ -0,0 +1,308 @@ + + + + + +ArbitraryProvider (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.providers
+

Interface ArbitraryProvider

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        canProvideFor

        +
        boolean canProvideFor(TypeUsage targetType)
        +
        Return true if the provider is suitable for targetType
        +
        • +
      + + + +
        +
      • +

        provideFor

        +
        java.util.Set<Arbitrary<?>> provideFor(TypeUsage targetType,
+                                       ArbitraryProvider.SubtypeProvider subtypeProvider)
        +
        This is the method you must override in your own implementations of ArbitraryProvider. + It should return a set of arbitrary instances for a given targetType. + + Only targetTypes that have been allowed by canProvideFor(TypeUsage) + will be given to this method. + + subtypeProvider can be used to get the arbitraries for any type argument of targetType.
        +
        • +
      + + + +
        +
      • +

        priority

        +
        default int priority()
        +
        Providers with higher priority will replace providers with lower priority. If there is more than one + provider for a given type with the same priority, there results will add up in a single set of arbitraries + to use. + +
          +
        • Override with value > 0 to replace most of _jqwik_'s default providers.
          • +
        • Override with value > 100 to replace arbitrary provisioning for unrestricted type variables and wildcard types.
          • +
        • Override with value > 100 to replace arbitrary provisioning for plain type Object.
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.TypeUsageFacade.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.TypeUsageFacade.html new file mode 100644 index 000000000..e43ad1669 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.TypeUsageFacade.html @@ -0,0 +1,302 @@ + + + + + +TypeUsage.TypeUsageFacade (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.jqwik.api.providers
+

Class TypeUsage.TypeUsageFacade

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    TypeUsage
    +
    +
    +
    +
    @API(status=INTERNAL)
+public abstract static class TypeUsage.TypeUsageFacade
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TypeUsageFacade() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TypeUsageFacade

        +
        public TypeUsageFacade()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        of

        +
        public abstract TypeUsage of(java.lang.Class<?> type,
+                             TypeUsage... typeParameters)
        +
        • +
      + + + + + + + +
        +
      • +

        forType

        +
        public abstract TypeUsage forType(java.lang.reflect.Type type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.html new file mode 100644 index 000000000..f63a987ea --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/TypeUsage.html @@ -0,0 +1,593 @@ + + + + + +TypeUsage (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.providers
+

Interface TypeUsage

+
+
+
+
    +
  • +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface TypeUsage
    +
    An instance of TypeUsage describes the information available for parameter or return types. + The class is supposed to relieve its users from all the intricacies of the Java reflection API. + Doing that it will resolve meta annotations, repeated annotations as well as annotated type parameters. +

    + TypeUsage provides access to: +

      +
    • the native type of an object
      • +
    • the component type (if it's an array)
      • +
    • the type parameters (again as instances of TypeUsage)
      • +
    • the annotations (if the object is derived from a parameter)
      • +
    • methods to test for compatibility of types that do also handle compatibility + between raw types and boxed type
      • +
    +

    + Within the public API TypeUsage is used in two places: +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static class TypeUsage.TypeUsageFacade 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethod and Description
      booleancanBeAssignedTo(TypeUsage targetType) +
      Check if an instance can be assigned to another TypeUsage instance.
      +
      <A extends java.lang.annotation.Annotation>
      java.util.Optional<A>      		findAnnotation(java.lang.Class<A> annotationType) +
      Return an Optional of the first instance of a specific annotationType + if there is one (directly or indirectly through meta-annotations).
      +
      static TypeUsageforType(java.lang.reflect.Type type) 
      java.util.List<java.lang.annotation.Annotation>getAnnotations() +
      Return all annotations of a parameter (or an annotated type argument).
      +
      java.util.Optional<TypeUsage>getComponentType() +
      Return an Optional of an array's component type - if it is an array.
      +
      java.util.List<TypeUsage>getLowerBounds() +
      Return lower bounds if a generic type is a wildcard.
      +
      java.lang.Class<?>getRawType() +
      Return the raw type which is usually the class or interface you see in a parameters or return values + specification.
      +
      TypeUsagegetTypeArgument(int position) +
      Return the type argument at a specific position.
      +
      java.util.List<TypeUsage>getTypeArguments() +
      Return the type arguments of a generic type in the order of there appearance in a type's declaration.
      +
      java.util.List<TypeUsage>getUpperBounds() +
      Return upper bounds if a generic type is a wildcard or type variable.
      +
      <A extends java.lang.annotation.Annotation>
      boolean      		isAnnotated(java.lang.Class<A> annotationType) +
      Return true if the current instance is annotated (directly or indirectly through meta-annotations) + with a specific annotationType.
      +
      booleanisArray() +
      Return true if a type is an array type.
      +
      booleanisAssignableFrom(java.lang.Class<?> providedClass) +
      Check if a given providedClass is assignable from this generic type.
      +
      booleanisEnum() +
      Return true if a type is an enum type.
      +
      booleanisGeneric() +
      Return true if a type has any type arguments itself.
      +
      booleanisOfType(java.lang.Class<?> aRawType) +
      Check if an instance is of a specific raw type + + Most of the time this is what you want to do when checking for applicability of a + ArbitraryProvider.
      +
      booleanisTypeVariable() +
      Return true if a generic type is a wildcard.
      +
      booleanisTypeVariableOrWildcard() +
      Return true if a generic type is a type variable or a wildcard.
      +
      booleanisWildcard() +
      Return true if a generic type is a wildcard.
      +
      static TypeUsageof(java.lang.Class<?> type, + TypeUsage... typeParameters) 
      static TypeUsagewildcard(TypeUsage upperBound) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        of

        +
        static TypeUsage of(java.lang.Class<?> type,
+                    TypeUsage... typeParameters)
        +
        • +
      + + + + + + + +
        +
      • +

        forType

        +
        static TypeUsage forType(java.lang.reflect.Type type)
        +
        • +
      + + + +
        +
      • +

        getRawType

        +
        java.lang.Class<?> getRawType()
        +
        Return the raw type which is usually the class or interface you see in a parameters or return values + specification. +

        + A raw type always exists.

        +
        • +
      + + + +
        +
      • +

        getUpperBounds

        +
        java.util.List<TypeUsage> getUpperBounds()
        +
        Return upper bounds if a generic type is a wildcard or type variable. + TypeUsage.of(Object.class) is always included.
        +
        • +
      + + + +
        +
      • +

        getLowerBounds

        +
        java.util.List<TypeUsage> getLowerBounds()
        +
        Return lower bounds if a generic type is a wildcard.
        +
        • +
      + + + +
        +
      • +

        isWildcard

        +
        boolean isWildcard()
        +
        Return true if a generic type is a wildcard.
        +
        • +
      + + + +
        +
      • +

        isTypeVariable

        +
        boolean isTypeVariable()
        +
        Return true if a generic type is a wildcard.
        +
        • +
      + + + +
        +
      • +

        isTypeVariableOrWildcard

        +
        boolean isTypeVariableOrWildcard()
        +
        Return true if a generic type is a type variable or a wildcard.
        +
        • +
      + + + +
        +
      • +

        getTypeArguments

        +
        java.util.List<TypeUsage> getTypeArguments()
        +
        Return the type arguments of a generic type in the order of there appearance in a type's declaration.
        +
        • +
      + + + +
        +
      • +

        getTypeArgument

        +
        TypeUsage getTypeArgument(int position)
        +
        Return the type argument at a specific position.
        +
        • +
      + + + +
        +
      • +

        isOfType

        +
        boolean isOfType(java.lang.Class<?> aRawType)
        +
        Check if an instance is of a specific raw type +

        + Most of the time this is what you want to do when checking for applicability of a + ArbitraryProvider.

        +
        • +
      + + + +
        +
      • +

        canBeAssignedTo

        +
        boolean canBeAssignedTo(TypeUsage targetType)
        +
        Check if an instance can be assigned to another TypeUsage instance.
        +
        • +
      + + + +
        +
      • +

        isGeneric

        +
        boolean isGeneric()
        +
        Return true if a type has any type arguments itself.
        +
        • +
      + + + +
        +
      • +

        isEnum

        +
        boolean isEnum()
        +
        Return true if a type is an enum type.
        +
        • +
      + + + +
        +
      • +

        isArray

        +
        boolean isArray()
        +
        Return true if a type is an array type.
        +
        • +
      + + + +
        +
      • +

        getAnnotations

        +
        java.util.List<java.lang.annotation.Annotation> getAnnotations()
        +
        Return all annotations of a parameter (or an annotated type argument). +

        + This list already contains all meta annotations, repeated annotations and annotations + from annotated type arguments. Thus, it does much more than the usual Java reflection API.

        +
        • +
      + + + +
        +
      • +

        findAnnotation

        +
        <A extends java.lang.annotation.Annotation> java.util.Optional<A> findAnnotation(java.lang.Class<A> annotationType)
        +
        Return an Optional of the first instance of a specific annotationType + if there is one (directly or indirectly through meta-annotations).
        +
        • +
      + + + +
        +
      • +

        isAnnotated

        +
        <A extends java.lang.annotation.Annotation> boolean isAnnotated(java.lang.Class<A> annotationType)
        +
        Return true if the current instance is annotated (directly or indirectly through meta-annotations) + with a specific annotationType.
        +
        • +
      + + + +
        +
      • +

        isAssignableFrom

        +
        boolean isAssignableFrom(java.lang.Class<?> providedClass)
        +
        Check if a given providedClass is assignable from this generic type.
        +
        • +
      + + + +
        +
      • +

        getComponentType

        +
        java.util.Optional<TypeUsage> getComponentType()
        +
        Return an Optional of an array's component type - if it is an array.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-frame.html new file mode 100644 index 000000000..b37f00219 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-frame.html @@ -0,0 +1,26 @@ + + + + + +net.jqwik.api.providers (documentation 1.1.6 API) + + + + + +

net.jqwik.api.providers

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-summary.html new file mode 100644 index 000000000..09cdaad59 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-summary.html @@ -0,0 +1,168 @@ + + + + + +net.jqwik.api.providers (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.providers

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-tree.html new file mode 100644 index 000000000..18ac7d18b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/providers/package-tree.html @@ -0,0 +1,145 @@ + + + + + +net.jqwik.api.providers Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.providers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Action.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Action.html new file mode 100644 index 000000000..ccf7b8eca --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Action.html @@ -0,0 +1,263 @@ + + + + + +Action (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.stateful
+

Interface Action<M>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    M -
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface Action<M>
    +
    An action class represents a state change that can be preformed on a model M. + + At runtime the execution of an action is regulated by a precondition.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethod and Description
      default booleanprecondition(M model) +
      If this method returns false, the action will not be performed.
      +
      Mrun(M model) +
      Perform an action on model M and return the same model (if it has state) + or a new one representing the new state.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        precondition

        +
        default boolean precondition(M model)
        +
        If this method returns false, the action will not be performed.
        +
        +
        Parameters:
        +
        model -
        +
        Returns:
        +
        +
        • +
      + + + + + +
        +
      • +

        run

        +
        M run(M model)
        +
        Perform an action on model M and return the same model (if it has state) + or a new one representing the new state.
        +
        +
        Parameters:
        +
        model -
        +
        Returns:
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.RunState.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.RunState.html new file mode 100644 index 000000000..3e8a9821a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.RunState.html @@ -0,0 +1,367 @@ + + + + + +ActionSequence.RunState (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.jqwik.api.stateful
+

Enum ActionSequence.RunState

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ActionSequence.RunStatevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ActionSequence.RunState[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ActionSequence.RunState[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ActionSequence.RunState c : ActionSequence.RunState.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ActionSequence.RunState valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html new file mode 100644 index 000000000..1ec88d5ca --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html @@ -0,0 +1,299 @@ + + + + + +ActionSequence (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.stateful
+

Interface ActionSequence<M>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    M - The type of the model
    +
    +
    +
    +
    @API(status=MAINTAINED,
+     since="1.0")
+public interface ActionSequence<M>
    +
    A sequence of Actions that can be run with a model of type M
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequenceArbitrary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequenceArbitrary.html new file mode 100644 index 000000000..1ced95ba7 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequenceArbitrary.html @@ -0,0 +1,298 @@ + + + + + +ActionSequenceArbitrary (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.stateful
+

Interface ActionSequenceArbitrary<M>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Invariant.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Invariant.html new file mode 100644 index 000000000..0ac445b25 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/Invariant.html @@ -0,0 +1,228 @@ + + + + + +Invariant (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.jqwik.api.stateful
+

Interface Invariant<T>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+ @API(status=MAINTAINED,
+     since="1.0")
+public interface Invariant<T>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        check

        +
        void check(T model)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-frame.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-frame.html new file mode 100644 index 000000000..e3eace14a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-frame.html @@ -0,0 +1,27 @@ + + + + + +net.jqwik.api.stateful (documentation 1.1.6 API) + + + + + +

net.jqwik.api.stateful

+
+

Interfaces

+ +

Enums

+ +
+ + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-summary.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-summary.html new file mode 100644 index 000000000..f74a421fc --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-summary.html @@ -0,0 +1,171 @@ + + + + + +net.jqwik.api.stateful (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.jqwik.api.stateful

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-tree.html b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-tree.html new file mode 100644 index 000000000..f7075392d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/net/jqwik/api/stateful/package-tree.html @@ -0,0 +1,154 @@ + + + + + +net.jqwik.api.stateful Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.jqwik.api.stateful

+Package Hierarchies: + +
+
+

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/overview-frame.html b/docs/docs/1.1.6/javadoc/overview-frame.html new file mode 100644 index 000000000..228946c09 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/overview-frame.html @@ -0,0 +1,28 @@ + + + + + +Overview List (documentation 1.1.6 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/docs/docs/1.1.6/javadoc/overview-summary.html b/docs/docs/1.1.6/javadoc/overview-summary.html new file mode 100644 index 000000000..90d443ad6 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/overview-summary.html @@ -0,0 +1,164 @@ + + + + + +Overview (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

documentation 1.1.6 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
net.jqwik.api 
net.jqwik.api.arbitraries 
net.jqwik.api.configurators 
net.jqwik.api.constraints 
net.jqwik.api.domains 
net.jqwik.api.lifecycle 
net.jqwik.api.providers 
net.jqwik.api.stateful 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/overview-tree.html b/docs/docs/1.1.6/javadoc/overview-tree.html new file mode 100644 index 000000000..434f5593b --- /dev/null +++ b/docs/docs/1.1.6/javadoc/overview-tree.html @@ -0,0 +1,369 @@ + + + + + +Class Hierarchy (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/package-list b/docs/docs/1.1.6/javadoc/package-list new file mode 100644 index 000000000..624b1e3bc --- /dev/null +++ b/docs/docs/1.1.6/javadoc/package-list @@ -0,0 +1,8 @@ +net.jqwik.api +net.jqwik.api.arbitraries +net.jqwik.api.configurators +net.jqwik.api.constraints +net.jqwik.api.domains +net.jqwik.api.lifecycle +net.jqwik.api.providers +net.jqwik.api.stateful diff --git a/docs/docs/1.1.6/javadoc/script.js b/docs/docs/1.1.6/javadoc/script.js new file mode 100644 index 000000000..b34635693 --- /dev/null +++ b/docs/docs/1.1.6/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/docs/1.1.6/javadoc/serialized-form.html b/docs/docs/1.1.6/javadoc/serialized-form.html new file mode 100644 index 000000000..8c1cd773a --- /dev/null +++ b/docs/docs/1.1.6/javadoc/serialized-form.html @@ -0,0 +1,287 @@ + + + + + +Serialized Form (documentation 1.1.6 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/docs/1.1.6/javadoc/stylesheet.css b/docs/docs/1.1.6/javadoc/stylesheet.css new file mode 100644 index 000000000..98055b22d --- /dev/null +++ b/docs/docs/1.1.6/javadoc/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/docs/1.1.6/user-guide.md b/docs/docs/1.1.6/user-guide.md new file mode 100644 index 000000000..3fece6acd --- /dev/null +++ b/docs/docs/1.1.6/user-guide.md @@ -0,0 +1,2730 @@ +--- +title: jqwik User Guide - 1.1.6 +--- +

The jqwik User Guide +1.1.6 +

+ + + + +### Table of Contents + +- [How to Use](#how-to-use) + - [Gradle](#gradle) + - [Seeing jqwik Reporting in Gradle Output](#seeing-jqwik-reporting-in-gradle-output) + - [Maven](#maven) + - [Snapshot Releases](#snapshot-releases) + - [Project without Build Tool](#project-without-build-tool) +- [Creating an Example-based Test](#creating-an-example-based-test) +- [Creating a Property](#creating-a-property) + - [Optional `@Property` Parameters](#optional-property-parameters) + - [Additional Reporting](#additional-reporting) +- [Assertions](#assertions) +- [Lifecycle](#lifecycle) + - [Method Lifecycle](#method-lifecycle) + - [Other Lifecycles](#other-lifecycles) +- [Grouping Tests](#grouping-tests) +- [Naming and Labeling Tests](#naming-and-labeling-tests) +- [Tagging Tests](#tagging-tests) +- [Disabling Tests](#disabling-tests) +- [Default Parameter Generation](#default-parameter-generation) + - [Constraining Default Generation](#constraining-default-generation) + - [Allow Null Values](#allow-null-values) + - [Unique Values](#unique-values) + - [String Length](#string-length) + - [Character Sets](#character-sets) + - [List, Set, Stream and Array Size:](#list-set-stream-and-array-size) + - [Integer Constraints](#integer-constraints) + - [Decimal Constraints](#decimal-constraints) + - [Constraining parameterized types](#constraining-parameterized-types) + - [Providing variable types](#providing-variable-types) +- [Self-Made Annotations](#self-made-annotations) +- [Customized Parameter Generation](#customized-parameter-generation) + - [Static `Arbitraries` methods](#static-arbitraries-methods) + - [Generate values yourself](#generate-values-yourself) + - [Select values randomly](#select-values-randomly) + - [Select randomly with Weights](#select-randomly-with-weights) + - [Integers](#integers) + - [Decimals](#decimals) + - [Characters and Strings](#characters-and-strings) + - [java.util.Random](#javautilrandom) + - [Constants](#constants) + - [Create](#create) + - [Shuffling Permutations](#shuffling-permutations) + - [Default Types](#default-types) + - [Collections, Streams, Arrays and Optional](#collections-streams-arrays-and-optional) + - [Maps](#maps) + - [Collecting Values in a List](#collecting-values-in-a-list) + - [Fluent Configuration Interfaces](#fluent-configuration-interfaces) + - [Generate `null` values](#generate-null-values) + - [Filtering](#filtering) + - [Creating unique values](#creating-unique-values) + - [Mapping](#mapping) + - [Flat Mapping](#flat-mapping) + - [Flat Mapping with Tuple Types](#flat-mapping-with-tuple-types) + - [Randomly Choosing among Arbitraries](#randomly-choosing-among-arbitraries) + - [Combining Arbitraries](#combining-arbitraries) + - [Combining Arbitraries with Builder](#combining-arbitraries-with-builder) + - [Flat Combination](#flat-combination) + - [Fix an Arbitrary's `genSize`](#fix-an-arbitrarys-gensize) + - [Generating all possible values](#generating-all-possible-values) + - [Iterating through all possible values](#iterating-through-all-possible-values) +- [Recursive Arbitraries](#recursive-arbitraries) + - [Probabilistic Recursion](#probabilistic-recursion) + - [Deterministic Recursion](#deterministic-recursion) + - [Deterministic Recursion with `recursive()`](#deterministic-recursion-with-recursive) +- [Contract Tests](#contract-tests) +- [Stateful Testing](#stateful-testing) + - [Specify Actions](#specify-actions) + - [Check Postconditions](#check-postconditions) + - [Number of actions](#number-of-actions) + - [Check Invariants](#check-invariants) +- [Assumptions](#assumptions) +- [Result Shrinking](#result-shrinking) + - [Integrated Shrinking](#integrated-shrinking) + - [Switch Shrinking Off](#switch-shrinking-off) + - [Switch Shrinking to Full Mode](#switch-shrinking-to-full-mode) + - [Change the Shrinking Target](#change-the-shrinking-target) +- [Collecting and Reporting Statistics](#collecting-and-reporting-statistics) +- [Providing Default Arbitraries](#providing-default-arbitraries) + - [Simple Arbitrary Providers](#simple-arbitrary-providers) + - [Arbitrary Providers for Parameterized Types](#arbitrary-providers-for-parameterized-types) + - [Arbitrary Provider Priority](#arbitrary-provider-priority) +- [Create your own Annotations for Arbitrary Configuration](#create-your-own-annotations-for-arbitrary-configuration) + - [Arbitrary Configuration Example: `@Odd`](#arbitrary-configuration-example-odd) +- [Domain and Domain Context](#domain-and-domain-context) + - [Domain example: American Addresses](#domain-example-american-addresses) +- [Generation from a Type's Interface](#generation-from-a-types-interface) +- [Implement your own Arbitraries and Generators](#implement-your-own-arbitraries-and-generators) +- [Exhaustive Generation](#exhaustive-generation) +- [Data-Driven Properties](#data-driven-properties) +- [Rerunning Falsified Properties](#rerunning-falsified-properties) +- [jqwik Configuration](#jqwik-configuration) +- [Release Notes](#release-notes) + + + +## How to Use + +__jqwik__ is an alternative test engine for the +[JUnit 5 platform](https://junit.org/junit5/docs/current/api/org/junit/platform/engine/TestEngine.html). +That means that you can use it either stand-alone or combine it with any other JUnit 5 engine, e.g. +[Jupiter (the standard engine)](https://junit.org/junit5/docs/current/user-guide/#dependency-metadata-junit-jupiter) or +[Vintage (aka JUnit 4)](https://junit.org/junit5/docs/current/user-guide/#dependency-metadata-junit-vintage). +All you have to do is add all needed engines to your `testCompile` dependencies as shown in the +[gradle file](#gradle) below. + +The latest release of __jqwik__ is deployed to [Maven Central](https://mvnrepository.com/). + +Snapshot releases can be fetched from https://oss.sonatype.org/content/repositories/snapshots. + + + +### Gradle + +Since version 4.6, Gradle has +[built-in support for the JUnit platform](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.testing.Test.html). +Set up is rather simple; here are the relevant parts of a project's `build.gradle` file: + + +``` +repositories { + ... + mavenCentral() + + # For snapshot releases only: + maven { url 'https://oss.sonatype.org/content/repositories/snapshots' } + +} + +ext.junitPlatformVersion = '1.4.2' +ext.junitJupiterVersion = '5.4.2' + +ext.jqwikVersion = '1.1.6' + +test { + useJUnitPlatform { + includeEngines "jqwik" + + // includeTags "fast", "medium" + // excludeTags "slow" + } + + include '**/*Properties.class' + include '**/*Test.class' + include '**/*Tests.class' +} + +dependencies { + ... + + // aggregate jqwik dependency + testCompile "net.jqwik:jqwik:${jqwikVersion}" + + // Add if you also want to use the Jupiter engine or Assertions from it + testCompile("org.junit.jupiter:junit-jupiter-engine:5.4.2") + + // Add any other test library you need... + testCompile("org.assertj:assertj-core:3.9.1") + +} +``` + +With version 1.0.0 `net.jqwik:jqwik` has become an aggregating module to simplify jqwik +integration for standard users. +If you want to be more explicit about the real dependencies you can replace this dependency with + +``` + testCompile "net.jqwik:jqwik-api:${jqwikVersion}" + testRuntime "net.jqwik:jqwik-engine:${jqwikVersion}" +``` + +See [the Gradle section in JUnit 5's user guide](https://junit.org/junit5/docs/current/user-guide/#running-tests-build-gradle) +for more details on how to configure Gradle for the JUnit 5 platform. + +#### Seeing jqwik Reporting in Gradle Output + +Since Gradle does not yet support JUnit platform reporting +([see this Github issue](https://github.com/gradle/gradle/issues/4605)) +jqwik has switched to do its own reporting by default. This behaviour +[can be configured](#jqwik-configuration) through parameter `useJunitPlatformReporter` +(default: `false`). + +If you want to see jqwik's reports in the output use Gradle's command line option `--info`: + +``` +> gradle clean test --info +... +mypackage.MyClassProperties > myPropertyMethod STANDARD_OUT + timestamp = 2019-02-28T18:01:14.302, MyClassProperties:myPropertyMethod = + |-----------------------jqwik----------------------- + tries = 1000 | # of calls to property + checks = 1000 | # of not rejected calls + generation-mode = RANDOMIZED | parameters are randomly generated + seed = 1685744359484719817 | random seed to reproduce generated values +``` + +### Maven + +Configure the surefire plugin as described in +[the Maven section in JUnit 5's user guide](https://junit.org/junit5/docs/current/user-guide/#running-tests-build-maven) +and add the following dependency to your `pom.xml` file: + +``` + + ... + + net.jqwik + jqwik + 1.1.6 + test + + +``` + + +### Snapshot Releases + +Snapshot releases are available through Sonatype's +[snapshot repositories](#https://oss.sonatype.org/content/repositories/snapshots). + +Adding + +``` +https://oss.sonatype.org/content/repositories/snapshots +``` + +as a maven repository +will allow you to use _jqwik_'s snapshot release which contains all the latest features. + +### Project without Build Tool + +I've never tried it but using jqwik without gradle or some other tool to manage dependencies should also work. +You will have to add _at least_ the following jars to your classpath: + +- `jqwik-1.1.6.jar` +- `junit-platform-engine-1.4.2.jar` +- `junit-platform-commons-1.4.2.jar` +- `opentest4j-1.1.1.jar` +- `assertj-core-3.11.x.jar` in case you need assertion support + +## Creating an Example-based Test + +Just annotate a `public`, `protected` or package-scoped method with +[`@Example`](/docs/1.1.6/javadoc/net/jqwik/api/Example.html). +Example-based tests work just like plain JUnit-style test cases and +are not supposed to take any parameters. + +A test case method must +- either return a `boolean` value that signifies success (`true`) + or failure (`false`) of this test case. +- or return nothing (`void`) in which case you will probably + use [assertions](#assertions) in order to verify the test condition. + +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ExampleBasedTests.java) +is a test class with two example-based tests: + +```java +import static org.assertj.core.api.Assertions.*; + +import net.jqwik.api.*; +import org.assertj.core.data.*; + +class ExampleBasedTests { + + @Example + void squareRootOf16is4() { + assertThat(Math.sqrt(16)).isCloseTo(4.0, Offset.offset(0.01)); + } + + @Example + boolean add1plu3is4() { + return (1 + 3) == 4; + } +} +``` + +## Creating a Property + +_Properties_ are the core concept of [property-based testing](/#properties). + +You create a _Property_ by annotating a `public`, `protected` +or package-scoped method with +[`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html). +In contrast to examples a property method is supposed to have one or +more parameters, all of which must be annotated with +[`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html). + +At test runtime the exact parameter values of the property method +will be filled in by _jqwik_. + +Just like an example test a property method has to +- either return a `boolean` value that signifies success (`true`) + or failure (`false`) of this property. +- or return nothing (`void`). In that case you will probably + use [assertions](#assertions) to check the property's invariant. + +If not [specified differently](#optional-property-parameters), +_jqwik_ __will run 1000 tries__, i.e. a 1000 different sets of +parameter values and execute the property method with each of those parameter sets. +The first failed execution will stop value generation +and be reported as failure - usually followed by an attempt to +[shrink](#result-shrinking) the falsified parameter set. + +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/PropertyBasedTests.java) +are two properties whose failures might surprise you: + +```java +import net.jqwik.api.*; +import org.assertj.core.api.*; + +class PropertyBasedTests { + + @Property + boolean absoluteValueOfAllNumbersIsPositive(@ForAll int anInteger) { + return Math.abs(anInteger) >= 0; + } + + @Property + void lengthOfConcatenatedStringIsGreaterThanLengthOfEach( + @ForAll String string1, @ForAll String string2 + ) { + String conc = string1 + string2; + Assertions.assertThat(conc.length()).isGreaterThan(string1.length()); + Assertions.assertThat(conc.length()).isGreaterThan(string2.length()); + } +} +``` + +Currently _jqwik_ cannot deal with parameters that are not +annotated with '@ForAll'. However, this might change +in future versions. + +### Optional `@Property` Parameters + +The [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) +annotation has a few optional values: + +- `int tries`: The number of times _jqwik_ tries to generate parameter values for this method. + + The default is `1000` which can be overridden in [`jqwik.properties`](#jqwik-configuration). + +- `String seed`: The _random seed_ to use for generating values. If you do not specify a values + _jqwik_ will use a random _random seed_. The actual seed used is being reported by + each run property. + +- `int maxDiscardRatio`: The maximal number of tried versus actually checked property runs + in case you are using [Assumptions](#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`](#jqwik-configuration). + +- `ShrinkingMode shrinking`: You can influence the way shrinking is done + - `ShrinkingMode.OFF`: No shrinking at all + - `ShrinkingMode.FULL`: Shrinking continues until no smaller value can + be found that also falsifies the property. + This might take very long or not end at all in rare cases. + - `ShrinkingMode.BOUNDED`: Shrinking is tried to a depth of 1000 steps + maximum per value. This is the default. + + Most of the time you want to stick with the default. Only if + bounded shrinking is reported - look at a falsified property's output! - + should you try with `ShrinkingMode.FULL`. + +- `GenerationMode generation`: You can direct _jqwik_ about the principal approach + it takes towards value generation. + + - `GenerationMode.AUTO` is the default. This will choose [exhaustive generation](#exhaustive-generation) + whenever this is deemed sensible, i.e., when the maximum number of generated values is + equal or less thant the configured `tries` attribute. + - `GenerationMode.RANDOMIZED` directs _jqwik_ to always generate values using its + randomized generators. + - `GenerationMode.EXHAUSTIVE` directs _jqwik_ to use [exhaustive generation](#exhaustive-generation) + if the arbitraries in use support exhaustive generation at all and if the calculated + maximum number of different values to generate is below `Integer.MAX_VALUE`. + - `GenerationMode.DATA_DRIVEN` directs _jqwik_ to feed values from a data provider + specified with `@FromData`. See [data-driven properties](#data-driven-properties) + for more information. + + The actual generation mode being used is reported for each property + together with the other information: + + ``` + tries = 10 + checks = 10 + generation-mode = EXHAUSTIVE + seed = 42859154278924201 + ``` + + +### Additional Reporting + +You can switch on additional reporting aspects by adding a +[`@Report(Reporting[])` annotation](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) +to a property method. + +The following reporting aspects are available: + +- `Reporting.GENERATED` will report each generated set of parameters. +- `Reporting.FALSIFIED` will report each set of parameters + that is falsified during shrinking. + +## Assertions + +__jqwik__ does not come with any assertions, so you have to use one of the +third-party assertion libraries, e.g. [Hamcrest](http://hamcrest.org/) or +[AssertJ](http://joel-costigliola.github.io/assertj/). + +If you have Jupiter in your test dependencies anyway, you can also use the +static methods in `org.junit.jupiter.api.Assertions`. + +## Lifecycle + +### Method Lifecycle + +The current lifecycle of jqwik test methods is rather simple: + +- For each method, annotated with + [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) + or [`@Example`](/docs/1.1.6/javadoc/net/jqwik/api/Example.html), + a new instance of the containing test class is created + in order to keep the individual tests isolated from each other. +- If you have preparatory work to do for each method, + create a constructor without parameters and do the work there. +- If you have cleanup work to do for each method, + the containing test class can implement `java.lang.AutoCloseable`. + The `close`-Method will be called after each test method execution. + +```java +import net.jqwik.api.*; + +class TestsWithLifecycle implements AutoCloseable { + + TestsWithLifecycle() { + System.out.println("Before each"); + } + + @Example void anExample() { + System.out.println("anExample"); + } + + @Property(tries = 5) + void aProperty(@ForAll String aString) { + System.out.println("anProperty: " + aString); + } + + @Override + public void close() throws Exception { + System.out.println("After each"); + } +} +``` + +[In this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TestsWithLifecycle.java) +both the constructor and `close()` will be called twice times: +Once for `anExample()` and once for `aProperty(...)`. + +### Other Lifecycles + +Currently _jqwik_ does not have special support for a lifecycle per test container, +per test try or even package. Later versions of _jqwik_ might possible bring +more features in that field. +[Create an issue on github](https://github.com/jlink/jqwik/issues) with your concrete needs. + + +## Grouping Tests + +Within a containing test class you can group other containers by embedding +another non-static and non-private inner class and annotating it with `@Group`. +Grouping examples and properties is a means to improve the organization and +maintainability of your tests. + +Groups can be nested and there lifecycle is also nested, that means that +the lifecycle of a test class is also applied to inner groups of that container. +Have a look at [this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TestsWithGroups.java): + +```java +import net.jqwik.api.*; + +class TestsWithGroups { + + @Property + void outer(@ForAll String aString) { + } + + @Group + class Group1 { + @Property + void group1Property(@ForAll String aString) { + } + + @Group + class Subgroup { + @Property + void subgroupProperty(@ForAll String aString) { + } + } + } + + @Group + class Group2 { + @Property + void group2Property(@ForAll String aString) { + } + } +} +``` + +## Naming and Labeling Tests + +Using Java-style camel case naming for your test container classes and property methods +will sometimes lead to hard to read display names in your test reports +and your IDE. +Therefore, _jqwik_ provides a simple way to insert spaces +into the displayed name of your test container or property: +just add underscores (`_`), which are valid Java identifier characters. +Each underscore will be replaced by a space for display purposes. + +If you want to tweak display names even more, +test container classes, groups, example methods and property methods can be labeled +using the annotation `@Label("a label")`. This label will be used to display the element +in test reports or within the IDE. +[In the following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/NamingExamples.java), +every test relevant element has been labeled: + +```java +@Label("Naming") +class NamingExamples { + + @Property + @Label("a property") + void aPropertyWithALabel() { } + + @Group + @Label("A Group") + class GroupWithLabel { + @Example + @Label("an example with äöüÄÖÜ") + void anExampleWithALabel() { } + } + + @Group + class Group_with_spaces { + @Example + void example_with_spaces() { } + } + +} +``` + +Labels can consist of any characters and don't have to be unique - but you probably want them +to be unique within their container. + +## Tagging Tests + +Test container classes, groups, example methods and property methods can be tagged +using the annotation `@Tag("a-tag")`. You can have many tags on the same element. + +Those tag can be used to filter the set of tests +[run by the IDE](https://blog.jetbrains.com/idea/2018/01/intellij-idea-starts-2018-1-early-access-program/) or +[the build tool](https://docs.gradle.org/4.6/release-notes.html#junit-5-support). +Tags are handed down from container (class or group) to its children (test methods or groups). + +Have a look at +[the following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TaggingExamples.java). +Including the tag `integration-test` will include +all tests of the class. + +```java +@Tag("integration-test") +class TaggingExamples { + + @Property + @Tag("fast") + void aFastProperty() { } + + @Example + @Tag("slow") @Tag("involved") + void aSlowTest() { } +} +``` + +Tags must follow certain rules as described +[here](/docs/1.1.6/javadoc/net/jqwik/api/Tag.html) + +## Disabling Tests + +From time to time you might want to disable a test or all tests in a container +temporarily. You can do that by adding the +[`@Disabled`](/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html) annotation +to a property method or a container class. + +```java +import net.jqwik.api.Disabled + +@Disabled("for whatever reason") +class DisablingExamples { + + @Property + @Disabled + void aDisabledProperty() { } + +} +``` + +Disabled properties will be reported by IDEs and build tools as "skipped" +together with the reason - if one has been provided. + +Be careful not to use the Jupiter annotation with the same name. +_Jqwik_ will refuse to execute methods that have Jupiter annotations. + + +## Default Parameter Generation + +_jqwik_ tries to generate values for those property method parameters that are +annotated with [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html). If the annotation does not have a `value` parameter, +jqwik will use default generation for the following types: + +- `Object` +- `String` +- Integral types `Byte`, `byte`, `Short`, `short` `Integer`, `int`, `Long`, `long` and `BigInteger` +- Floating types `Float`, `float`, `Double`, `double` and `BigDecimal` +- `Boolean` and `boolean` +- `Character` and `char` +- All `enum` types +- Collection types `List`, `Set` and `Stream` + as long as `T` can also be provided by default generation. +- `Iterable` and `Iterator` of types that are provided by default. +- `Optional` of types that are provided by default. +- Array `T[]` of types that are provided by default. +- `Map` as long as `K` and `V` can also be provided by default generation. +- `java.util.Random` + +If you use [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) +with a value, e.g. `@ForAll("aMethodName")`, the method +referenced by `"aMethodName"` will be called to provide an Arbitrary of the +required type (see [Customized Parameter Generation](#customized-parameter-generation)). + +### Constraining Default Generation + +Default parameter generation can be influenced and constrained by additional annotations, +depending on the requested parameter type. + +#### Allow Null Values + +- [`@WithNull(double value = 0.1)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html): + Inject `null` into generated values with a probability of `value`. + + Works for all generated types. + +#### Unique Values + +- [`@Unique`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html): + Prevent duplicate values to be generated _per try_. That means that + there can still be duplicate values across several tries. That also means + that `@Unique` only makes sense as annotation for a parameter type, e.g.: + + ```java + @Property + void uniqueInList(@ForAll @Size(5) List<@IntRange(min = 0, max = 10) @Unique Integer> aList) { + Assertions.assertThat(aList).doesNotHaveDuplicates(); + Assertions.assertThat(aList).allMatch(anInt -> anInt >= 0 && anInt <= 10); + } + ``` + + Trying to generate a list with more than 11 elements would not work here. + + Works for all generated types. + +#### String Length + +- [`@StringLength(int value = 0, int min = 0, int max = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html): + Set either fixed length through `value` or configure the length range between `min` and `max`. + +- [`@NotEmpty`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html): + Set minimum length to `1`. + +#### Character Sets + +When generating chars any unicode character might be generated. + +When generating Strings, however, +Unicode "noncharacters" and "private use characters" +will not be generated unless you explicitly include them using +`@Chars` or `@CharRange` (see below). + +You can use the following annotations to restrict the set of allowed characters and even +combine several of them: + +- [`@Chars(chars[] value = {})`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html): + Specify a set of characters. + This annotation can be repeated which will add up all allowed chars. +- [`@CharRange(char from = 0, char to = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html): + Specify a start and end character. + This annotation can be repeated which will add up all allowed chars. +- [`@NumericChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html): + Use digits `0` through `9` +- [`@LowerChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html): + Use lower case chars `a` through `z` +- [`@UpperChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html): + Use upper case chars `A` through `Z` +- [`@AlphaChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html): + Lower and upper case chars are allowed. +- [`@Whitespace`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html): + All whitespace characters are allowed. + +They work for generated `String`s and `Character`s. + +#### List, Set, Stream and Array Size: + +- [`@Size(int value = 0, int min = 0, int max = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html): + Set either fixed size through `value` or configure the size range between `min` and `max`. + +- [`@NotEmpty`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html): + Set minimum size to `1`. + + +#### Integer Constraints + +- [`@ByteRange(byte min = 0, byte max = Byte.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html): + For `Byte` and `byte` only. +- [`@ShortRange(short min = 0, short max = Short.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html): + For `Short` and `short` only. +- [`@IntRange(int min = 0, int max = Integer.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html): + For `Integer` and `int` only. +- [`@LongRange(long min = 0L, long max = Long.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html): + For `Long` and `long` only. +- [`@BigRange(String min = "", String max = "")`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html): + For `BigInteger` generation. +- [`@Positive`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html): + Numbers larger than `0`. For all integral types. +- [`@Negative`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html): + Numbers lower than `0`. For all integral types. + + +#### Decimal Constraints + +- [`@FloatRange(float min = 0.0f, float max = Float.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html): + For `Float` and `float` only. +- [`@DoubleRange(double min = 0.0, double max = Double.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html): + For `Double` and `double` only. +- [`@BigRange(String min = "", String max = "")`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html): + For `BigDecimal` generation. +- [`@Scale(int value)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html): + Specify the maximum number of decimal places. For all decimal types. +- [`@Positive`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html): + Numbers larger than `0.0`. For all decimal types. +- [`@Negative`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html): + Numbers lower than `0.0`. For all decimal types. + +### Constraining parameterized types + +When you want to constrain the generation of contained parameter types you can annotate +the parameter type directly, e.g.: + +```java +@Property +void aProperty(@ForAll @Size(min= 1) List<@StringLength(max=10) String> listOfStrings) { +} +``` +will generate lists with a minimum size of 1 filled with Strings that have 10 characters max. + +### Providing variable types + +While checking properties of generically typed classes or functions, you often don't care +about the exact type of variables and therefore want to express them with type variables. +_jqwik_ can also handle type variables and wildcard types. The handling of upper and lower +bounds works mostly as you would expect it. + +Consider +[the following examples](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/VariableTypedPropertyExamples.java): + +```java +class VariableTypedPropertyExamples { + + @Property + boolean unboundedGenericTypesAreResolved(@ForAll List items, @ForAll T newItem) { + items.add(newItem); + return items.contains(newItem); + } + + @Property + void someBoundedGenericTypesCanBeResolved(@ForAll List items, @ForAll T newItem) { + } + + @Property + void someWildcardTypesWithUpperBoundsCanBeResolved(@ForAll List items) { + } + +} +``` + +In the case of unbounded type variables or an unbounded wildcard type, _jqwik_ +will create instanced of a special class (`WildcardObject`) under the hood. + +In the case of bounded type variables and bounded wildcard types, _jqwik_ +will check if any [registered arbitrary provider](#providing-default-arbitraries) +can provide suitable arbitraries and choose randomly between those. + +There is, however, a potentially unexpected behaviour, +when the same type variable is used in more than one place and can be +resolved by more than one arbitrary. In this case it can happen that the variable +does not represent the same type in all places. You can see this above +in property method `someBoundedGenericTypesCanBeResolved()` where `items` +might be a list of Strings but `newItem` of some number type - and all that +_in the same call to the method_! + +## Self-Made Annotations + +You can [make your own annotations](http://junit.org/junit5/docs/5.0.0/user-guide/#writing-tests-meta-annotations) +instead of using _jqwik_'s built-in ones. BTW, '@Example' is nothing but a plain annotation using [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) +as "meta"-annotation. + +The following example provides an annotation to constrain String or Character generation to German letters only: + +```java +@Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@NumericChars +@AlphaChars +@Chars({'ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß'}) +@Chars({' ', '.', ',', ';', '?', '!'}) +@StringLength(min = 10, max = 100) +public @interface GermanText { } + +@Property(tries = 10) @Reporting(Reporting.GENERATED) +void aGermanText(@ForAll @GermanText String aText) {} +``` + +The drawback of self-made annotations is that they do not forward their parameters to meta-annotations, +which constrains their applicability to simple cases. + + +## Customized Parameter Generation + +Sometimes the possibilities of adjusting default parameter generation +through annotations is not enough. In that case you can delegate parameter +provision to another method. Look at the +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ProvideMethodExamples.java): + +```java +@Property +boolean concatenatingStringWithInt( + @ForAll("shortStrings") String aShortString, + @ForAll("10 to 99") int aNumber +) { + String concatenated = aShortString + aNumber; + return concatenated.length() > 2 && concatenated.length() < 11; +} + +@Provide +Arbitrary shortStrings() { + return Arbitraries.strings().withCharRange('a', 'z') + .ofMinLength(1).ofMaxLength(8); +} + +@Provide("10 to 99") +Arbitrary numbers() { + return Arbitraries.integers().between(10, 99); +} +``` + +The String value of the [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) +annotation serves as a reference to a +method within the same class (or one of its superclasses or owning classes). +This reference refers to either the method's name or the String value +of the method's `@Provide` annotation. + +The providing method has to return an object of type +[`@Arbitrary`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html) +where `T` is the static type of the parameter to be provided. + +Parameter provision usually starts with a +[static method call to `Arbitraries`](#static-arbitraries-methods), maybe followed +by one or more [filtering](#filtering), [mapping](#mapping) or +[combining](#combining-arbitraries) actions. + + +### Static `Arbitraries` methods + +The starting point for generation usually is a static method call on class +[`Arbitraries`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html). + +#### Generate values yourself + +- [`Arbitrary randomValue(Function generator)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#randomValue-java.util.function.Function-): + Take a `random` instance and create an object from it. + Those values cannot be [shrunk](#result-shrinking), though. + + Generating prime numbers might look like that: + ```java + @Provide + Arbitrary primesGenerated() { + return Arbitraries.randomValue(random -> generatePrime(random)); + } + + private Integer generatePrime(Random random) { + int candidate; + do { + candidate = random.nextInt(10000) + 2; + } while (!isPrime(candidate)); + return candidate; + } + ``` + +- [`Arbitrary fromGenerator(RandomGenerator generator)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#fromGenerator-net.jqwik.api.RandomGenerator-): + If the number of _tries_ influences value generation or if you want + to allow for [shrinking](#result-shrinking) you have to provide + your own `RandomGenerator` implementation. + +#### Select values randomly + +- [`Arbitrary of(U... values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#of-U...-): + Choose randomly from a list of values. Shrink towards the first one. + +- [`Arbitrary samples(T... samples)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#samples-T...-): + Go through samples from first to last. Shrink towards the first sample. + + If instead you want to _add_ samples to an existing arbitrary you'd rather use + [`Arbitrary.withSamples(T... samples)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#withSamples-T...-). + The following arbitrary: + + ```java + @Provide + Arbitrary integersWithPrimes() { + return Arbitraries.integers(- 1000, 1000).withSamples(2,3,5,7,11,13,17); + } + ``` + + will first generate the 7 enumerated prime numbers and only then generate random + integers between -1000 and +1000. + +- [`Arbitrary of(Class enumClass)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#of-java.lang.Class-): + Choose randomly from all values of an `enum`. Shrink towards first enum value. + +#### Select randomly with Weights + +If you have a set of values to choose from with weighted probabilities, use ` +[`Arbitraries.frequency(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#frequency-net.jqwik.api.Tuple.Tuple2...-): + +```java +@Property +void abcdWithFrequencies(@ForAll("abcdWeighted") String aString) { + Statistics.collect(aString); +} + +@Provide +Arbitrary abcdWeighted() { + return Arbitraries.frequency( + Tuple.of(1, "a"), + Tuple.of(5, "b"), + Tuple.of(10, "c"), + Tuple.of(20, "d") + ); +} +``` + +The first value of the tuple specifies the frequency of a particular value in relation to the +sum of all frequencies. In +[the given example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ChoosingExamples.java#L17) +the sum is 36, thus `"a"` will be generated with a probability of `1/36` +whereas `"d"` has a generation probability of `20/36` (= `5/9`). + +Shrinking moves towards the start of the frequency list. + +#### Integers + +- [`ByteArbitrary bytes()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bytes--) +- [`ShortArbitrary shorts()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shorts--) +- [`IntegerArbitrary integers()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#integers--) +- [`LongArbitrary longs()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#longs--) +- [`BigIntegerArbitrary bigIntegers()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bigIntegers--) + +#### Decimals + +- [`FloatArbitrary floats()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#floats--) +- [`DoubleArbitrary doubles()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#doubles--) +- [`BigDecimalArbitrary bigDecimals()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bigDecimals--) + +#### Characters and Strings + +- [`StringArbitrary strings()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#strings--) +- [`CharacterArbitrary chars()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#chars--) + +#### java.util.Random + +- [`Arbitrary randoms()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#randoms--): + Random instances will never be shrunk + +#### Constants + +- [`Arbitrary constant(T value)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#constant-T-): + In each try use the same unshrinkable `value` of type `T`. + +#### Create + +- [`Arbitrary create(Supplier supplier)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#constant-java.util.function.Supplier-): + In each try use a new unshrinkable instance of type `T` using `supplier` to freshly create it. + +#### Shuffling Permutations + +- [`Arbitrary> shuffle(T ... values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shuffle-T...-): + Return unshrinkable permutations of the `values` handed in. + +- [`Arbitrary> shuffle(List values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shuffle-java.util.List-): + Return unshrinkable permutations of the `values` handed in. + +#### Default Types + +- [`Arbitrary defaultFor(Class type, Class ... parameterTypes)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#defaultFor-java.lang.Class-java.lang.Class...-): + Return the default arbitrary available for type `type` [if one is provided](#providing-default-arbitraries) + by default. For parameterized types you can also specify the parameter types. + + Keep in mind, though, that the parameter types are lost in the type signature and therefore + cannot be used in the respective [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) property method parameter. Raw types and wildcards, + however, match; thus the following example will work: + + ```java + @Property + boolean listWithWildcard(@ForAll("stringLists") List stringList) { + return stringList.isEmpty() || stringList.get(0) instanceof String; + } + + @Provide + Arbitrary stringLists() { + return Arbitraries.defaultFor(List.class, String.class); + } + ``` + +### Collections, Streams, Arrays and Optional + +Generating types who have generic type parameters, requires to start with +an `Arbitrary` instance for the generic type. You can create the corresponding collection arbitrary from there: + +- [`Arbitrary.list()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#list--) +- [`Arbitrary.set()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#set--) +- [`Arbitrary.streamOf()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#stream--) +- [`Arbitrary.array(Class arrayClass)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#array-java.lang.Class-) +- [`Arbitrary.optional()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#optional--) + +### Maps + +Generating instances of type `Map` is a bit different since two arbitraries +are needed, one for the key and one for the value. Therefore you have to use +[`Arbitraries.maps(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#maps-net.jqwik.api.Arbitrary-net.jqwik.api.Arbitrary-): + +### Collecting Values in a List + +If you do not want any random combination of values in your list - as +can be done with `Arbitrary.list()` - you have the possibility to collect random values +in a list until a certain condition is fulfilled. +[`Arbitrary.collect(Predicate condition)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#collect-java.util.function.Predicate-) +is what you need in those cases. + +Imagine you need a list of integers the sum of which should be at least `1000`. +Here's how you could do that: + +```java +Arbitrary integers = Arbitraries.integers().between(1, 100); +Arbitrary> collected = integers.collect(list -> sum(list) >= 1000); +``` + +### Fluent Configuration Interfaces + +Most specialized arbitrary interfaces provide special methods to configure things +like size, length, boundaries etc. Have a look at the Java doc for the following types: + +- [BigDecimalArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html) +- [BigIntegerArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html) +- [ByteArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html) +- [CharacterArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html) +- [DoubleArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html) +- [FloatArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html) +- [IntegerArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html) +- [LongArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html) +- [ShortArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html) +- [SizableArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html) +- [StringArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html) + + +Here are a +[two examples](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FluentConfigurationExamples.java) +to give you a hint of what you can do: + +```java +@Provide +Arbitrary alphaNumericStringsWithMinLength5() { + return Arbitraries.strings().ofMinLength(5).alpha().numeric(); +} + +@Provide +Arbitrary> fixedSizedListOfPositiveIntegers() { + return Arbitraries.integers().greaterOrEqual(0).list().ofSize(17); +} +``` + +### Generate `null` values + +Predefined generators will never create `null` values. If you want to allow that, +call [`Arbitrary.injectNull(double probability)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#injectNull-double-). +The following provider method creates an arbitrary that will return a `null` String +in about 1 of 100 generated values. + +```java +@Provide +Arbitrary stringsWithNull() { + return Arbitraries.strings(0, 10).injectNull(0.01); +} +``` + +### Filtering + +If you want to include only part of all the values generated by an arbitrary, +use +[`Arbitrary.filter(Predicate filterPredicate)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#filter-java.util.function.Predicate-). +The following arbitrary will filter out all +even numbers from the stream of generated integers: + +```java +@Provide +Arbitrary oddNumbers() { + return Arbitraries.integers().filter(aNumber -> aNumber % 2 != 0); +} +``` + +Keep in mind that your filter condition should not be too restrictive. +If the generator fails to find a suitable value after 10000 trials, +the current property will be abandoned by throwing an exception. + +### Creating unique values + +If you want to make sure that all the values generated by an arbitrary are unique, +use +[`Arbitrary.unique()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#unique--). +The following arbitrary will generate integers between 1 and 1000 but never the same integer twice: + +```java +@Provide +Arbitrary oddNumbers() { + return Arbitraries.integers().between(1, 1000).unique(); +} +``` + +This means that a maximum of 1000 values can be generated. If the generator fails +to find a yet unseen value after 10000 trials, +the current property will be abandoned by throwing an exception. + +### Mapping + +Sometimes it's easier to start with an existing arbitrary and use its generated values to +build other objects from them. In that case, use +[`Arbitrary.map(Function mapper)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#map-java.util.function.Function-). +The following example uses generated integers to create numerical Strings: + +```java +@Provide +Arbitrary fiveDigitStrings() { + return Arbitraries.integers(10000, 99999).map(aNumber -> String.valueOf(aNumber)); +} +``` + +You could generate the same kind of values by constraining and filtering a generated String. +However, the [shrinking](#result-shrinking) target would probably be different. In the example above, shrinking +will move towards the lowest allowed number, that is `10000`. + + +### Flat Mapping + +Similar as in the case of `Arbitrary.map(..)` there are situations in which you want to use +a generated value in order to create another Arbitrary from it. Sounds complicated? +Have a look at the +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L26): + +```java +@Property +boolean fixedSizedStrings(@ForAll("listsOfEqualSizedStrings")List lists) { + return lists.stream().distinct().count() == 1; +} + +@Provide +Arbitrary> listsOfEqualSizedStrings() { + Arbitrary integers2to5 = Arbitraries.integers().between(2, 5); + return integers2to5.flatMap(stringSize -> { + Arbitrary strings = Arbitraries.strings() // + .withCharRange('a', 'z') // + .ofMinLength(stringSize).ofMaxLength(stringSize); + return strings.list(); + }); +} +``` +The provider method will create random lists of strings, but in each list the size of the contained strings +will always be the same - between 2 and 5. + +### Flat Mapping with Tuple Types + +In the example above you used a generated value in order to create another arbitrary. +In those situations you often want to also provide the original values to your property test. + +Imagine, for instance, that you'd like to test properties of `String.substring(begin, end)`. +To randomize the method call, you not only need a string but also the `begin` and `end` indices. +However, both have dependencies: +- `end` must not be larger than the string size +- `begin` must not be larger than `end` +You can make _jqwik_ create all three values by using +[`flatMap`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#flatMap-java.util.function.Function-) +combined with a tuple type +[like this](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L32): + + +```java +@Property +void substringLength(@ForAll("stringWithBeginEnd") Tuple3 stringBeginEnd) { + String aString = stringBeginEnd.get1(); + int begin = stringBeginEnd.get2(); + int end = stringBeginEnd.get3(); + Assertions.assertThat(aString.substring(begin, end).length()) + .isEqualTo(end - begin); +} + +@Provide +Arbitrary> stringWithBeginEnd() { + Arbitrary stringArbitrary = Arbitraries.strings() // + .withCharRange('a', 'z') // + .ofMinLength(2).ofMaxLength(20); + return stringArbitrary // + .flatMap(aString -> Arbitraries.integers().between(0, aString.length()) // + .flatMap(end -> Arbitraries.integers().between(0, end) // + .map(begin -> Tuple.of(aString, begin, end)))); +} +``` + +Mind the nested flat mapping, which is an aesthetic nuisance but nevertheless +very useful. + + +### Randomly Choosing among Arbitraries + +If you have several arbitraries of the same type, you can create a new arbitrary of +the same type which will choose randomly one of those arbitraries before generating +a value: + +```java +@Property +boolean intsAreCreatedFromOneOfThreeArbitraries(@ForAll("oneOfThree") int anInt) { + String classifier = anInt < -1000 ? "below" : anInt > 1000 ? "above" : "one"; + Statistics.collect(classifier); + + return anInt < -1000 // + || Math.abs(anInt) == 1 // + || anInt > 1000; +} + +@Provide +Arbitrary oneOfThree() { + IntegerArbitrary below1000 = Arbitraries.integers().between(-2000, -1001); + IntegerArbitrary above1000 = Arbitraries.integers().between(1001, 2000); + Arbitrary oneOrMinusOne = Arbitraries.samples(-1, 1); + + return Arbitraries.oneOf(below1000, above1000, oneOrMinusOne); +} +``` + +[In this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/OneOfExamples.java) +the statistics should also give you an equal distribution between +the three types of integers. + +If you don't want to choose with equal probability - but with differing frequency - +you can do that in a similar way: + +```java +@Property(tries = 100) +@Report(Reporting.GENERATED) +boolean intsAreCreatedFromOneOfThreeArbitraries(@ForAll("oneOfThree") int anInt) { + return anInt < -1000 // + || Math.abs(anInt) == 1 // + || anInt > 1000; +} + +@Provide +Arbitrary oneOfThree() { + IntegerArbitrary below1000 = Arbitraries.integers().between(-1050, -1001); + IntegerArbitrary above1000 = Arbitraries.integers().between(1001, 1050); + Arbitrary oneOrMinusOne = Arbitraries.samples(-1, 1); + + return Arbitraries.frequencyOf( + Tuple.of(1, below1000), + Tuple.of(3, above1000), + Tuple.of(6, oneOrMinusOne) + ); +} +``` + +### Combining Arbitraries + +Sometimes just mapping a single stream of generated values is not enough to generate +a more complicated domain object. In those cases you can combine several arbitraries to +a single result arbitrary using +[`Combinators.combine()`](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#combine-net.jqwik.api.Arbitrary-net.jqwik.api.Arbitrary-) +with up to eight arbitraries. +[Create an issue on github](https://github.com/jlink/jqwik/issues) if you need more than eight. + +[The following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/MappingAndCombinatorExamples.java#L25) +generates `Person` instances from three arbitraries as inputs. + +```java +@Property +void validPeopleHaveIDs(@ForAll("validPeople") Person aPerson) { + Assertions.assertThat(aPerson.getID()).contains("-"); + Assertions.assertThat(aPerson.getID().length()).isBetween(5, 24); +} + +@Provide +Arbitrary validPeople() { + Arbitrary names = Arbitraries.strings().withCharRange('a', 'z') + .ofMinLength(3).ofMaxLength(21); + Arbitrary ages = Arbitraries.integers().between(0, 130); + return Combinators.combine(names, ages) + .as((name, age) -> new Person(name, age)); +} + +class Person { + private final String name; + private final int age; + + public Person(String name, int age) { + this.name = name; + this.age = age; + } + + public String getID() { + return name + "-" + age; + } + + @Override + public String toString() { + return String.format("%s:%s", name, age); + } +} +``` + +The property should fail, thereby shrinking the falsified Person instance to +`[aaaaaaaaaaaaaaaaaaaaa:100]`. + +The `Combinators.combine` method accepts up to 8 parameters of type Arbitrary. +If you need more you have a few options: + +- Consider to group some parameters into an object of their own and change your design +- Generate inbetween arbitraries e.g. of type `Tuple` and combine those in another step +- Introduce a build for your domain object and combine them + [in this way](#combining-arbitraries-with-builder) + + +### Combining Arbitraries with Builder + +There's an alternative way to combine arbitraries to create an aggregated object +by using a builder for the aggregated object. Consider the example from +[above](#combining-arbitraries) and throw a `PersonBuilder` into the mix: + +```java +static class PersonBuilder { + + private String name = "A name"; + private int age = 42; + + public PersonBuilder withName(String name) { + this.name = name; + return this; + } + + public PersonBuilder withAge(int age) { + this.age = age; + return this; + } + + public Person build() { + return new Person(name, age); + } +} +``` + +Then you can go about generating people in the following way: + +```java +@Provide +Arbitrary validPeopleWithBuilder() { + Arbitrary names = + Arbitraries.strings().withCharRange('a', 'z').ofMinLength(2).ofMaxLength(20); + Arbitrary ages = Arbitraries.integers().between(0, 130); + + return Combinators.withBuilder(() -> new PersonBuilder()) + .use(names).in((builder, name) -> builder.withName(name)) + .use(ages).in((builder, age)-> builder.withAge(age)) + .build( builder -> builder.build()); +} +``` + +Have a look at +[Combinators.withBuilder(Supplier)](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#withBuilder-java.util.function.Supplier-) +and [Combinators.withBuilder(Arbitrary)](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#withBuilder-net.jqwik.api.Arbitrary-) +to check the API. + +#### Flat Combination + +If generating domain values requires to use several generated values to be used +in generating another one, there's the combination of flat mapping and combining: + +```java +@Property +boolean fullNameHasTwoParts(@ForAll("fullName") String aName) { + return aName.split(" ").length == 2; +} + +@Provide +Arbitrary fullName() { + IntegerArbitrary firstNameLength = Arbitraries.integers().between(2, 10); + IntegerArbitrary lastNameLength = Arbitraries.integers().between(2, 10); + return Combinators.combine(firstNameLength, lastNameLength).flatAs( (fLength, lLength) -> { + Arbitrary firstName = Arbitraries.strings().alpha().ofLength(fLength); + Arbitrary lastName = Arbitraries.strings().alpha().ofLength(fLength); + return Combinators.combine(firstName, lastName).as((f,l) -> f + " " + l); + }); +} +``` + +Often, however, there's an easier way to achieve the same goal which +does not require the flat combination of arbitraries: + +```java +@Provide +Arbitrary fullName2() { + Arbitrary firstName = Arbitraries.strings().alpha().ofMinLength(2).ofMaxLength(10); + Arbitrary lastName = Arbitraries.strings().alpha().ofMinLength(2).ofMaxLength(10); + return Combinators.combine(firstName, lastName).as((f, l) -> f + " " + l); +} +``` + +This is not only easier to understand but it usually improves shrinking. + +### Fix an Arbitrary's `genSize` + +Some generators (e.g. most number generators) are sensitive to the +`genSize` value that is used when creating them. +The default value for `genSize` is the number of tries configured for the property +they are used in. If there is a need to influence the behaviour of generators +you can do so by using +[`Arbitrary.fixGenSize(int)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#fixGenSize-int-).. + + +### Generating all possible values + +There are a few cases when you don't want to generate individual values from an +arbitrary but use all possible values to construct another arbitrary. This can be achieved through +[`Arbitrary.allValues()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#allValues--). + +Return type is `Optional>` because _jqwik_ can only perform this task if +[exhaustive generation](#exhaustive-generation) is doable. + + +### Iterating through all possible values + +You can also use an arbitrary to iterate through all values it specifies. +Use +[`Arbitrary.forEachValue(Consumer action)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#forEachValue-java.util.function.Consumer-). +for that purpose. This only works when [exhaustive generation](#exhaustive-generation) is possible. +In other cases the attempt to iterate will result in an exception. + +This is typically useful when your test requires to assert some fact for all +values of a given (sub)set of objects. Here's a contrived example: + +```java +@Property +void canPressAnyKeyOnKeyboard(@ForAll Keyboard keyboard, @ForAll Key key) { + keyboard.press(key); + assertThat(keyboard.isPressed(key)); + + Arbitrary unpressedKeys = Arbitraries.of(keyboard.allKeys()).filter(k -> !k.equals(key)); + unpressedKeys.forEachValue(k -> assertThat(keyboard.isPressed(k)).isFalse()); +} +``` + +In this example a simple for loop over `allKeys()` would also work. In more complicated scenarios +_jqwik_ will do all the combinations and filtering for you. + + +## Recursive Arbitraries + +Sometimes it seems like a good idea to compose arbitraries and thereby +recursively calling an arbitrary creation method. Generating recursive data types +is one application field but you can also use it for other stuff. + +### Probabilistic Recursion + +Look at the +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/RecursiveExamples.java) +which generates sentences by recursively adding words to a sentence: + +```java +@Property +boolean sentencesEndWithAPoint(@ForAll("sentences") String aSentence) { + return aSentence.endsWith("."); +} + +@Provide +Arbitrary sentences() { + Arbitrary sentence = Combinators.combine( // + Arbitraries.lazy(this::sentences), // + word() // + ).as((s, w) -> w + " " + s); + return Arbitraries.oneOf( // + word().map(w -> w + "."), // + sentence, // + sentence, // + sentence // + ); +} + +private StringArbitrary word() { + return Arbitraries.strings().alpha().ofLength(5); +} +``` + +There are two things to which you must pay attention: + +- Use [`Arbitraries.lazy(Supplier>)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#lazy-java.util.function.Supplier-) + to wrap the recursive call itself. + Otherwise _jqwik_'s attempt to build the arbitrary will quickly result in a stack overflow. +- Every recursion needs one or more base cases in order to stop recursion at some point. + Base cases must have a high enough probability, + otherwise a stack overflow will get you during value generation. + +### Deterministic Recursion + +An alternative to the non-deterministic recursion shown above, is to use classical +recursion with a counter to determine the base case. If you then use an arbitrary value +for the counter, the generated sentences will be very similar, and there is _no need_ +for using `Arbitraries.lazy()` at all: + +```java +@Property(tries = 10) +boolean sentencesEndWithAPoint(@ForAll("deterministic") String aSentence) { + return aSentence.endsWith("."); +} + +@Provide +Arbitrary deterministic() { + Arbitrary length = Arbitraries.integers().between(0, 10); + Arbitrary lastWord = word().map(w -> w + "."); + return length.flatMap(l -> deterministic(l, lastWord)); +} + +@Provide +Arbitrary deterministic(int length, Arbitrary sentence) { + if (length == 0) { + return sentence; + } + Arbitrary more = Combinators.combine(word(), sentence).as((w, s) -> w + " " + s); + return deterministic(length - 1, more); +} +``` + +### Deterministic Recursion with `recursive()` + +To further simplify this _jqwik_ provides a helper function: +[`Arbitraries.recursive(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#recursive-java.util.function.Supplier-java.util.function.Function-int-). +Using that further simplifies the example: + +```java +@Property(tries = 10) +boolean sentencesEndWithAPoint(@ForAll("deterministic") String aSentence) { + return aSentence.endsWith("."); +} + +@Provide +Arbitrary deterministic() { + Arbitrary length = Arbitraries.integers().between(0, 10); + Arbitrary lastWord = word().map(w -> w + "."); + + return length.flatMap(l -> Arbitraries.recursive(() -> lastWord, s -> prependWord(s), l)); +} + +private Arbitrary prependWord(Arbitrary sentence) { + return Combinators.combine(word(), sentence).as((w, s) -> w + " " + s); +} +``` + + + +## Contract Tests + +When you combine type variables with properties defined in superclasses or interfaces +you can do some kind of _contract testing_. That means that you specify +the properties in a generically typed interface and specify the concrete class to +instantiate in a test container implementing the interface. + +The following example was influence by a similar feature in +[junit-quickcheck](http://pholser.github.io/junit-quickcheck/site/0.8/usage/contract-tests.html). +Here's the contract: + +```java +interface ComparatorContract { + Comparator subject(); + + @Property + default void symmetry(@ForAll("anyT") T x, @ForAll("anyT") T y) { + Comparator subject = subject(); + + Assertions.assertThat(signum(subject.compare(x, y))).isEqualTo(-signum(subject.compare(y, x))); + } + + @Provide + Arbitrary anyT(); +} +``` + +And here's the concrete test container that can be run to execute +the property with generated Strings: + +```java +class StringCaseInsensitiveProperties implements ComparatorContract { + + @Override public Comparator subject() { + return String::compareToIgnoreCase; + } + + @Override + @Provide + public Arbitrary anyT() { + return Arbitraries.strings().alpha().ofMaxLength(20); + } +} +``` + +What we can see here is that _jqwik_ is able to figure out the concrete +type of type variables when they are used in subtypes that fill in +the variables. + + +## Stateful Testing + +Despite its bad reputation _state_ is an important concept in object-oriented languages like Java. +We often have to deal with stateful objects or components whose state can be changed through methods. + +Thinking in a more formal way we can look at those objects as _state machines_ and the methods as +_actions_ that move the object from one state to another. Some actions have preconditions to constrain +when they can be invoked and some objects have invariants that should never be violated regardless +of the sequence of performed actions. + +To make this abstract concept concrete, let's look at a +[simple stack implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStack.java): + +```java +public class MyStringStack { + public void push(String element) { ... } + public String pop() { ... } + public void clear() { ... } + public boolean isEmpty() { ... } + public int size() { ... } + public String top() { ... } +} +``` + +### Specify Actions + +We can see at least three _actions_ with their preconditions and expected state changes: + +- [`Push`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PushAction.java): + Push a string onto the stack. The string should be on top afterwards and the size + should have increased by 1. + + ```java + import net.jqwik.api.stateful.*; + import org.assertj.core.api.*; + + class PushAction implements Action { + + private final String element; + + PushAction(String element) { + this.element = element; + } + + @Override + public MyStringStack run(MyStringStack model) { + int sizeBefore = model.size(); + model.push(element); + Assertions.assertThat(model.isEmpty()).isFalse(); + Assertions.assertThat(model.size()).isEqualTo(sizeBefore + 1); + return model; + } + + @Override + public String toString() { return String.format("push(%s)", element); } + } + ``` + +- [`Pop`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PopAction.java): + If (and only if) the stack is not empty, pop the element on top off the stack. + The size of the stack should have decreased by 1. + + ```java + class PopAction implements Action { + + @Override + public boolean precondition(MyStringStack model) { + return !model.isEmpty(); + } + + @Override + public MyStringStack run(MyStringStack model) { + int sizeBefore = model.size(); + String topBefore = model.top(); + + String popped = model.pop(); + Assertions.assertThat(popped).isEqualTo(topBefore); + Assertions.assertThat(model.size()).isEqualTo(sizeBefore - 1); + return model; + } + + @Override + public String toString() { return "pop"; } + } + ``` + +- [`Clear`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/ClearAction.java): + Remove all elements from the stack which should be empty afterwards. + + ```java + class ClearAction implements Action { + + @Override + public MyStringStack run(MyStringStack model) { + model.clear(); + Assertions.assertThat(model.isEmpty()).isTrue(); + return model; + } + + @Override + public String toString() { return "clear"; } + } + ``` + +### Check Postconditions + +The fundamental property that _jqwik_ should try to falsify is: + + For any valid sequence of actions all required state changes + (aka postconditions) should be fulfilled. + +We can formulate that quite easily as a +[_jqwik_ property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStackProperties.java): + +```java +class MyStringStackProperties { + + @Property + void checkMyStack(@ForAll("sequences") ActionSequence actions) { + actions.run(new MyStringStack()); + } + + @Provide + Arbitrary> sequences() { + return Arbitraries.sequences(Arbitraries.oneOf(push(), pop(), clear())); + } + + private Arbitrary> push() { + return Arbitraries.strings().alpha().ofLength(5).map(PushAction::new); + } + + private Arbitrary> clear() { + return Arbitraries.constant(new ClearAction()); + } + + private Arbitrary> pop() { + return Arbitraries.constant(new PopAction()); + } +} +``` + +The interesting API elements are +- [`ActionSequence`](/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html): + A generic collection type especially crafted for holding and shrinking of a list of actions. + As a convenience it will apply the actions to a model when you call `run(model)`. + +- [`Arbitraries.sequences()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#sequences-net.jqwik.api.Arbitrary-): + This method will create the arbitrary for generating an `ActionSequence` given the + arbitrary for generating actions. + +To give _jqwik_ something to falsify, we broke the implementation of `clear()` so that +it won't clear everything if there are more than two elements on the stack: + +```java +public void clear() { + // Wrong implementation to provoke falsification for stacks with more than 2 elements + if (elements.size() > 2) { + elements.remove(0); + } else { + elements.clear(); + } +} +``` + +Running the property should now produce a result similar to: + +``` +org.opentest4j.AssertionFailedError: Run failed after following actions: + push(AAAAA) + push(AAAAA) + push(AAAAA) + clear + final state: ["AAAAA", "AAAAA"] +``` + +### Number of actions + +_jqwik_ will vary the number of generated actions according to the number +of `tries` of your property. For the default of 1000 tries a sequence will +have up to 32 actions. If need be you can specify the number of actions +to generate using either the fluent interface or the `@Size` annotation: + +```java +@Property +// check stack with sequences of 7 actions: +void checkMyStack(@ForAll("sequences") @Size(max = 7) ActionSequence actions) { + actions.run(new MyStringStack()); +} +``` + +The minimum number of generated actions in a sequence is 1 since checking +an empty sequence does not make sense. + +### Check Invariants + +We can also add invariants to our sequence checking property: + +```java +@Property +void checkMyStackWithInvariant(@ForAll("sequences") ActionSequence actions) { + actions + .withInvariant(stack -> Assertions.assertThat(stack.size()).isGreaterThanOrEqualTo(0)) + .withInvariant(stack -> Assertions.assertThat(stack.size()).isLessThan(5)) + .run(new MyStringStack()); +} +``` + +If we first fix the bug in `MyStringStack.clear()` our property should eventually fail +with the following result: + +``` +org.opentest4j.AssertionFailedError: Run failed after following actions: + push(AAAAA) + push(AAAAA) + push(AAAAA) + push(AAAAA) + push(AAAAA) + final state: ["AAAAA", "AAAAA", "AAAAA", "AAAAA", "AAAAA"] +``` + + +## Assumptions + +If you want to constrain the set of generated values in a way that embraces +more than one parameter, [filtering](#filtering) does not work. What you +can do instead is putting one or more assumptions at the beginning of your property. + +[The following property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/AssumptionExamples.java) +works only on strings that are not equal: + +```java +@Property +boolean comparingUnequalStrings( // + @ForAll @StringLength(min = 1, max = 10) String string1, // + @ForAll @StringLength(min = 1, max = 10) String string2 // +) { + Assume.that(!string1.equals(string2)); + + return string1.compareTo(string2) != 0; +} +``` + +This is a reasonable use of +[`Assume.that(boolean condition)`](/docs/1.1.6/javadoc/net/jqwik/api/Assume.html#that-boolean-) +because most generated value sets will pass through. + +Have a look at a seemingly similar example: + +```java +@Property +boolean findingContainedStrings( // + @ForAll @StringLength(min = 1, max = 10) String container, // + @ForAll @StringLength(min = 1, max = 5) String contained // +) { + Assume.that(container.contains(contained)); + + return container.indexOf(contained) >= 0; +} +``` + +Despite the fact that the property condition itself is correct, the property will most likely +fail with the following message: + +``` +org.opentest4j.AssertionFailedError: + Property [findingContainedStrings] exhausted after [1000] tries and [980] rejections + +tries = 1000 +checks = 20 +seed = 1066117555581106850 +``` + +The problem is that - given a random generation of two strings - only in very few cases +one string will be contained in the other. _jqwik_ will report a property as `exhausted` +if the ratio between generated and accepted parameters is higher than 5. You can change +the maximum discard ratio by specifying a parameter `maxDiscardRatio` in the +[`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) annotation. +That's why changing to `@Property(maxDiscardRatio = 100)` in the previous example +will probably result in a successful property run, even though only a handful +cases - of 1000 generated - will actually be checked. + +In many cases turning up the accepted discard ration is a bad idea. With some creativity +we can often avoid the problem by generating out test data a bit differently. +Look at this variant of the above property, which also uses +[`Assume.that()`](/docs/1.1.6/javadoc/net/jqwik/api/Assume.html#that-boolean-) +but with a much lower discard ratio: + +```java +@Property +boolean findingContainedStrings_variant( // + @ForAll @StringLength(min = 5, max = 10) String container, // + @ForAll @IntRange(min = 1, max = 5) int length, // + @ForAll @IntRange(min = 0, max = 9) int startIndex // +) { + Assume.that((length + startIndex) <= container.length()); + + String contained = container.substring(startIndex, startIndex + length); + return container.indexOf(contained) >= 0; +} +``` + +## Result Shrinking + +If a property could be falsified with a generated set of values, _jqwik_ will +try to "shrink" this sample in order to find a "smaller" sample that also falsifies the property. + +Try this property: + +```java +@Property +boolean stringShouldBeShrunkToAA(@ForAll @AlphaChars String aString) { + return aString.length() > 5 || aString.length() < 2; +} +``` + +The test run result should look something like: + +``` +AssertionFailedError: Property [stringShouldBeShrunkToAA] falsified with sample ["AA"] + +tries = 38 +checks = 38 +seed = -633877439388930932 +sample = ["AA"] +original-sample ["LVtyB"] +``` + +In this case the _originalSample_ could be any string between 2 and 5 chars, whereas the final _sample_ +should be exactly `AA` since this is the shortest failing string and `A` has the lowest numeric value +of all allowed characters. + +### Integrated Shrinking + +_jqwik_'s shrinking approach is called _integrated shrinking_, as opposed to _type-based shrinking_ +which most property-based testing tools use. +The general idea and its advantages are explained +[here](http://hypothesis.works/articles/integrated-shrinking/). + +Consider a somewhat +[more complicated example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ShrinkingExamples.java#L15): + +```java +@Property +boolean shrinkingCanTakeLong(@ForAll("first") String first, @ForAll("second") String second) { + String aString = first + second; + return aString.length() > 5 || aString.length() < 2; +} + +@Provide +Arbitrary first() { + return Arbitraries.strings() + .withCharRange('a', 'z') + .ofMinLength(1).ofMaxLength(10) + .filter(string -> string.endsWith("h")); +} + +@Provide +Arbitrary second() { + return Arbitraries.strings() + .withCharRange('0', '9') + .ofMinLength(0).ofMaxLength(10) + .filter(string -> string.length() >= 1); +} +``` + +Shrinking still works, although there's quite a bit of filtering and string concatenation happening: +``` +AssertionFailedError: Property [shrinkingCanTakeLong] falsified with sample ["h", "0"] + +checks = 20 +tries = 20 +seed = -5596810132893895291 +sample = ["h", "0"] +original-sample ["gh", "774"] +``` + +### Switch Shrinking Off + +Sometimes shrinking takes a really long time or won't finish at all (usually a _jqwik_ bug!). +In those cases you can switch shrinking off for an individual property: + +```java +@Property(shrinking = ShrinkingMode.OFF) +void aPropertyWithLongShrinkingTimes( + @ForAll List> list1, + @ForAll List> list2 +) { ... } +``` + +### Switch Shrinking to Full Mode + +Sometimes you can find a message like + +``` +shrinking bound reached = + steps : 1000 + original value : [blah blah blah ...] + shrunk value : [bl bl bl ...] +``` + +in your testrun's output. +This happens in rare cases when _jqwik_ has not found the end of its search for +simpler falsifiable values after 1000 iterations. In those cases you +can try + +```java +@Property(shrinking = ShrinkingMode.FULL) +``` + +to tell _jqwik_ to go all the way, even if it takes a million steps, +even if it never ends... + +### Change the Shrinking Target + +By default shrinking of numbers will move towards zero (0). +If zero is outside the bounds of generation the closest number to zero +- either the min or max value - is used as a target for shrinking. +There are cases, however, when you'd like _jqwik_ to choose a different +shrinking target, usually when the default value of a number is not 0. + +Consider generating signals with a standard frequency of 50 hz that can vary by +plus/minus 5 hz. If possible, shrinking of falsified scenarios should move +towards the standard frequency. Here's how the provider method might look: + +```java +@Provide +Arbitrary> signals() { + Arbitrary frequencies = + Arbitraries + .longs() + .between(45, 55) + .shrinkTowards(50); + + return frequencies.map(f -> Signal.withFrequency(f)).list().ofMaxSize(1000); +} +``` + +Currently shrinking targets are supported for integral numbers and decimal numbers, i.e., +bytes, shorts, integers, longs, floats, doubles, BigIntegers and BigDecimals. + + +## Collecting and Reporting Statistics + +In many situations you'd like to know if _jqwik_ will really generate +the kind of values you expect and if the frequency and distribution of +certain value classes meets your testing needs. +[`Statistics.collect()`](/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html#collect-java.lang.Object...-) +is made for this exact purpose. + +In the most simple case you'd like to know how often a certain value +is being generated: + +```java +@Property +void simpleStats(@ForAll RoundingMode mode) { + Statistics.collect(mode); +} +``` + +will create an output similar to that: + +``` +statistics for [MyTest:simpleStats] = + UNNECESSARY : 15 % + DOWN : 14 % + FLOOR : 13 % + UP : 13 % + HALF_DOWN : 13 % + HALF_EVEN : 12 % + CEILING : 11 % + HALF_UP : 11 % +``` + +More typical is the case in which you'll classify generated values +into two or more groups: + +```java +@Property +void integerStats(@ForAll int anInt) { + Statistics.collect(anInt > 0 ? "positive" : "negative"); +} +``` + +``` +statistics for [MyTest:integerStats] = + negative : 52 % + positive : 48 % +``` + +You can also collect the distribution in more than one category +and combine those categories: + +```java +@Property +void combinedIntegerStats(@ForAll int anInt) { + String posOrNeg = anInt > 0 ? "positive" : "negative"; + String evenOrOdd = anInt % 2 == 0 ? "even" : "odd"; + String bigOrSmall = Math.abs(anInt) > 50 ? "big" : "small"; + Statistics.collect(posOrNeg, evenOrOdd, bigOrSmall); +} +``` + +``` +statistics for [MyTest:combinedIntegerStats] = + positive odd big : 23 % + negative even big : 22 % + positive even big : 22 % + negative odd big : 21 % + positive odd small : 4 % + negative odd small : 3 % + negative even small : 3 % + positive even small : 2 % +``` + +And, of course, you can combine different generated parameters into +one statistical group: + +```java +@Property +void twoParameterStats( + @ForAll @Size(min = 1, max = 10) List aList, // + @ForAll @IntRange(min = 0, max = 10) int index // +) { + Statistics.collect(aList.size() > index ? "index within size" : null); +} +``` + +``` +collected statistics = + index within size : 48 % +``` + +As you can see, collected `null` values are not being reported. + +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/StatisticsExamples.java) +are a couple of examples to try out. + +## Providing Default Arbitraries + +Sometimes you want to use a certain, self-made `Arbitrary` for one of your own domain +classes, in all of your properties, and without having to add `@Provide` method +to all test classes. _jqwik_ enables this feature by using +Java’s `java.util.ServiceLoader` mechanism. All you have to do is: + +- Implement the interface [`ArbitraryProvider`](/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html).
+ The implementing class _must_ have a default constructor without parameters. +- Register the implementation class in file + + ``` + META-INF/services/net.jqwik.api.providers.ArbitraryProvider + ``` + +_jqwik_ will then add an instance of your arbitrary provider into the list of +its default providers. Those default providers are considered for every test parameter annotated +with [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) that has no explicit `value`. +By using this mechanism you can also replace the default providers +packaged into _jqwik_. + +### Simple Arbitrary Providers + +A simple provider is one that delivers arbitraries for types without type variables. +Consider the class [`Money`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/Money.java): + +```java +public class Money { + public BigDecimal getAmount() { + return amount; + } + + public String getCurrency() { + return currency; + } + + public Money(BigDecimal amount, String currency) { + this.amount = amount; + this.currency = currency; + } + + public Money times(int factor) { + return new Money(amount.multiply(new BigDecimal(factor)), currency); + } +} +``` + +If you register the following class +[`MoneyArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyArbitraryProvider.java): + +```java +package my.own.provider; + +public class MoneyArbitraryProvider implements ArbitraryProvider { + @Override + public boolean canProvideFor(TypeUsage targetType) { + return targetType.isOfType(Money.class); + } + + @Override + public Set> provideFor(TypeUsage targetType, SubtypeProvider subtypeProvider) { + Arbitrary amount = Arbitraries.bigDecimals() // + .between(BigDecimal.ZERO, new BigDecimal(1_000_000_000)) // + .ofScale(2); + Arbitrary currency = Arbitraries.of("EUR", "USD", "CHF"); + return Collections.singleton(Combinators.combine(amount, currency).as(Money::new)); + } +} +``` + +in file +[`META-INF/services/net.jqwik.api.providers.ArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/resources/META-INF/services/net.jqwik.api.providers.ArbitraryProvider) +with such an entry: + +``` +my.own.provider.MoneyArbitraryProvider +``` + +The +[following property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyProperties.java) +will run without further ado - regardless the class you put it in: + +```java +@Property +void moneyCanBeMultiplied(@ForAll Money money) { + Money times2 = money.times(2); + Assertions.assertThat(times2.getCurrency()).isEqualTo(money.getCurrency()); + Assertions.assertThat(times2.getAmount()) + .isEqualTo(money.getAmount().multiply(new BigDecimal(2))); +} +``` + +### Arbitrary Providers for Parameterized Types + +Providing arbitraries for generic types requires a little bit more effort +since you have to create arbitraries for the "inner" types as well. +Let's have a look at the default provider for `java.util.Optional`: + +```java +public class OptionalArbitraryProvider implements ArbitraryProvider { + @Override + public boolean canProvideFor(TypeUsage targetType) { + return targetType.isOfType(Optional.class); + } + + @Override + public Set> provideFor(TypeUsage targetType, SubtypeProvider subtypeProvider) { + TypeUsage innerType = targetType.getTypeArguments().get(0); + return subtypeProvider.apply(innerType).stream() // + .map(Arbitrary::optional) + .collect(Collectors.toSet()); + } +} +``` + +Mind that `provideFor` returns a set of potential arbitraries. +That's necessary because the `subtypeProvider` might also deliver a choice of +subtype arbitraries. Not too difficult, is it? + + +### Arbitrary Provider Priority + +When more than one provider is suitable for a given type, _jqwik_ will randomly +choose between all available options. That's why you'll have to take additional +measures if you want to replace an already registered provider. The trick +is to override a provider's `priority()` method that returns `0` by default: + +```java +public class AlternativeStringArbitraryProvider implements ArbitraryProvider { + @Override + public boolean canProvideFor(TypeUsage targetType) { + return targetType.isAssignableFrom(String.class); + } + + @Override + public int priority() { + return 1; + } + + @Override + public Set> provideFor(TypeUsage targetType, SubtypeProvider subtypeProvider) { + return Collections.singleton(Arbitraries.constant("A String")); + } +} +``` + +If you register this class as arbitrary provider any `@ForAll String` will +be resolved to `"A String"`. + +## Create your own Annotations for Arbitrary Configuration + +All you can do [to constrain default parameter generation](#constraining-default-generation) +is adding another annotation to a parameter or its parameter types. What if the existing parameters +do not suffice your needs? Is there a way to enhance the set of constraint annotations? Yes, there is! + +The mechanism you can plug into is similar to what you do when +[providing your own default arbitrary providers](#providing-default-arbitraries). That means: + +1. Create an implementation of an interface, in this case + [`ArbitraryConfigurator`](/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html). +2. Register the implementation using using Java’s `java.util.ServiceLoader` mechanism. + +### Arbitrary Configuration Example: `@Odd` + +To demonstrate the idea let's create an annotation `@Odd` which will constrain any integer +generation to only generate odd numbers. First things first, so here's +the [`@Odd` annotation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/Odd.java) +together with the +[configurator implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddConfigurator.java): + +```java +@Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER, ElementType.TYPE_USE }) +@Retention(RetentionPolicy.RUNTIME) +public @interface Odd { +} + +public class OddConfigurator extends ArbitraryConfiguratorBase { + public Arbitrary configure(Arbitrary arbitrary, Odd odd) { + return arbitrary.filter(number -> Math.abs(number % 2) == 1); + } +} +``` + +Mind that the implementation uses an abstract base class - instead of the interface itself - +which simplifies implementation if you're only interested in a single annotation. + +If you now +[register the implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/resources/META-INF/services/net.jqwik.api.configurators.ArbitraryConfigurator), +the [following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddProperties.java) +will work: + +```java +@Property +boolean oddIntegersOnly(@ForAll @Odd int aNumber) { + return Math.abs(aNumber % 2) == 1; +} +``` + +There are a few catches, though: + +- Currently `OddConfigurator` will accept any target type since type erasure + will get rid of `` in configure-method's signature at runtime. + Therefore, using `@Odd` together with e.g. `BigInteger` will lead to a runtime + exception. You can prevent that by explicitly accepting only some target types: + + ```java + public class OddConfigurator extends ArbitraryConfiguratorBase { + + @Override + protected boolean acceptTargetType(TypeUsage targetType) { + return targetType.isAssignableFrom(Integer.class); + } + + public Arbitrary configure(Arbitrary arbitrary, Odd odd) { + return arbitrary.filter(number -> Math.abs(number % 2) == 1); + } + } + ``` + + Alternatively, you can check for an object's type directly and use different + filter algorithms: + + ```java + public Arbitrary configure(Arbitrary arbitrary, Odd odd) { + return arbitrary.filter(number -> { + if (number instanceof Integer) + return Math.abs((int) number % 2) == 1; + if (number instanceof BigInteger) + return ((BigInteger) number).remainder(BigInteger.valueOf(2)) + .abs().equals(BigInteger.ONE); + return false; + }); + } + ``` + +- You can combine `@Odd` with other annotations like `@Positive` or `@Range` or another + self-made configurator. In this case the order of configurator application might play a role, + which can be influenced by overriding the `order()` method of a configurator. + +## Domain and Domain Context + +Until now you have seen two ways to specify which arbitraries will be created for a given parameter: + +- Annotate the parameter with `@ForAll("providerMethod")`. +- [Register a global arbitrary provider](#providing-default-arbitraries) + that will be triggered by a known parameter signature. + +In many cases both approaches can be tedious to set up or require constant repetition of the same +annotation value. There's another way that allows you to collect a number of arbitrary providers +(and also arbitrary configurators) in a single place, called a `DomainContext` and tell +a property method or container to only use providers and configurators from those domain contexts +that are explicitly stated in a `@Domain(Class)` annotation. + +As for ways to implement domain context classes have a look at +[DomainContext](/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html) +and [AbstractDomainContextBase](/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html). + + +### Domain example: American Addresses + +Let's say that US postal addresses play a crucial role in the software that we're developing. +That's why there are a couple of classes that represent important domain concepts: +`Street`, `State`, `City` and `Address`. Since we have to generate instances of those classes +for our properties, we collect all arbitrary provision code in +[AmericanAddresses](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/domains/AmericanAddresses.java). +Now look at +[this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/domains/AddressProperties.java): + +```java +class AddressProperties { + + @Property + @Domain(AmericanAddresses.class) + void anAddressWithAStreetNumber(@ForAll Address anAddress, @ForAll int streetNumber) { + } + + @Property + @Domain(AmericanAddresses.class) + void globalDomainNotPresent(@ForAll Address anAddress, @ForAll String anyString) { + } + + @Property + @Domain(DomainContext.Global.class) + @Domain(AmericanAddresses.class) + void globalDomainCanBeAdded(@ForAll Address anAddress, @ForAll String anyString) { + } +} +``` + +The first two properties above will resolve their arbitraries solely through providers +specified in `AmericanAddresses`, whereas the last one also uses the default (global) context. +Since `AmericanAddresses` does not configure any arbitrary provider for `String` parameters, +property method `globalDomainNotPresent` will fail with a `CannotFindArbitraryException`. + +## Generation from a Type's Interface + +Some domain classes are mostly data holders. They come with constructors +or factory methods to create them and you might want to create different +instances by "just" filling the constructors' parameters with values +that are themselves generated. Using the building blocks you've seen until +now requires the use of `Arbitrary.map()` or even `Combinators.combine(...).as(...)` +to invoke the relevant constructor(s) and/or factories yourself. +There's a simpler way, though... + +Consider a simple `Person` class: + +```java +public class Person { + + private String name; + private final int age; + + public Person(String name, int age) { + if (name == null || name.trim().isEmpty()) + throw new IllegalArgumentException(); + if (age < 0 || age > 130) + throw new IllegalArgumentException(); + + this.name = name; + this.age = age; + } + + @Override + public String toString() { + return String.format("%s (%d)", name, age); + } +} +``` + +A first step to use arbitrarily generated `Person` objects without having +to write a lot of _jqwik_-specific boiler plat code could look like that: + +```java +@Property +void aPersonsIsAlwaysValid(@ForAll @UseType Person aPerson) { + Assertions.assertThat(aPerson.name).isNotBlank(); + Assertions.assertThat(aPerson.age).isBetween(0, 130); +} +``` + +Notice the annotation `@UseType` which tells _jqwik_ to use the type +information of `Person` to generate it. By default the framework will +use all public constructors and all public, static factory methods in +the class in order to generate instances. Whenever there's an exception during +generation they will be ignored; that way you'll only get valid instances. + +There are quite a few ways usage and configuration options. Have a look +at the [complete example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/types/PersonProperties.java) +and check the following api entry points: + +- [UseType](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html) +- [UseTypeMode](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html) +- [Arbitraries.forType()](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#forType-java.lang.Class-) +- [TypeArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html) + +## Implement your own Arbitraries and Generators + +In your everyday property testing you will often get along without ever implementing +an arbitrary yourself. In cases where +[constraining default generation through annotations](#constraining-default-generation) +does not cut it, you can use all the mechanisms to configure, (flat-)map, filter and combine +the pre-implemented arbitraries. + +However, there are a few circumstances when you should think about rolling your own +implementation. The most important of which are: + +- You want to expand the fluent API for configuration purposes. +- The (randomized) generation of values needs different qualities than can easily be + derived by reusing existing arbitraries. +- Standard shrinking attempts do not come up with simple enough examples. + +In those - and maybe a few other cases - you can implement your own arbitrary. +To get a feel for what a usable implementation looks like, you might start with +having a look at some of the internal arbitraries: + +- [DefaultBigDecimalArbitrary](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultBigDecimalArbitrary.java) +- [DefaultStringArbitrary](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultStringArbitrary.java) + +Under the hood, most arbitraries use `RandomGenerator`s for the final value generation. Since +[`RandomGenerator`](/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html) +is a SAM type, most implementations are just lambda expression. +Start with the methods on +[`RandomGenerators`](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/randomized/RandomGenerators.java) +to figure out how they work. + +Since the topic is rather complicated, a detailed example will one day be published +in a separate article... + + +## Exhaustive Generation + +Sometimes it is possible to run a property method with all possible value combinations. +Consider the following example: + +```java +@Property +boolean allSquaresOnChessBoardExist( + @ForAll @CharRange(from = 'a', to = 'h') char column, + @ForAll @CharRange(from = '1', to = '8') char row +) { + return new ChessBoard().square(column, row).isOnBoard(); +} +``` + +The property is supposed to check that all valid squares in chess are present +on a new chess board. If _jqwik_ generated the values for `column` and `row` +randomly, 1000 tries might or might not produce all 64 different combinations. +Why not change strategies in cases like that and just iterate through all +possible values? + +This is exactly what _jqwik_ will do: +- As long as it can figure out that the maximum number of possible values + is equal or below a property's `tries` attribute (1000 by default), + all combinations will be generated. +- You can also enforce an exhaustive or randomized generation mode by using the + [Property.generation attribute](#optional-property-parameters). +- If _jqwik_ cannot figure out how to do exhaustive generation for one of the + participating arbitraries it will switch to randomized generation if in auto mode + or throw an exception if in exhaustive mode. + +Exhaustive generation is considered for: +- All integral types +- Characters and chars +- Enums +- Booleans +- Strings +- Fixed number of choices given by `Arbitraries.of()` +- Fixed number of choices given by `Arbitraries.shuffle()` +- Lists, sets, streams, optionals and maps of the above +- Combinations of the above using `Combinators.combine()` +- Mapped arbitraries using `Arbitrary.map()` +- Filtered arbitraries using `Arbitrary.filter()` +- Flat mapped arbitraries using `Arbitrary.flatMap()` +- And a few other derived arbitraries... + + +## Data-Driven Properties + +In addition to the usual randomized generation of property parameters you have also +the possibility to feed a property with preconceived or deterministically generated +parameter sets. Why would you want to do that? One reason might be that you are aware +of some problematic test cases but they are rare enough that _jqwik_'s randomization +strategies don't generate them (often enough). Another reason could be that you'd like +to feed some properties with prerecorded data - maybe even from production. +And last but not least there's a chance that you want to check for a concrete result +given a set of input parameters. + +Feeding data into a property is quite simple: + +```java +@Data +Iterable> fizzBuzzExamples() { + return Table.of( + Tuple.of(1, "1"), + Tuple.of(3, "Fizz"), + Tuple.of(5, "Buzz"), + Tuple.of(15, "FizzBuzz") + ); +} + +@Property +@FromData("fizzBuzzExamples") +void fizzBuzzWorks(@ForAll int index, @ForAll String result) { + Assertions.assertThat(fizzBuzz(index)).isEqualTo(result); +} +``` + +All you have to do is annotate the property method with +`@FromData("dataProviderReference")`. The method you reference must be +annotated with `@Data` and return an object of type `Iterable`. +The [`Table` class](/docs/1.1.6/javadoc/net/jqwik/api/Table.html) +is just a convenient way to create such an object, but you can return +any collection or create an implementation of your own. + +Keep in mind that the `Tuple` subtype you choose must conform to the +number of `@ForAll` parameters in your property method, e.g. `Tuple.Tuple3` +for a method with three parameters. Otherwise _jqwik_ will fail the property +and tell you that the provided data is inconsistent with the method's parameters. + +Data points are fed to the property in their provided order. +The `tries` parameter of `@Property` will constrain the maximum data points +being tried. +Unlike parameterized tests in JUnit4 or Jupiter, _jqwik_ will report only the +first falsified data point. Thus, fixing the first failure might lead to another +falsified data point later on. There is also _no shrinking_ being done for data-driven +properties since _jqwik_ has no information about the constraints under which +the external data was conceived or generated. + +## Rerunning Falsified Properties + +When you rerun properties after they failed, they will - by default - use +the previous random seed so that the next run will generate the exact same +parameter data and thereby expose the same failing behaviour. This simplifies +debugging and regression testing since it makes a property's falsification +stick until the problem has been fixed. + +If you want to, you can change this behaviour for a given property like this: + +```java +@Property(afterFailure = AfterFailureMode.RANDOM_SEED) +void myProperty() { ... } +``` + +The `afterFailure` property can have one of four values: + +- `AfterFailureMode.PREVIOUS_SEED`: Choose the same seed that provoked the failure in the first place. + Provided no arbitrary provider code has been changed, this will generate the same + sequence of generated parameters as the previous test run. + +- `AfterFailureMode.RANDOM_SEED`: Choose a new random seed even after failure in the previous run. + A constant seed will always prevail thought, as in the following example: + + ```java + @Property(seed = "424242", afterFailure = AfterFailureMode.RANDOM_SEED) + void myProperty() { ... } + ``` + +- `AfterFailureMode.SAMPLE_ONLY`: Only run the property with just the last falsified (and shrunk) + generated sample set of parameters. This only works if all parameters could + be serialized. Look into your test run log to check out if a serialization problem occurred. + +- `AfterFailureMode.SAMPLE_FIRST`: Same as `SAMPLE_ONLY` but generate additional examples if the + property no longer fails with the recorded sample. + + +You can also determine the default behaviour of all properties by setting +the `defaultAfterFailure` property in the [configuration file](jqwik-configuration) +to one of those enum values. + +## jqwik Configuration + +_jqwik_ will look for a file `jqwik.properties` in your classpath in which you can configure +a few basic parameters: + +``` +database = .jqwik-database # The database to store data of previous runs +defaultTries = 1000 # The default number of tries for each property +defaultMaxDiscardRatio = 5 # The default ratio before assumption misses make a property fail +useJunitPlatformReporter = false # Set to true if you want to use platform reporting +defaultAfterFailure = PREVIOUS_SEED # Set default behaviour for falsified properties +reportOnlyFailures = false # Set to true if only falsified properties should be reported +``` + +## Release Notes + +Read this version's [release notes](/release-notes.html#116). \ No newline at end of file diff --git a/docs/docs/current/javadoc/index.html b/docs/docs/current/javadoc/index.html index 4e48ee807..44aa24273 100644 --- a/docs/docs/current/javadoc/index.html +++ b/docs/docs/current/javadoc/index.html @@ -2,10 +2,10 @@ jqwik Javadoc - + -

Redirect to latest version

+

Redirect to latest version

diff --git a/docs/docs/current/user-guide.md b/docs/docs/current/user-guide.md index 59768fd72..3fece6acd 100644 --- a/docs/docs/current/user-guide.md +++ b/docs/docs/current/user-guide.md @@ -1,8 +1,8 @@ --- -title: jqwik User Guide - 1.1.5 +title: jqwik User Guide - 1.1.6 ---

The jqwik User Guide -1.1.5 +1.1.6

@@ -54,6 +54,7 @@ title: jqwik User Guide - 1.1.5 - [Shuffling Permutations](#shuffling-permutations) - [Default Types](#default-types) - [Collections, Streams, Arrays and Optional](#collections-streams-arrays-and-optional) + - [Maps](#maps) - [Collecting Values in a List](#collecting-values-in-a-list) - [Fluent Configuration Interfaces](#fluent-configuration-interfaces) - [Generate `null` values](#generate-null-values) @@ -140,7 +141,7 @@ repositories { ext.junitPlatformVersion = '1.4.2' ext.junitJupiterVersion = '5.4.2' -ext.jqwikVersion = '1.1.5' +ext.jqwikVersion = '1.1.6' test { useJUnitPlatform { @@ -216,7 +217,7 @@ and add the following dependency to your `pom.xml` file: net.jqwik jqwik - 1.1.5 + 1.1.6 test @@ -242,7 +243,7 @@ will allow you to use _jqwik_'s snapshot release which contains all the latest f I've never tried it but using jqwik without gradle or some other tool to manage dependencies should also work. You will have to add _at least_ the following jars to your classpath: -- `jqwik-1.1.5.jar` +- `jqwik-1.1.6.jar` - `junit-platform-engine-1.4.2.jar` - `junit-platform-commons-1.4.2.jar` - `opentest4j-1.1.1.jar` @@ -251,7 +252,7 @@ You will have to add _at least_ the following jars to your classpath: ## Creating an Example-based Test Just annotate a `public`, `protected` or package-scoped method with -[`@Example`](/docs/1.1.5/javadoc/net/jqwik/api/Example.html). +[`@Example`](/docs/1.1.6/javadoc/net/jqwik/api/Example.html). Example-based tests work just like plain JUnit-style test cases and are not supposed to take any parameters. @@ -261,7 +262,7 @@ A test case method must - or return nothing (`void`) in which case you will probably use [assertions](#assertions) in order to verify the test condition. -[Here](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/ExampleBasedTests.java) +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ExampleBasedTests.java) is a test class with two example-based tests: ```java @@ -290,10 +291,10 @@ _Properties_ are the core concept of [property-based testing](/#properties). You create a _Property_ by annotating a `public`, `protected` or package-scoped method with -[`@Property`](/docs/1.1.5/javadoc/net/jqwik/api/Property.html). +[`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html). In contrast to examples a property method is supposed to have one or more parameters, all of which must be annotated with -[`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html). +[`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html). At test runtime the exact parameter values of the property method will be filled in by _jqwik_. @@ -311,7 +312,7 @@ The first failed execution will stop value generation and be reported as failure - usually followed by an attempt to [shrink](#result-shrinking) the falsified parameter set. -[Here](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/PropertyBasedTests.java) +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/PropertyBasedTests.java) are two properties whose failures might surprise you: ```java @@ -342,7 +343,7 @@ in future versions. ### Optional `@Property` Parameters -The [`@Property`](/docs/1.1.5/javadoc/net/jqwik/api/Property.html) +The [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) annotation has a few optional values: - `int tries`: The number of times _jqwik_ tries to generate parameter values for this method. @@ -400,7 +401,7 @@ annotation has a few optional values: ### Additional Reporting You can switch on additional reporting aspects by adding a -[`@Report(Reporting[])` annotation](/docs/1.1.5/javadoc/net/jqwik/api/Property.html) +[`@Report(Reporting[])` annotation](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) to a property method. The following reporting aspects are available: @@ -425,8 +426,8 @@ static methods in `org.junit.jupiter.api.Assertions`. The current lifecycle of jqwik test methods is rather simple: - For each method, annotated with - [`@Property`](/docs/1.1.5/javadoc/net/jqwik/api/Property.html) - or [`@Example`](/docs/1.1.5/javadoc/net/jqwik/api/Example.html), + [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) + or [`@Example`](/docs/1.1.6/javadoc/net/jqwik/api/Example.html), a new instance of the containing test class is created in order to keep the individual tests isolated from each other. - If you have preparatory work to do for each method, @@ -460,7 +461,7 @@ class TestsWithLifecycle implements AutoCloseable { } ``` -[In this example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/TestsWithLifecycle.java) +[In this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TestsWithLifecycle.java) both the constructor and `close()` will be called twice times: Once for `anExample()` and once for `aProperty(...)`. @@ -481,7 +482,7 @@ maintainability of your tests. Groups can be nested and there lifecycle is also nested, that means that the lifecycle of a test class is also applied to inner groups of that container. -Have a look at [this example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/TestsWithGroups.java): +Have a look at [this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TestsWithGroups.java): ```java import net.jqwik.api.*; @@ -529,7 +530,7 @@ If you want to tweak display names even more, test container classes, groups, example methods and property methods can be labeled using the annotation `@Label("a label")`. This label will be used to display the element in test reports or within the IDE. -[In the following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/NamingExamples.java), +[In the following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/NamingExamples.java), every test relevant element has been labeled: ```java @@ -571,7 +572,7 @@ Those tag can be used to filter the set of tests Tags are handed down from container (class or group) to its children (test methods or groups). Have a look at -[the following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/TaggingExamples.java). +[the following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/TaggingExamples.java). Including the tag `integration-test` will include all tests of the class. @@ -590,13 +591,13 @@ class TaggingExamples { ``` Tags must follow certain rules as described -[here](/docs/1.1.5/javadoc/net/jqwik/api/Tag.html) +[here](/docs/1.1.6/javadoc/net/jqwik/api/Tag.html) ## Disabling Tests From time to time you might want to disable a test or all tests in a container temporarily. You can do that by adding the -[`@Disabled`](/docs/1.1.5/javadoc/net/jqwik/api/Disabled.html) annotation +[`@Disabled`](/docs/1.1.6/javadoc/net/jqwik/api/Disabled.html) annotation to a property method or a container class. ```java @@ -622,7 +623,7 @@ _Jqwik_ will refuse to execute methods that have Jupiter annotations. ## Default Parameter Generation _jqwik_ tries to generate values for those property method parameters that are -annotated with [`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html). If the annotation does not have a `value` parameter, +annotated with [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html). If the annotation does not have a `value` parameter, jqwik will use default generation for the following types: - `Object` @@ -637,9 +638,10 @@ jqwik will use default generation for the following types: - `Iterable` and `Iterator` of types that are provided by default. - `Optional` of types that are provided by default. - Array `T[]` of types that are provided by default. +- `Map` as long as `K` and `V` can also be provided by default generation. - `java.util.Random` -If you use [`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html) +If you use [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) with a value, e.g. `@ForAll("aMethodName")`, the method referenced by `"aMethodName"` will be called to provide an Arbitrary of the required type (see [Customized Parameter Generation](#customized-parameter-generation)). @@ -651,14 +653,14 @@ depending on the requested parameter type. #### Allow Null Values -- [`@WithNull(double value = 0.1)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/WithNull.html): +- [`@WithNull(double value = 0.1)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/WithNull.html): Inject `null` into generated values with a probability of `value`. Works for all generated types. #### Unique Values -- [`@Unique`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Unique.html): +- [`@Unique`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Unique.html): Prevent duplicate values to be generated _per try_. That means that there can still be duplicate values across several tries. That also means that `@Unique` only makes sense as annotation for a parameter type, e.g.: @@ -677,10 +679,10 @@ depending on the requested parameter type. #### String Length -- [`@StringLength(int value = 0, int min = 0, int max = 0)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/StringLength.html): +- [`@StringLength(int value = 0, int min = 0, int max = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/StringLength.html): Set either fixed length through `value` or configure the length range between `min` and `max`. -- [`@NotEmpty`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/NotEmpty.html): +- [`@NotEmpty`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html): Set minimum length to `1`. #### Character Sets @@ -695,65 +697,65 @@ will not be generated unless you explicitly include them using You can use the following annotations to restrict the set of allowed characters and even combine several of them: -- [`@Chars(chars[] value = {})`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Chars.html): +- [`@Chars(chars[] value = {})`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Chars.html): Specify a set of characters. This annotation can be repeated which will add up all allowed chars. -- [`@CharRange(char from = 0, char to = 0)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/CharRange.html): +- [`@CharRange(char from = 0, char to = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/CharRange.html): Specify a start and end character. This annotation can be repeated which will add up all allowed chars. -- [`@NumericChars`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/NumericChars.html): +- [`@NumericChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NumericChars.html): Use digits `0` through `9` -- [`@LowerChars`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/LowerChars.html): +- [`@LowerChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/LowerChars.html): Use lower case chars `a` through `z` -- [`@UpperChars`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/UpperChars.html): +- [`@UpperChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UpperChars.html): Use upper case chars `A` through `Z` -- [`@AlphaChars`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/AlphaChars.html): +- [`@AlphaChars`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/AlphaChars.html): Lower and upper case chars are allowed. -- [`@Whitespace`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Whitespace.html): +- [`@Whitespace`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Whitespace.html): All whitespace characters are allowed. They work for generated `String`s and `Character`s. #### List, Set, Stream and Array Size: -- [`@Size(int value = 0, int min = 0, int max = 0)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Size.html): +- [`@Size(int value = 0, int min = 0, int max = 0)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Size.html): Set either fixed size through `value` or configure the size range between `min` and `max`. -- [`@NotEmpty`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/NotEmpty.html): +- [`@NotEmpty`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/NotEmpty.html): Set minimum size to `1`. #### Integer Constraints -- [`@ByteRange(byte min = 0, byte max = Byte.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/ByteRange.html): +- [`@ByteRange(byte min = 0, byte max = Byte.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/ByteRange.html): For `Byte` and `byte` only. -- [`@ShortRange(short min = 0, short max = Short.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/ShortRange.html): +- [`@ShortRange(short min = 0, short max = Short.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/ShortRange.html): For `Short` and `short` only. -- [`@IntRange(int min = 0, int max = Integer.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/IntRange.html): +- [`@IntRange(int min = 0, int max = Integer.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/IntRange.html): For `Integer` and `int` only. -- [`@LongRange(long min = 0L, long max = Long.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/LongRange.html): +- [`@LongRange(long min = 0L, long max = Long.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/LongRange.html): For `Long` and `long` only. -- [`@BigRange(String min = "", String max = "")`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/BigRange.html): +- [`@BigRange(String min = "", String max = "")`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html): For `BigInteger` generation. -- [`@Positive`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Positive.html): +- [`@Positive`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html): Numbers larger than `0`. For all integral types. -- [`@Negative`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Negative.html): +- [`@Negative`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html): Numbers lower than `0`. For all integral types. #### Decimal Constraints -- [`@FloatRange(float min = 0.0f, float max = Float.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/FloatRange.html): +- [`@FloatRange(float min = 0.0f, float max = Float.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/FloatRange.html): For `Float` and `float` only. -- [`@DoubleRange(double min = 0.0, double max = Double.MAX_VALUE)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/DoubleRange.html): +- [`@DoubleRange(double min = 0.0, double max = Double.MAX_VALUE)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/DoubleRange.html): For `Double` and `double` only. -- [`@BigRange(String min = "", String max = "")`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/BigRange.html): +- [`@BigRange(String min = "", String max = "")`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/BigRange.html): For `BigDecimal` generation. -- [`@Scale(int value)`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Scale.html): +- [`@Scale(int value)`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Scale.html): Specify the maximum number of decimal places. For all decimal types. -- [`@Positive`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Positive.html): +- [`@Positive`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Positive.html): Numbers larger than `0.0`. For all decimal types. -- [`@Negative`](/docs/1.1.5/javadoc/net/jqwik/api/constraints/Negative.html): +- [`@Negative`](/docs/1.1.6/javadoc/net/jqwik/api/constraints/Negative.html): Numbers lower than `0.0`. For all decimal types. ### Constraining parameterized types @@ -776,7 +778,7 @@ _jqwik_ can also handle type variables and wildcard types. The handling of upper bounds works mostly as you would expect it. Consider -[the following examples](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/VariableTypedPropertyExamples.java): +[the following examples](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/VariableTypedPropertyExamples.java): ```java class VariableTypedPropertyExamples { @@ -816,7 +818,7 @@ _in the same call to the method_! ## Self-Made Annotations You can [make your own annotations](http://junit.org/junit5/docs/5.0.0/user-guide/#writing-tests-meta-annotations) -instead of using _jqwik_'s built-in ones. BTW, '@Example' is nothing but a plain annotation using [`@Property`](/docs/1.1.5/javadoc/net/jqwik/api/Property.html) +instead of using _jqwik_'s built-in ones. BTW, '@Example' is nothing but a plain annotation using [`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) as "meta"-annotation. The following example provides an annotation to constrain String or Character generation to German letters only: @@ -824,7 +826,7 @@ The following example provides an annotation to constrain String or Character ge ```java @Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER }) @Retention(RetentionPolicy.RUNTIME) -@Digits +@NumericChars @AlphaChars @Chars({'ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß'}) @Chars({' ', '.', ',', ';', '?', '!'}) @@ -844,7 +846,7 @@ which constrains their applicability to simple cases. Sometimes the possibilities of adjusting default parameter generation through annotations is not enough. In that case you can delegate parameter provision to another method. Look at the -[following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/ProvideMethodExamples.java): +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ProvideMethodExamples.java): ```java @Property @@ -868,14 +870,14 @@ Arbitrary numbers() { } ``` -The String value of the [`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html) +The String value of the [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) annotation serves as a reference to a method within the same class (or one of its superclasses or owning classes). This reference refers to either the method's name or the String value of the method's `@Provide` annotation. The providing method has to return an object of type -[`@Arbitrary`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html) +[`@Arbitrary`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html) where `T` is the static type of the parameter to be provided. Parameter provision usually starts with a @@ -887,11 +889,11 @@ by one or more [filtering](#filtering), [mapping](#mapping) or ### Static `Arbitraries` methods The starting point for generation usually is a static method call on class -[`Arbitraries`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html). +[`Arbitraries`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html). #### Generate values yourself -- [`Arbitrary randomValue(Function generator)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#randomValue-java.util.function.Function-): +- [`Arbitrary randomValue(Function generator)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#randomValue-java.util.function.Function-): Take a `random` instance and create an object from it. Those values cannot be [shrunk](#result-shrinking), though. @@ -911,21 +913,21 @@ The starting point for generation usually is a static method call on class } ``` -- [`Arbitrary fromGenerator(RandomGenerator generator)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#fromGenerator-net.jqwik.api.RandomGenerator-): +- [`Arbitrary fromGenerator(RandomGenerator generator)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#fromGenerator-net.jqwik.api.RandomGenerator-): If the number of _tries_ influences value generation or if you want to allow for [shrinking](#result-shrinking) you have to provide your own `RandomGenerator` implementation. #### Select values randomly -- [`Arbitrary of(U... values)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#of-U...-): +- [`Arbitrary of(U... values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#of-U...-): Choose randomly from a list of values. Shrink towards the first one. -- [`Arbitrary samples(T... samples)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#samples-T...-): +- [`Arbitrary samples(T... samples)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#samples-T...-): Go through samples from first to last. Shrink towards the first sample. If instead you want to _add_ samples to an existing arbitrary you'd rather use - [`Arbitrary.withSamples(T... samples)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#withSamples-T...-). + [`Arbitrary.withSamples(T... samples)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#withSamples-T...-). The following arbitrary: ```java @@ -938,13 +940,13 @@ The starting point for generation usually is a static method call on class will first generate the 7 enumerated prime numbers and only then generate random integers between -1000 and +1000. -- [`Arbitrary of(Class enumClass)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#of-java.lang.Class-): +- [`Arbitrary of(Class enumClass)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#of-java.lang.Class-): Choose randomly from all values of an `enum`. Shrink towards first enum value. #### Select randomly with Weights -If you have a set of values to choose from with weighted probabilities, use -[`Arbitraries.frequency(...)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#frequency-net.jqwik.api.Tuple.Tuple2...-): +If you have a set of values to choose from with weighted probabilities, use ` +[`Arbitraries.frequency(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#frequency-net.jqwik.api.Tuple.Tuple2...-): ```java @Property @@ -965,7 +967,7 @@ Arbitrary abcdWeighted() { The first value of the tuple specifies the frequency of a particular value in relation to the sum of all frequencies. In -[the given example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/ChoosingExamples.java#L17) +[the given example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ChoosingExamples.java#L17) the sum is 36, thus `"a"` will be generated with a probability of `1/36` whereas `"d"` has a generation probability of `20/36` (= `5/9`). @@ -973,54 +975,54 @@ Shrinking moves towards the start of the frequency list. #### Integers -- [`ByteArbitrary bytes()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#bytes--) -- [`ShortArbitrary shorts()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#shorts--) -- [`IntegerArbitrary integers()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#integers--) -- [`LongArbitrary longs()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#longs--) -- [`BigIntegerArbitrary bigIntegers()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#bigIntegers--) +- [`ByteArbitrary bytes()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bytes--) +- [`ShortArbitrary shorts()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shorts--) +- [`IntegerArbitrary integers()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#integers--) +- [`LongArbitrary longs()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#longs--) +- [`BigIntegerArbitrary bigIntegers()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bigIntegers--) #### Decimals -- [`FloatArbitrary floats()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#floats--) -- [`DoubleArbitrary doubles()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#doubles--) -- [`BigDecimalArbitrary bigDecimals()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#bigDecimals--) +- [`FloatArbitrary floats()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#floats--) +- [`DoubleArbitrary doubles()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#doubles--) +- [`BigDecimalArbitrary bigDecimals()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#bigDecimals--) #### Characters and Strings -- [`StringArbitrary strings()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#strings--) -- [`CharacterArbitrary chars()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#chars--) +- [`StringArbitrary strings()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#strings--) +- [`CharacterArbitrary chars()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#chars--) #### java.util.Random -- [`Arbitrary randoms()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#randoms--): +- [`Arbitrary randoms()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#randoms--): Random instances will never be shrunk #### Constants -- [`Arbitrary constant(T value)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#constant-T-): +- [`Arbitrary constant(T value)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#constant-T-): In each try use the same unshrinkable `value` of type `T`. #### Create -- [`Arbitrary create(Supplier supplier)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#constant-java.util.function.Supplier-): +- [`Arbitrary create(Supplier supplier)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#constant-java.util.function.Supplier-): In each try use a new unshrinkable instance of type `T` using `supplier` to freshly create it. #### Shuffling Permutations -- [`Arbitrary> shuffle(T ... values)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#shuffle-T...-): +- [`Arbitrary> shuffle(T ... values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shuffle-T...-): Return unshrinkable permutations of the `values` handed in. -- [`Arbitrary> shuffle(List values)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#shuffle-java.util.List-): +- [`Arbitrary> shuffle(List values)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#shuffle-java.util.List-): Return unshrinkable permutations of the `values` handed in. #### Default Types -- [`Arbitrary defaultFor(Class type, Class ... parameterTypes)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#defaultFor-java.lang.Class-java.lang.Class...-): +- [`Arbitrary defaultFor(Class type, Class ... parameterTypes)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#defaultFor-java.lang.Class-java.lang.Class...-): Return the default arbitrary available for type `type` [if one is provided](#providing-default-arbitraries) by default. For parameterized types you can also specify the parameter types. Keep in mind, though, that the parameter types are lost in the type signature and therefore - cannot be used in the respective [`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html) property method parameter. Raw types and wildcards, + cannot be used in the respective [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) property method parameter. Raw types and wildcards, however, match; thus the following example will work: ```java @@ -1040,18 +1042,24 @@ Shrinking moves towards the start of the frequency list. Generating types who have generic type parameters, requires to start with an `Arbitrary` instance for the generic type. You can create the corresponding collection arbitrary from there: -- [`Arbitrary.list()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#list--) -- [`Arbitrary.set()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#set--) -- [`Arbitrary.streamOf()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#stream--) -- [`Arbitrary.array(Class arrayClass)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#array-java.lang.Class-) -- [`Arbitrary.optional()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#optional--) +- [`Arbitrary.list()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#list--) +- [`Arbitrary.set()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#set--) +- [`Arbitrary.streamOf()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#stream--) +- [`Arbitrary.array(Class arrayClass)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#array-java.lang.Class-) +- [`Arbitrary.optional()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#optional--) + +### Maps + +Generating instances of type `Map` is a bit different since two arbitraries +are needed, one for the key and one for the value. Therefore you have to use +[`Arbitraries.maps(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#maps-net.jqwik.api.Arbitrary-net.jqwik.api.Arbitrary-): ### Collecting Values in a List If you do not want any random combination of values in your list - as can be done with `Arbitrary.list()` - you have the possibility to collect random values in a list until a certain condition is fulfilled. -[`Arbitrary.collect(Predicate condition)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#collect-java.util.function.Predicate-) +[`Arbitrary.collect(Predicate condition)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#collect-java.util.function.Predicate-) is what you need in those cases. Imagine you need a list of integers the sum of which should be at least `1000`. @@ -1067,21 +1075,21 @@ Arbitrary> collected = integers.collect(list -> sum(list) >= 1000) Most specialized arbitrary interfaces provide special methods to configure things like size, length, boundaries etc. Have a look at the Java doc for the following types: -- [BigDecimalArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html) -- [BigIntegerArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html) -- [ByteArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html) -- [CharacterArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html) -- [DoubleArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html) -- [FloatArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html) -- [IntegerArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html) -- [LongArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html) -- [ShortArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html) -- [SizableArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html) -- [StringArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html) +- [BigDecimalArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigDecimalArbitrary.html) +- [BigIntegerArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/BigIntegerArbitrary.html) +- [ByteArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ByteArbitrary.html) +- [CharacterArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/CharacterArbitrary.html) +- [DoubleArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/DoubleArbitrary.html) +- [FloatArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/FloatArbitrary.html) +- [IntegerArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/IntegerArbitrary.html) +- [LongArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/LongArbitrary.html) +- [ShortArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/ShortArbitrary.html) +- [SizableArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/SizableArbitrary.html) +- [StringArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/StringArbitrary.html) Here are a -[two examples](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/FluentConfigurationExamples.java) +[two examples](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FluentConfigurationExamples.java) to give you a hint of what you can do: ```java @@ -1099,7 +1107,7 @@ Arbitrary> fixedSizedListOfPositiveIntegers() { ### Generate `null` values Predefined generators will never create `null` values. If you want to allow that, -call [`Arbitrary.injectNull(double probability)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#injectNull-double-). +call [`Arbitrary.injectNull(double probability)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#injectNull-double-). The following provider method creates an arbitrary that will return a `null` String in about 1 of 100 generated values. @@ -1114,7 +1122,7 @@ Arbitrary stringsWithNull() { If you want to include only part of all the values generated by an arbitrary, use -[`Arbitrary.filter(Predicate filterPredicate)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#filter-java.util.function.Predicate-). +[`Arbitrary.filter(Predicate filterPredicate)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#filter-java.util.function.Predicate-). The following arbitrary will filter out all even numbers from the stream of generated integers: @@ -1133,7 +1141,7 @@ the current property will be abandoned by throwing an exception. If you want to make sure that all the values generated by an arbitrary are unique, use -[`Arbitrary.unique()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#unique--). +[`Arbitrary.unique()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#unique--). The following arbitrary will generate integers between 1 and 1000 but never the same integer twice: ```java @@ -1151,7 +1159,7 @@ the current property will be abandoned by throwing an exception. Sometimes it's easier to start with an existing arbitrary and use its generated values to build other objects from them. In that case, use -[`Arbitrary.map(Function mapper)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#map-java.util.function.Function-). +[`Arbitrary.map(Function mapper)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#map-java.util.function.Function-). The following example uses generated integers to create numerical Strings: ```java @@ -1171,7 +1179,7 @@ will move towards the lowest allowed number, that is `10000`. Similar as in the case of `Arbitrary.map(..)` there are situations in which you want to use a generated value in order to create another Arbitrary from it. Sounds complicated? Have a look at the -[following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L26): +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L26): ```java @Property @@ -1204,9 +1212,9 @@ However, both have dependencies: - `end` must not be larger than the string size - `begin` must not be larger than `end` You can make _jqwik_ create all three values by using -[`flatMap`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#flatMap-java.util.function.Function-) +[`flatMap`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#flatMap-java.util.function.Function-) combined with a tuple type -[like this](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L32): +[like this](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/FlatMappingExamples.java#L32): ```java @@ -1262,7 +1270,7 @@ Arbitrary oneOfThree() { } ``` -[In this example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/OneOfExamples.java) +[In this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/OneOfExamples.java) the statistics should also give you an equal distribution between the three types of integers. @@ -1297,11 +1305,11 @@ Arbitrary oneOfThree() { Sometimes just mapping a single stream of generated values is not enough to generate a more complicated domain object. In those cases you can combine several arbitraries to a single result arbitrary using -[`Combinators.combine()`](/docs/1.1.5/javadoc/net/jqwik/api/Combinators.html#combine-net.jqwik.api.Arbitrary-net.jqwik.api.Arbitrary-) +[`Combinators.combine()`](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#combine-net.jqwik.api.Arbitrary-net.jqwik.api.Arbitrary-) with up to eight arbitraries. [Create an issue on github](https://github.com/jlink/jqwik/issues) if you need more than eight. -[The following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/MappingAndCombinatorExamples.java#L25) +[The following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/MappingAndCombinatorExamples.java#L25) generates `Person` instances from three arbitraries as inputs. ```java @@ -1397,8 +1405,8 @@ Arbitrary validPeopleWithBuilder() { ``` Have a look at -[Combinators.withBuilder(Supplier)](/docs/1.1.5/javadoc/net/jqwik/api/Combinators.html#withBuilder-java.util.function.Supplier-) -and [Combinators.withBuilder(Arbitrary)](/docs/1.1.5/javadoc/net/jqwik/api/Combinators.html#withBuilder-net.jqwik.api.Arbitrary-) +[Combinators.withBuilder(Supplier)](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#withBuilder-java.util.function.Supplier-) +and [Combinators.withBuilder(Arbitrary)](/docs/1.1.6/javadoc/net/jqwik/api/Combinators.html#withBuilder-net.jqwik.api.Arbitrary-) to check the API. #### Flat Combination @@ -1445,14 +1453,14 @@ Some generators (e.g. most number generators) are sensitive to the The default value for `genSize` is the number of tries configured for the property they are used in. If there is a need to influence the behaviour of generators you can do so by using -[`Arbitrary.fixGenSize(int)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#fixGenSize-int-).. +[`Arbitrary.fixGenSize(int)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#fixGenSize-int-).. ### Generating all possible values There are a few cases when you don't want to generate individual values from an arbitrary but use all possible values to construct another arbitrary. This can be achieved through -[`Arbitrary.allValues()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#allValues--). +[`Arbitrary.allValues()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#allValues--). Return type is `Optional>` because _jqwik_ can only perform this task if [exhaustive generation](#exhaustive-generation) is doable. @@ -1462,7 +1470,7 @@ Return type is `Optional>` because _jqwik_ can only perform this task You can also use an arbitrary to iterate through all values it specifies. Use -[`Arbitrary.forEachValue(Consumer action)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitrary.html#forEachValue-java.util.function.Consumer-). +[`Arbitrary.forEachValue(Consumer action)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitrary.html#forEachValue-java.util.function.Consumer-). for that purpose. This only works when [exhaustive generation](#exhaustive-generation) is possible. In other cases the attempt to iterate will result in an exception. @@ -1493,7 +1501,7 @@ is one application field but you can also use it for other stuff. ### Probabilistic Recursion Look at the -[following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/RecursiveExamples.java) +[following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/RecursiveExamples.java) which generates sentences by recursively adding words to a sentence: ```java @@ -1523,7 +1531,7 @@ private StringArbitrary word() { There are two things to which you must pay attention: -- Use [`Arbitraries.lazy(Supplier>)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#lazy-java.util.function.Supplier-) +- Use [`Arbitraries.lazy(Supplier>)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#lazy-java.util.function.Supplier-) to wrap the recursive call itself. Otherwise _jqwik_'s attempt to build the arbitrary will quickly result in a stack overflow. - Every recursion needs one or more base cases in order to stop recursion at some point. @@ -1563,7 +1571,7 @@ Arbitrary deterministic(int length, Arbitrary sentence) { ### Deterministic Recursion with `recursive()` To further simplify this _jqwik_ provides a helper function: -[`Arbitraries.recursive(...)`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#recursive-java.util.function.Supplier-java.util.function.Function-int-). +[`Arbitraries.recursive(...)`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#recursive-java.util.function.Supplier-java.util.function.Function-int-). Using that further simplifies the example: ```java @@ -1648,7 +1656,7 @@ when they can be invoked and some objects have invariants that should never be v of the sequence of performed actions. To make this abstract concept concrete, let's look at a -[simple stack implementation](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStack.java): +[simple stack implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStack.java): ```java public class MyStringStack { @@ -1665,7 +1673,7 @@ public class MyStringStack { We can see at least three _actions_ with their preconditions and expected state changes: -- [`Push`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PushAction.java): +- [`Push`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PushAction.java): Push a string onto the stack. The string should be on top afterwards and the size should have increased by 1. @@ -1695,7 +1703,7 @@ We can see at least three _actions_ with their preconditions and expected state } ``` -- [`Pop`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PopAction.java): +- [`Pop`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/PopAction.java): If (and only if) the stack is not empty, pop the element on top off the stack. The size of the stack should have decreased by 1. @@ -1723,7 +1731,7 @@ We can see at least three _actions_ with their preconditions and expected state } ``` -- [`Clear`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/stateful/mystack/ClearAction.java): +- [`Clear`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/ClearAction.java): Remove all elements from the stack which should be empty afterwards. ```java @@ -1749,7 +1757,7 @@ The fundamental property that _jqwik_ should try to falsify is: (aka postconditions) should be fulfilled. We can formulate that quite easily as a -[_jqwik_ property](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStackProperties.java): +[_jqwik_ property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/stateful/mystack/MyStringStackProperties.java): ```java class MyStringStackProperties { @@ -1779,11 +1787,11 @@ class MyStringStackProperties { ``` The interesting API elements are -- [`ActionSequence`](/docs/1.1.5/javadoc/net/jqwik/api/stateful/ActionSequence.html): +- [`ActionSequence`](/docs/1.1.6/javadoc/net/jqwik/api/stateful/ActionSequence.html): A generic collection type especially crafted for holding and shrinking of a list of actions. As a convenience it will apply the actions to a model when you call `run(model)`. -- [`Arbitraries.sequences()`](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#sequences-net.jqwik.api.Arbitrary-): +- [`Arbitraries.sequences()`](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#sequences-net.jqwik.api.Arbitrary-): This method will create the arbitrary for generating an `ActionSequence` given the arbitrary for generating actions. @@ -1864,7 +1872,7 @@ If you want to constrain the set of generated values in a way that embraces more than one parameter, [filtering](#filtering) does not work. What you can do instead is putting one or more assumptions at the beginning of your property. -[The following property](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/AssumptionExamples.java) +[The following property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/AssumptionExamples.java) works only on strings that are not equal: ```java @@ -1880,7 +1888,7 @@ boolean comparingUnequalStrings( // ``` This is a reasonable use of -[`Assume.that(boolean condition)`](/docs/1.1.5/javadoc/net/jqwik/api/Assume.html#that-boolean-) +[`Assume.that(boolean condition)`](/docs/1.1.6/javadoc/net/jqwik/api/Assume.html#that-boolean-) because most generated value sets will pass through. Have a look at a seemingly similar example: @@ -1913,7 +1921,7 @@ The problem is that - given a random generation of two strings - only in very fe one string will be contained in the other. _jqwik_ will report a property as `exhausted` if the ratio between generated and accepted parameters is higher than 5. You can change the maximum discard ratio by specifying a parameter `maxDiscardRatio` in the -[`@Property`](/docs/1.1.5/javadoc/net/jqwik/api/Property.html) annotation. +[`@Property`](/docs/1.1.6/javadoc/net/jqwik/api/Property.html) annotation. That's why changing to `@Property(maxDiscardRatio = 100)` in the previous example will probably result in a successful property run, even though only a handful cases - of 1000 generated - will actually be checked. @@ -1921,7 +1929,7 @@ cases - of 1000 generated - will actually be checked. In many cases turning up the accepted discard ration is a bad idea. With some creativity we can often avoid the problem by generating out test data a bit differently. Look at this variant of the above property, which also uses -[`Assume.that()`](/docs/1.1.5/javadoc/net/jqwik/api/Assume.html#that-boolean-) +[`Assume.that()`](/docs/1.1.6/javadoc/net/jqwik/api/Assume.html#that-boolean-) but with a much lower discard ratio: ```java @@ -1976,7 +1984,7 @@ The general idea and its advantages are explained [here](http://hypothesis.works/articles/integrated-shrinking/). Consider a somewhat -[more complicated example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/ShrinkingExamples.java#L15): +[more complicated example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/ShrinkingExamples.java#L15): ```java @Property @@ -2083,7 +2091,7 @@ bytes, shorts, integers, longs, floats, doubles, BigIntegers and BigDecimals. In many situations you'd like to know if _jqwik_ will really generate the kind of values you expect and if the frequency and distribution of certain value classes meets your testing needs. -[`Statistics.collect()`](/docs/1.1.5/javadoc/net/jqwik/api/Statistics.html#collect-java.lang.Object...-) +[`Statistics.collect()`](/docs/1.1.6/javadoc/net/jqwik/api/Statistics.html#collect-java.lang.Object...-) is made for this exact purpose. In the most simple case you'd like to know how often a certain value @@ -2171,7 +2179,7 @@ collected statistics = As you can see, collected `null` values are not being reported. -[Here](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/StatisticsExamples.java) +[Here](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/StatisticsExamples.java) are a couple of examples to try out. ## Providing Default Arbitraries @@ -2181,7 +2189,7 @@ classes, in all of your properties, and without having to add `@Provide` method to all test classes. _jqwik_ enables this feature by using Java’s `java.util.ServiceLoader` mechanism. All you have to do is: -- Implement the interface [`ArbitraryProvider`](/docs/1.1.5/javadoc/net/jqwik/api/providers/ArbitraryProvider.html).
+- Implement the interface [`ArbitraryProvider`](/docs/1.1.6/javadoc/net/jqwik/api/providers/ArbitraryProvider.html).
The implementing class _must_ have a default constructor without parameters. - Register the implementation class in file @@ -2191,14 +2199,14 @@ Java’s `java.util.ServiceLoader` mechanism. All you have to do is: _jqwik_ will then add an instance of your arbitrary provider into the list of its default providers. Those default providers are considered for every test parameter annotated -with [`@ForAll`](/docs/1.1.5/javadoc/net/jqwik/api/ForAll.html) that has no explicit `value`. +with [`@ForAll`](/docs/1.1.6/javadoc/net/jqwik/api/ForAll.html) that has no explicit `value`. By using this mechanism you can also replace the default providers packaged into _jqwik_. ### Simple Arbitrary Providers A simple provider is one that delivers arbitraries for types without type variables. -Consider the class [`Money`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/defaultprovider/Money.java): +Consider the class [`Money`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/Money.java): ```java public class Money { @@ -2222,7 +2230,7 @@ public class Money { ``` If you register the following class -[`MoneyArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyArbitraryProvider.java): +[`MoneyArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyArbitraryProvider.java): ```java package my.own.provider; @@ -2245,7 +2253,7 @@ public class MoneyArbitraryProvider implements ArbitraryProvider { ``` in file -[`META-INF/services/net.jqwik.api.providers.ArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/resources/META-INF/services/net.jqwik.api.providers.ArbitraryProvider) +[`META-INF/services/net.jqwik.api.providers.ArbitraryProvider`](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/resources/META-INF/services/net.jqwik.api.providers.ArbitraryProvider) with such an entry: ``` @@ -2253,7 +2261,7 @@ my.own.provider.MoneyArbitraryProvider ``` The -[following property](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyProperties.java) +[following property](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/defaultprovider/MoneyProperties.java) will run without further ado - regardless the class you put it in: ```java @@ -2333,16 +2341,16 @@ The mechanism you can plug into is similar to what you do when [providing your own default arbitrary providers](#providing-default-arbitraries). That means: 1. Create an implementation of an interface, in this case - [`ArbitraryConfigurator`](/docs/1.1.5/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html). + [`ArbitraryConfigurator`](/docs/1.1.6/javadoc/net/jqwik/api/configurators/ArbitraryConfigurator.html). 2. Register the implementation using using Java’s `java.util.ServiceLoader` mechanism. ### Arbitrary Configuration Example: `@Odd` To demonstrate the idea let's create an annotation `@Odd` which will constrain any integer generation to only generate odd numbers. First things first, so here's -the [`@Odd` annotation](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/Odd.java) +the [`@Odd` annotation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/Odd.java) together with the -[configurator implementation](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddConfigurator.java): +[configurator implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddConfigurator.java): ```java @Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER, ElementType.TYPE_USE }) @@ -2361,8 +2369,8 @@ Mind that the implementation uses an abstract base class - instead of the interf which simplifies implementation if you're only interested in a single annotation. If you now -[register the implementation](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/resources/META-INF/services/net.jqwik.api.configurators.ArbitraryConfigurator), -the [following example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddProperties.java) +[register the implementation](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/resources/META-INF/services/net.jqwik.api.configurators.ArbitraryConfigurator), +the [following example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/arbitraryconfigurator/OddProperties.java) will work: ```java @@ -2428,8 +2436,8 @@ a property method or container to only use providers and configurators from thos that are explicitly stated in a `@Domain(Class)` annotation. As for ways to implement domain context classes have a look at -[DomainContext](/docs/1.1.5/javadoc/net/jqwik/api/domains/DomainContext.html) -and [AbstractDomainContextBase](/docs/1.1.5/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html). +[DomainContext](/docs/1.1.6/javadoc/net/jqwik/api/domains/DomainContext.html) +and [AbstractDomainContextBase](/docs/1.1.6/javadoc/net/jqwik/api/domains/AbstractDomainContextBase.html). ### Domain example: American Addresses @@ -2438,9 +2446,9 @@ Let's say that US postal addresses play a crucial role in the software that we'r That's why there are a couple of classes that represent important domain concepts: `Street`, `State`, `City` and `Address`. Since we have to generate instances of those classes for our properties, we collect all arbitrary provision code in -[AmericanAddresses](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/domains/AmericanAddresses.java). +[AmericanAddresses](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/domains/AmericanAddresses.java). Now look at -[this example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/domains/AddressProperties.java): +[this example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/domains/AddressProperties.java): ```java class AddressProperties { @@ -2521,13 +2529,13 @@ the class in order to generate instances. Whenever there's an exception during generation they will be ignored; that way you'll only get valid instances. There are quite a few ways usage and configuration options. Have a look -at the [complete example](https://github.com/jlink/jqwik/blob/1.1.5/documentation/src/test/java/net/jqwik/docs/types/PersonProperties.java) +at the [complete example](https://github.com/jlink/jqwik/blob/1.1.6/documentation/src/test/java/net/jqwik/docs/types/PersonProperties.java) and check the following api entry points: -- [UseType](/docs/1.1.5/javadoc/net/jqwik/api/constraints/UseType.html) -- [UseTypeMode](/docs/1.1.5/javadoc/net/jqwik/api/constraints/UseTypeMode.html) -- [Arbitraries.forType()](/docs/1.1.5/javadoc/net/jqwik/api/Arbitraries.html#forType-java.lang.Class-) -- [TypeArbitrary](/docs/1.1.5/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html) +- [UseType](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseType.html) +- [UseTypeMode](/docs/1.1.6/javadoc/net/jqwik/api/constraints/UseTypeMode.html) +- [Arbitraries.forType()](/docs/1.1.6/javadoc/net/jqwik/api/Arbitraries.html#forType-java.lang.Class-) +- [TypeArbitrary](/docs/1.1.6/javadoc/net/jqwik/api/arbitraries/TypeArbitrary.html) ## Implement your own Arbitraries and Generators @@ -2549,14 +2557,14 @@ In those - and maybe a few other cases - you can implement your own arbitrary. To get a feel for what a usable implementation looks like, you might start with having a look at some of the internal arbitraries: -- [DefaultBigDecimalArbitrary](https://github.com/jlink/jqwik/blob/1.1.5/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultBigDecimalArbitrary.java) -- [DefaultStringArbitrary](https://github.com/jlink/jqwik/blob/1.1.5/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultStringArbitrary.java) +- [DefaultBigDecimalArbitrary](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultBigDecimalArbitrary.java) +- [DefaultStringArbitrary](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/DefaultStringArbitrary.java) Under the hood, most arbitraries use `RandomGenerator`s for the final value generation. Since -[`RandomGenerator`](/docs/1.1.5/javadoc/net/jqwik/api/RandomGenerator.html) +[`RandomGenerator`](/docs/1.1.6/javadoc/net/jqwik/api/RandomGenerator.html) is a SAM type, most implementations are just lambda expression. Start with the methods on -[`RandomGenerators`](https://github.com/jlink/jqwik/blob/1.1.5/engine/src/main/java/net/jqwik/engine/properties/arbitraries/randomized/RandomGenerators.java) +[`RandomGenerators`](https://github.com/jlink/jqwik/blob/1.1.6/engine/src/main/java/net/jqwik/engine/properties/arbitraries/randomized/RandomGenerators.java) to figure out how they work. Since the topic is rather complicated, a detailed example will one day be published @@ -2602,7 +2610,7 @@ Exhaustive generation is considered for: - Strings - Fixed number of choices given by `Arbitraries.of()` - Fixed number of choices given by `Arbitraries.shuffle()` -- Lists, sets, streams, optionals of the above +- Lists, sets, streams, optionals and maps of the above - Combinations of the above using `Combinators.combine()` - Mapped arbitraries using `Arbitrary.map()` - Filtered arbitraries using `Arbitrary.filter()` @@ -2644,7 +2652,7 @@ void fizzBuzzWorks(@ForAll int index, @ForAll String result) { All you have to do is annotate the property method with `@FromData("dataProviderReference")`. The method you reference must be annotated with `@Data` and return an object of type `Iterable`. -The [`Table` class](/docs/1.1.5/javadoc/net/jqwik/api/Table.html) +The [`Table` class](/docs/1.1.6/javadoc/net/jqwik/api/Table.html) is just a convenient way to create such an object, but you can return any collection or create an implementation of your own. @@ -2719,4 +2727,4 @@ reportOnlyFailures = false # Set to true if only falsified properties s ## Release Notes -Read this version's [release notes](/release-notes.html#115). \ No newline at end of file +Read this version's [release notes](/release-notes.html#116). \ No newline at end of file diff --git a/docs/release-notes.md b/docs/release-notes.md index 99cf0273b..be32d71e6 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -9,7 +9,7 @@ title: jqwik Release Notes ### Table of Contents -- [1.1.6-SNAPSHOT](#116-snapshot) +- [1.1.6](#116) - [1.1.5](#115) - [1.1.4](#114) - [1.1.3](#113) @@ -22,17 +22,19 @@ title: jqwik Release Notes -## 1.1.6-SNAPSHOT +## 1.1.6

-User guide +User guide +and +javadoc

- Removed dependencies to internal classes in JUnit platform -- Added [`Arbitraries.maps()`](/docs/snapshot/user-guide.html#maps) +- Added [`Arbitraries.maps()`](/docs/1.1.6/user-guide.html#maps) - Added default generation for `Map` instances - `@Domain` annotation can now also refer to inner class of test container's base class. - Thanks to https://github.com/larsrh for that pull request! + Many thanks to [larsrh](https://github.com/larsrh) for that pull request! ## 1.1.5