Modifier and Type	Class and Description
public static class	CheckResult.Erroneous Represents an erroneous property check.
public static class	CheckResult.Falsified Represents a falsified property check.
public static class	CheckResult.Satisfied Represents a satisfied property check.

Modifier and Type	Method and Description
public default void	assertIsErroneous() Asserts that this CheckResult is erroneous.
public default void	assertIsFalsified() Asserts that this CheckResult is falsified.
public default void	assertIsSatisfied() Asserts that this CheckResult is satisfied.
public default void	assertIsSatisfiedWithExhaustion(boolean The exhausted state to be checked in the case of a satisfied CheckResult. exhausted) Asserts that this CheckResult is satisfied with a given exhausted state.
public int	Returns: the number of checks performed count() The number of checks performed using random generated input data.
public Option<Error>	Returns: an optional error error() An optional error.
public boolean	Returns: true, if this check result is erroneous, false otherwise isErroneous() If this check result is erroneous as specified above.
public boolean	Returns: true, if this check result is exhausted, false otherwise isExhausted() If this check result is exhausted as specified above.
public boolean	Returns: true, if this check result is falsified, false otherwise isFalsified() If this check result is falsified as specified above.
public boolean	Returns: true, if this check result is satisfied, false otherwise isSatisfied() If this check result is satisfied as specified above.
public String	Returns: a property name propertyName() The name of the checked property this result refers to.
public Option<Tuple>	Returns: an optional sample sample() An optional sample which falsified the property or which lead to an error.

Method Detail

assertIsErroneous	back to summary
public default void assertIsErroneous() Asserts that this CheckResult is erroneous. Exceptions AssertionError: if this CheckResult is not erroneous.

assertIsErroneous

back to summary

public default void assertIsErroneous()

Asserts that this CheckResult is erroneous.

Exceptions

AssertionError:: if this CheckResult is not erroneous.

assertIsFalsified	back to summary
public default void assertIsFalsified() Asserts that this CheckResult is falsified. Exceptions AssertionError: if this CheckResult is not falsified.

assertIsFalsified

back to summary

public default void assertIsFalsified()

Asserts that this CheckResult is falsified.

Exceptions

AssertionError:: if this CheckResult is not falsified.

assertIsSatisfied	back to summary
public default void assertIsSatisfied() Asserts that this CheckResult is satisfied. Exceptions AssertionError: if this CheckResult is not satisfied.

assertIsSatisfied

back to summary

public default void assertIsSatisfied()

Asserts that this CheckResult is satisfied.

Exceptions

AssertionError:: if this CheckResult is not satisfied.

assertIsSatisfiedWithExhaustion	back to summary
public default void assertIsSatisfiedWithExhaustion(boolean exhausted) Asserts that this CheckResult is satisfied with a given exhausted state. Parameters exhausted:boolean The exhausted state to be checked in the case of a satisfied CheckResult. Exceptions AssertionError: if this CheckResult is not satisfied or the exhausted state does not match.

assertIsSatisfiedWithExhaustion

back to summary

public default void assertIsSatisfiedWithExhaustion(boolean exhausted)

Asserts that this CheckResult is satisfied with a given exhausted state.

Parameters

exhausted:boolean: The exhausted state to be checked in the case of a satisfied CheckResult.

Exceptions

AssertionError:: if this CheckResult is not satisfied or the exhausted state does not match.

count	back to summary
public int count() The number of checks performed using random generated input data. Returns:int the number of checks performed

count

back to summary

public int count()

The number of checks performed using random generated input data.

Returns:int: the number of checks performed

error	back to summary
public Option<Error> error() An optional error. Returns:Option<Error> an optional error

error

back to summary

public Option<Error> error()

An optional error.

Returns:Option<Error>: an optional error

isErroneous	back to summary
public boolean isErroneous() If this check result is erroneous as specified above. Returns:boolean true, if this check result is erroneous, false otherwise

isErroneous

back to summary

public boolean isErroneous()

If this check result is erroneous as specified above.

Returns:boolean: true, if this check result is erroneous, false otherwise

isExhausted	back to summary
public boolean isExhausted() If this check result is exhausted as specified above. Returns:boolean true, if this check result is exhausted, false otherwise

isExhausted

back to summary

public boolean isExhausted()

If this check result is exhausted as specified above.

Returns:boolean: true, if this check result is exhausted, false otherwise

isFalsified	back to summary
public boolean isFalsified() If this check result is falsified as specified above. Returns:boolean true, if this check result is falsified, false otherwise

isFalsified

back to summary

public boolean isFalsified()

If this check result is falsified as specified above.

Returns:boolean: true, if this check result is falsified, false otherwise

isSatisfied	back to summary
public boolean isSatisfied() If this check result is satisfied as specified above. Returns:boolean true, if this check result is satisfied, false otherwise

isSatisfied

back to summary

public boolean isSatisfied()

If this check result is satisfied as specified above.

Returns:boolean: true, if this check result is satisfied, false otherwise

propertyName	back to summary
public String propertyName() The name of the checked property this result refers to. Returns:String a property name

propertyName

back to summary

public String propertyName()

The name of the checked property this result refers to.

Returns:String: a property name

sample	back to summary
public Option<Tuple> sample() An optional sample which falsified the property or which lead to an error. Returns:Option<Tuple> an optional sample

sample

back to summary

public Option<Tuple> sample()

An optional sample which falsified the property or which lead to an error.

Returns:Option<Tuple>: an optional sample

io.vavr.test back to summary

public Class CheckResult.Erroneous

Class Inheritance

extends Object
implements CheckResult, Serializable

java.lang.Object
io.vavr.test.CheckResult.Erroneous

All Implemented Interfaces

java.io.Serializable, io.vavr.test.CheckResult

Represents an erroneous property check.

Field Summary

Modifier and Type	Field and Description
private final int	count
private final Error	error
private final String	propertyName
private final Option<Tuple>	sample
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	Erroneous(String propertyName, int count, Error error, Option<Tuple> sample)

Method Summary

Modifier and Type	Method and Description
public int	count() Implements io.vavr.test.CheckResult.count. The number of checks performed using random generated input data.
pack-priv boolean	deepEquals(Throwable t1, Throwable t2)
pack-priv int	deepHashCode(Throwable t)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Option<Error>	error() Implements io.vavr.test.CheckResult.error. An optional error.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isErroneous() Implements io.vavr.test.CheckResult.isErroneous. If this check result is erroneous as specified above.
public boolean	isExhausted() Implements io.vavr.test.CheckResult.isExhausted. If this check result is exhausted as specified above.
public boolean	isFalsified() Implements io.vavr.test.CheckResult.isFalsified. If this check result is falsified as specified above.
public boolean	isSatisfied() Implements io.vavr.test.CheckResult.isSatisfied. If this check result is satisfied as specified above.
public String	propertyName() Implements io.vavr.test.CheckResult.propertyName. The name of the checked property this result refers to.
public Option<Tuple>	sample() Implements io.vavr.test.CheckResult.sample. An optional sample which falsified the property or which lead to an error.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

count	back to summary
private final int count

error	back to summary
private final Error error

propertyName	back to summary
private final String propertyName

sample	back to summary
private final Option<Tuple> sample

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Erroneous	back to summary
pack-priv Erroneous(String propertyName, int count, Error error, Option<Tuple> sample)

Method Detail

count	back to summary
public int count() Implements io.vavr.test.CheckResult.count. Doc from io.vavr.test.CheckResult.count. The number of checks performed using random generated input data. Returns:int the number of checks performed Annotations @Override

count

back to summary

public int count()

Implements io.vavr.test.CheckResult.count.

Doc from io.vavr.test.CheckResult.count.

The number of checks performed using random generated input data.

Returns:int

the number of checks performed

Annotations

@Override

deepEquals	back to summary
pack-priv boolean deepEquals(Throwable t1, Throwable t2)

deepHashCode	back to summary
pack-priv int deepHashCode(Throwable t)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

error	back to summary
public Option<Error> error() Implements io.vavr.test.CheckResult.error. Doc from io.vavr.test.CheckResult.error. An optional error. Returns:Option<Error> an optional error Annotations @Override

error

back to summary

public Option<Error> error()

Implements io.vavr.test.CheckResult.error.

Doc from io.vavr.test.CheckResult.error.

An optional error.

Returns:Option<Error>

an optional error

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isErroneous	back to summary
public boolean isErroneous() Implements io.vavr.test.CheckResult.isErroneous. Doc from io.vavr.test.CheckResult.isErroneous. If this check result is erroneous as specified above. Returns:boolean true, if this check result is erroneous, false otherwise Annotations @Override

isErroneous

back to summary

public boolean isErroneous()

Implements io.vavr.test.CheckResult.isErroneous.

Doc from io.vavr.test.CheckResult.isErroneous.

If this check result is erroneous as specified above.

Returns:boolean

true, if this check result is erroneous, false otherwise

Annotations

@Override

isExhausted	back to summary
public boolean isExhausted() Implements io.vavr.test.CheckResult.isExhausted. Doc from io.vavr.test.CheckResult.isExhausted. If this check result is exhausted as specified above. Returns:boolean true, if this check result is exhausted, false otherwise Annotations @Override

isExhausted

back to summary

public boolean isExhausted()

Implements io.vavr.test.CheckResult.isExhausted.

Doc from io.vavr.test.CheckResult.isExhausted.

If this check result is exhausted as specified above.

Returns:boolean

true, if this check result is exhausted, false otherwise

Annotations

@Override

isFalsified	back to summary
public boolean isFalsified() Implements io.vavr.test.CheckResult.isFalsified. Doc from io.vavr.test.CheckResult.isFalsified. If this check result is falsified as specified above. Returns:boolean true, if this check result is falsified, false otherwise Annotations @Override

isFalsified

back to summary

public boolean isFalsified()

Implements io.vavr.test.CheckResult.isFalsified.

Doc from io.vavr.test.CheckResult.isFalsified.

If this check result is falsified as specified above.

Returns:boolean

true, if this check result is falsified, false otherwise

Annotations

@Override

isSatisfied	back to summary
public boolean isSatisfied() Implements io.vavr.test.CheckResult.isSatisfied. Doc from io.vavr.test.CheckResult.isSatisfied. If this check result is satisfied as specified above. Returns:boolean true, if this check result is satisfied, false otherwise Annotations @Override

isSatisfied

back to summary

public boolean isSatisfied()

Implements io.vavr.test.CheckResult.isSatisfied.

Doc from io.vavr.test.CheckResult.isSatisfied.

If this check result is satisfied as specified above.

Returns:boolean

true, if this check result is satisfied, false otherwise

Annotations

@Override

propertyName	back to summary
public String propertyName() Implements io.vavr.test.CheckResult.propertyName. Doc from io.vavr.test.CheckResult.propertyName. The name of the checked property this result refers to. Returns:String a property name Annotations @Override

propertyName

back to summary

public String propertyName()

Implements io.vavr.test.CheckResult.propertyName.

Doc from io.vavr.test.CheckResult.propertyName.

The name of the checked property this result refers to.

Returns:String

a property name

Annotations

@Override

sample	back to summary
public Option<Tuple> sample() Implements io.vavr.test.CheckResult.sample. Doc from io.vavr.test.CheckResult.sample. An optional sample which falsified the property or which lead to an error. Returns:Option<Tuple> an optional sample Annotations @Override

sample

back to summary

public Option<Tuple> sample()

Implements io.vavr.test.CheckResult.sample.

Doc from io.vavr.test.CheckResult.sample.

An optional sample which falsified the property or which lead to an error.

Returns:Option<Tuple>

an optional sample

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.vavr.test back to summary

public Class CheckResult.Falsified

Class Inheritance

extends Object
implements CheckResult, Serializable

java.lang.Object
io.vavr.test.CheckResult.Falsified

All Implemented Interfaces

java.io.Serializable, io.vavr.test.CheckResult

Represents a falsified property check.

Field Summary

Modifier and Type	Field and Description
private final int	count
private final String	propertyName
private final Tuple	sample
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	Falsified(String propertyName, int count, Tuple sample)

Method Summary

Modifier and Type	Method and Description
public int	count() Implements io.vavr.test.CheckResult.count. The number of checks performed using random generated input data.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Option<Error>	error() Implements io.vavr.test.CheckResult.error. An optional error.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isErroneous() Implements io.vavr.test.CheckResult.isErroneous. If this check result is erroneous as specified above.
public boolean	isExhausted() Implements io.vavr.test.CheckResult.isExhausted. If this check result is exhausted as specified above.
public boolean	isFalsified() Implements io.vavr.test.CheckResult.isFalsified. If this check result is falsified as specified above.
public boolean	isSatisfied() Implements io.vavr.test.CheckResult.isSatisfied. If this check result is satisfied as specified above.
public String	propertyName() Implements io.vavr.test.CheckResult.propertyName. The name of the checked property this result refers to.
public Option<Tuple>	sample() Implements io.vavr.test.CheckResult.sample. An optional sample which falsified the property or which lead to an error.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

count	back to summary
private final int count

propertyName	back to summary
private final String propertyName

sample	back to summary
private final Tuple sample

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Falsified	back to summary
pack-priv Falsified(String propertyName, int count, Tuple sample)

Method Detail

count	back to summary
public int count() Implements io.vavr.test.CheckResult.count. Doc from io.vavr.test.CheckResult.count. The number of checks performed using random generated input data. Returns:int the number of checks performed Annotations @Override

count

back to summary

public int count()

Implements io.vavr.test.CheckResult.count.

Doc from io.vavr.test.CheckResult.count.

The number of checks performed using random generated input data.

Returns:int

the number of checks performed

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

error	back to summary
public Option<Error> error() Implements io.vavr.test.CheckResult.error. Doc from io.vavr.test.CheckResult.error. An optional error. Returns:Option<Error> an optional error Annotations @Override

error

back to summary

public Option<Error> error()

Implements io.vavr.test.CheckResult.error.

Doc from io.vavr.test.CheckResult.error.

An optional error.

Returns:Option<Error>

an optional error

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isErroneous	back to summary
public boolean isErroneous() Implements io.vavr.test.CheckResult.isErroneous. Doc from io.vavr.test.CheckResult.isErroneous. If this check result is erroneous as specified above. Returns:boolean true, if this check result is erroneous, false otherwise Annotations @Override

isErroneous

back to summary

public boolean isErroneous()

Implements io.vavr.test.CheckResult.isErroneous.

Doc from io.vavr.test.CheckResult.isErroneous.

If this check result is erroneous as specified above.

Returns:boolean

true, if this check result is erroneous, false otherwise

Annotations

@Override

isExhausted	back to summary
public boolean isExhausted() Implements io.vavr.test.CheckResult.isExhausted. Doc from io.vavr.test.CheckResult.isExhausted. If this check result is exhausted as specified above. Returns:boolean true, if this check result is exhausted, false otherwise Annotations @Override

isExhausted

back to summary

public boolean isExhausted()

Implements io.vavr.test.CheckResult.isExhausted.

Doc from io.vavr.test.CheckResult.isExhausted.

If this check result is exhausted as specified above.

Returns:boolean

true, if this check result is exhausted, false otherwise

Annotations

@Override

isFalsified

back to summary

public boolean isFalsified()

Implements io.vavr.test.CheckResult.isFalsified.

Doc from io.vavr.test.CheckResult.isFalsified.

If this check result is falsified as specified above.

Returns:boolean

true, if this check result is falsified, false otherwise

Annotations

@Override

isSatisfied

back to summary

public boolean isSatisfied()

Implements io.vavr.test.CheckResult.isSatisfied.

Doc from io.vavr.test.CheckResult.isSatisfied.

If this check result is satisfied as specified above.

Returns:boolean

true, if this check result is satisfied, false otherwise

Annotations

@Override

propertyName

back to summary

public String propertyName()

Implements io.vavr.test.CheckResult.propertyName.

Doc from io.vavr.test.CheckResult.propertyName.

The name of the checked property this result refers to.

Returns:String

a property name

Annotations

@Override

sample

back to summary

public Option<Tuple> sample()

Implements io.vavr.test.CheckResult.sample.

Doc from io.vavr.test.CheckResult.sample.

An optional sample which falsified the property or which lead to an error.

Returns:Option<Tuple>

an optional sample

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.vavr.test back to summary

public Class CheckResult.Satisfied

Class Inheritance

extends Object
implements CheckResult, Serializable

java.lang.Object
io.vavr.test.CheckResult.Satisfied

All Implemented Interfaces

java.io.Serializable, io.vavr.test.CheckResult

Represents a satisfied property check.

Field Summary

Modifier and Type	Field and Description
private final int	count
private final boolean	exhausted
private final String	propertyName
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	Satisfied(String propertyName, int count, boolean exhausted)

Method Summary

Modifier and Type	Method and Description
public int	count() Implements io.vavr.test.CheckResult.count. The number of checks performed using random generated input data.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Option<Error>	error() Implements io.vavr.test.CheckResult.error. An optional error.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isErroneous() Implements io.vavr.test.CheckResult.isErroneous. If this check result is erroneous as specified above.
public boolean	isExhausted() Implements io.vavr.test.CheckResult.isExhausted. If this check result is exhausted as specified above.
public boolean	isFalsified() Implements io.vavr.test.CheckResult.isFalsified. If this check result is falsified as specified above.
public boolean	isSatisfied() Implements io.vavr.test.CheckResult.isSatisfied. If this check result is satisfied as specified above.
public String	propertyName() Implements io.vavr.test.CheckResult.propertyName. The name of the checked property this result refers to.
public Option<Tuple>	sample() Implements io.vavr.test.CheckResult.sample. An optional sample which falsified the property or which lead to an error.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

count	back to summary
private final int count

exhausted	back to summary
private final boolean exhausted

propertyName	back to summary
private final String propertyName

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Satisfied	back to summary
pack-priv Satisfied(String propertyName, int count, boolean exhausted)

Method Detail

count

back to summary

public int count()

Implements io.vavr.test.CheckResult.count.

Doc from io.vavr.test.CheckResult.count.

The number of checks performed using random generated input data.

Returns:int

the number of checks performed

Annotations

@Override

equals back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

error

back to summary

public Option<Error> error()

Implements io.vavr.test.CheckResult.error.

Doc from io.vavr.test.CheckResult.error.

An optional error.

Returns:Option<Error>

an optional error

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations