All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.jqwik.api.lifecycle.FalsifiedSample Maven / Gradle / Ivy

Go to download

Jqwik API module

The newest version!
package net.jqwik.api.lifecycle;

import java.util.*;

import org.apiguardian.api.*;

import net.jqwik.api.*;

import static org.apiguardian.api.API.Status.*;

/**
 * A falsified sample is the collection of data that could be falsified during
 * a property run.
 *
 * @see ShrunkFalsifiedSample
 * @see PropertyExecutionResult#shrunkSample()
 */
@API(status = MAINTAINED, since = "1.3.5")
public interface FalsifiedSample {

	/**
	 * The actual parameters used when running a property method.
	 *
	 * 

	 * If parameters are muted during the run,
	 * e.g. elements have been added to a mutable collection,
	 * this method returns the muted objects.
	 * 

	 *
	 * @return list of objects of same size as list returned by {@linkplain #shrinkables()}.
	 */
	List parameters();

	/**
	 * The list of shrinkables that were used to generate the parameters.
	 * The position of shrinkables corresponds to the actual parameter object in {@linkplain #parameters()}.
	 *
	 * 

	 * You can create a fresh, unchanged list of parameter objects through
	 * {@code sample.shrinkables().stream(Shrinkable::value).collect(Collectors.toList())}.
	 * 

	 *
	 * @return list of shrinkables of same size as list returned by {@linkplain #parameters()}.
	 */
	List> shrinkables();

	/**
	 * The error which resulted in falsifying a property.
	 * If the property was falsified by return false this method returns {@code Optional.empty()}.
	 *
	 * @return an optional error
	 */
	Optional falsifyingError();

	/**
	 * List of footnotes to be added to failure report.
	 *
	 * @return list of strings
	 */
	@API(status = MAINTAINED, since = "1.5.5")
	List footnotes();

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy