Package io.vavr.test
Class Property
java.lang.Object
io.vavr.test.Property
A property builder which provides a fluent API to build checkable properties.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Internally used to provide more specific error messages.(package private) static class
Internally used to model conditions composed of pre- and post-condition.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a logical for all quantor.static class
Represents a 1-ary checkable property.static class
Represents a 2-ary checkable property.static class
Represents a 3-ary checkable property.static class
Represents a 4-ary checkable property.static class
Represents a 5-ary checkable property.static class
Represents a 6-ary checkable property.static class
Represents a 7-ary checkable property.static class
Represents a 8-ary checkable property. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static Property.CheckError
arbitraryError
(int position, int size, Throwable cause) Creates a CheckError caused by an exception when obtaining a generator.static Property
Defines a new Property.<T1> Property.ForAll1
<T1> Returns a logical for all quantor of 1 given variables.<T1,
T2> Property.ForAll2 <T1, T2> Returns a logical for all quantor of 2 given variables.<T1,
T2, T3>
Property.ForAll3<T1, T2, T3> Returns a logical for all quantor of 3 given variables.<T1,
T2, T3, T4>
Property.ForAll4<T1, T2, T3, T4> Returns a logical for all quantor of 4 given variables.<T1,
T2, T3, T4, T5>
Property.ForAll5<T1, T2, T3, T4, T5> Returns a logical for all quantor of 5 given variables.<T1,
T2, T3, T4, T5, T6>
Property.ForAll6<T1, T2, T3, T4, T5, T6> forAll
(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6) Returns a logical for all quantor of 6 given variables.<T1,
T2, T3, T4, T5, T6, T7>
Property.ForAll7<T1, T2, T3, T4, T5, T6, T7> forAll
(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7) Returns a logical for all quantor of 7 given variables.<T1,
T2, T3, T4, T5, T6, T7, T8>
Property.ForAll8<T1, T2, T3, T4, T5, T6, T7, T8> forAll
(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7, Arbitrary<T8> a8) Returns a logical for all quantor of 8 given variables.private static Property.CheckError
Creates a CheckError caused by an exception when generating a value.private static void
private static void
logErroneous
(String name, int currentTry, long millis, String errorMessage) private static void
logFalsified
(String name, int currentTry, long millis) private static void
logSatisfied
(String name, int tries, long millis, boolean exhausted) private static Property.CheckError
predicateError
(Throwable cause) Creates a CheckError caused by an exception when testing a Predicate.
-
Field Details
-
name
-
-
Constructor Details
-
Property
-
-
Method Details
-
def
Defines a new Property.- Parameters:
name
- property name- Returns:
- a new
Property
- Throws:
NullPointerException
- if name is null.IllegalArgumentException
- if name is empty or consists of whitespace only
-
logSatisfied
-
logFalsified
-
logErroneous
-
log
-
arbitraryError
Creates a CheckError caused by an exception when obtaining a generator.- Parameters:
position
- The position of the argument within the argument list of the property, starting with 1.size
- The size hint passed to the Arbitrary which caused the error.cause
- The error which occurred when the Arbitrary tried to obtain the generator Gen.- Returns:
- a new CheckError instance.
-
genError
Creates a CheckError caused by an exception when generating a value.- Parameters:
position
- The position of the argument within the argument list of the property, starting with 1.size
- The size hint of the arbitrary which called the generator Gen which caused the error.cause
- The error which occurred when the Gen tried to generate a random value.- Returns:
- a new CheckError instance.
-
predicateError
Creates a CheckError caused by an exception when testing a Predicate.- Parameters:
cause
- The error which occurred when applying the Predicate.- Returns:
- a new CheckError instance.
-
forAll
Returns a logical for all quantor of 1 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantor- Returns:
- a new
ForAll1
instance of 1 variables
-
forAll
Returns a logical for all quantor of 2 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantor- Returns:
- a new
ForAll2
instance of 2 variables
-
forAll
public <T1,T2, Property.ForAll3<T1,T3> T2, forAllT3> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3) Returns a logical for all quantor of 3 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantor- Returns:
- a new
ForAll3
instance of 3 variables
-
forAll
public <T1,T2, Property.ForAll4<T1,T3, T4> T2, forAllT3, T4> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4) Returns a logical for all quantor of 4 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantorT4
- 4th variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantora4
- 4th variable of this for all quantor- Returns:
- a new
ForAll4
instance of 4 variables
-
forAll
public <T1,T2, Property.ForAll5<T1,T3, T4, T5> T2, forAllT3, T4, T5> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5) Returns a logical for all quantor of 5 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantorT4
- 4th variable type of this for all quantorT5
- 5th variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantora4
- 4th variable of this for all quantora5
- 5th variable of this for all quantor- Returns:
- a new
ForAll5
instance of 5 variables
-
forAll
public <T1,T2, Property.ForAll6<T1,T3, T4, T5, T6> T2, forAllT3, T4, T5, T6> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6) Returns a logical for all quantor of 6 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantorT4
- 4th variable type of this for all quantorT5
- 5th variable type of this for all quantorT6
- 6th variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantora4
- 4th variable of this for all quantora5
- 5th variable of this for all quantora6
- 6th variable of this for all quantor- Returns:
- a new
ForAll6
instance of 6 variables
-
forAll
public <T1,T2, Property.ForAll7<T1,T3, T4, T5, T6, T7> T2, forAllT3, T4, T5, T6, T7> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7) Returns a logical for all quantor of 7 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantorT4
- 4th variable type of this for all quantorT5
- 5th variable type of this for all quantorT6
- 6th variable type of this for all quantorT7
- 7th variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantora4
- 4th variable of this for all quantora5
- 5th variable of this for all quantora6
- 6th variable of this for all quantora7
- 7th variable of this for all quantor- Returns:
- a new
ForAll7
instance of 7 variables
-
forAll
public <T1,T2, Property.ForAll8<T1,T3, T4, T5, T6, T7, T8> T2, forAllT3, T4, T5, T6, T7, T8> (Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7, Arbitrary<T8> a8) Returns a logical for all quantor of 8 given variables.- Type Parameters:
T1
- 1st variable type of this for all quantorT2
- 2nd variable type of this for all quantorT3
- 3rd variable type of this for all quantorT4
- 4th variable type of this for all quantorT5
- 5th variable type of this for all quantorT6
- 6th variable type of this for all quantorT7
- 7th variable type of this for all quantorT8
- 8th variable type of this for all quantor- Parameters:
a1
- 1st variable of this for all quantora2
- 2nd variable of this for all quantora3
- 3rd variable of this for all quantora4
- 4th variable of this for all quantora5
- 5th variable of this for all quantora6
- 6th variable of this for all quantora7
- 7th variable of this for all quantora8
- 8th variable of this for all quantor- Returns:
- a new
ForAll8
instance of 8 variables
-