Package net.jqwik.api

Klasse ShrinkingDistance

java.lang.Object

net.jqwik.api.ShrinkingDistance

Alle implementierten Schnittstellen:

Comparable<ShrinkingDistance>

@API(status=STABLE,
     since="1.0")
public class ShrinkingDistance
extends Object
implements Comparable<ShrinkingDistance>

A ShrinkingDistance is a measure of how close a value is to the minimum value, aka target value.

The distance is used during shrinking to determine if a shrunk value is really closer to the target value. If it is not, the value is being discarded.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final ShrinkingDistance	MAX
static final ShrinkingDistance	MIN

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
ShrinkingDistance	append(ShrinkingDistance other)
static <T extends @Nullable Object> ShrinkingDistance	combine(List<? extends Shrinkable<T>> shrinkables)
int	compareTo(ShrinkingDistance other)	Compare to distances with each other.
List<ShrinkingDistance>	dimensions()
boolean	equals(@Nullable Object o)
static <T extends @Nullable Object> ShrinkingDistance	forCollection(Collection<? extends Shrinkable<T>> elements)
int	hashCode()
static ShrinkingDistance	of(long... distances)	Create a ShrinkingDistance with one or more dimensions.
ShrinkingDistance	plus(ShrinkingDistance other)
int	size()
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Felddetails

MAX

@API(status=MAINTAINED,
     since="1.2.0")
public static final ShrinkingDistance MAX

MIN

@API(status=MAINTAINED,
     since="1.7.2")
public static final ShrinkingDistance MIN

Methodendetails

of

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

Create a ShrinkingDistance with one or more dimensions.

Parameter:

distances - a non-empty array of non-negative values.

Gibt zurück:

an immutable instance of ShrinkingDistance

forCollection

@API(status=MAINTAINED,
     since="1.0")
public static <T extends @Nullable Object>
ShrinkingDistance forCollection(Collection<? extends Shrinkable<T>> elements)

combine

@API(status=MAINTAINED,
     since="1.0")
public static <T extends @Nullable Object>
ShrinkingDistance combine(List<? extends Shrinkable<T>> shrinkables)

equals

public boolean equals(@Nullable Object o)

Setzt außer Kraft:

equals in Klasse Object

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse Object

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object

compareTo

public int compareTo(ShrinkingDistance other)

Compare to distances with each other. No distance can be greater than MAX. No distance can be smaller than MIN.

Angegeben von:

compareTo in Schnittstelle Comparable<ShrinkingDistance>

dimensions

@API(status=INTERNAL)
public List<ShrinkingDistance> dimensions()

size

@API(status=INTERNAL)
public int size()

plus

@API(status=INTERNAL)
public ShrinkingDistance plus(ShrinkingDistance other)

append

@API(status=INTERNAL)
public ShrinkingDistance append(ShrinkingDistance other)