Package org.assertj.core.api

Interface WithAssumptions

public interface WithAssumptions

A unified entry point to all assumptions from both the new Java 8 core API and the pre-Java 8 core API. As a convenience, the methods are defined in an interface so that no static imports are necessary if the test class implements this interface.

Method Summary

Modifier and Type	Method	Description
default AbstractBooleanAssert<?>	assumeThat(boolean actual)	Creates a new instance of BooleanAssert assumption.
default AbstractBooleanArrayAssert<?>	assumeThat(boolean[] actual)	Creates a new instance of BooleanArrayAssert assumption.
default Boolean2DArrayAssert	assumeThat(boolean[][] actual)	Creates a new instance of Boolean2DArrayAssert assumption.
default AbstractByteAssert<?>	assumeThat(byte actual)	Creates a new instance of ByteAssert assumption.
default AbstractByteArrayAssert<?>	assumeThat(byte[] actual)	Creates a new instance of ByteArrayAssert assumption.
default Byte2DArrayAssert	assumeThat(byte[][] actual)	Creates a new instance of Byte2DArrayAssert assumption.
default AbstractCharacterAssert<?>	assumeThat(char actual)	Creates a new instance of CharacterAssert assumption.
default AbstractCharArrayAssert<?>	assumeThat(char[] actual)	Creates a new instance of CharArrayAssert assumption.
default Char2DArrayAssert	assumeThat(char[][] actual)	Creates a new instance of Char2DArrayAssert assumption.
default AbstractDoubleAssert<?>	assumeThat(double actual)	Creates a new instance of DoubleAssert assumption.
default AbstractDoubleArrayAssert<?>	assumeThat(double[] actual)	Creates a new instance of DoubleArrayAssert assumption.
default Double2DArrayAssert	assumeThat(double[][] actual)	Creates a new instance of Double2DArrayAssert assumption.
default AbstractFloatAssert<?>	assumeThat(float actual)	Creates a new instance of FloatAssert assumption.
default AbstractFloatArrayAssert<?>	assumeThat(float[] actual)	Creates a new instance of FloatArrayAssert assumption.
default Float2DArrayAssert	assumeThat(float[][] actual)	Creates a new instance of Float2DArrayAssert assumption.
default AbstractIntegerAssert<?>	assumeThat(int actual)	Creates a new instance of IntegerAssert assumption.
default AbstractIntArrayAssert<?>	assumeThat(int[] actual)	Creates a new instance of IntArrayAssert assumption.
default Int2DArrayAssert	assumeThat(int[][] actual)	Creates a new instance of Int2DArrayAssert assumption.
default AbstractLongAssert<?>	assumeThat(long actual)	Creates a new instance of LongAssert assumption.
default AbstractLongArrayAssert<?>	assumeThat(long[] actual)	Creates a new instance of LongArrayAssert assumption.
default Long2DArrayAssert	assumeThat(long[][] actual)	Creates a new instance of Long2DArrayAssert assumption.
default AbstractShortAssert<?>	assumeThat(short actual)	Creates a new instance of ShortAssert assumption.
default AbstractShortArrayAssert<?>	assumeThat(short[] actual)	Creates a new instance of ShortArrayAssert assumption.
default Short2DArrayAssert	assumeThat(short[][] actual)	Creates a new instance of Short2DArrayAssert assumption.
default AbstractFileAssert<?>	assumeThat(File actual)	Creates a new instance of FileAssert assumption.
default AbstractInputStreamAssert<?,? extends InputStream>	assumeThat(InputStream actual)	Creates a new instance of InputStreamAssert assumption.
default AbstractBooleanAssert<?>	assumeThat(Boolean actual)	Creates a new instance of BooleanAssert assumption.
default AbstractByteAssert<?>	assumeThat(Byte actual)	Creates a new instance of ByteAssert assumption.
default AbstractCharacterAssert<?>	assumeThat(Character actual)	Creates a new instance of CharacterAssert assumption.
default AbstractCharSequenceAssert<?,? extends CharSequence>	assumeThat(CharSequence actual)	Creates a new instance of CharSequenceAssert assumption.
default AbstractClassAssert<?>	assumeThat(Class<?> actual)	Creates a new instance of ClassAssert assumption.
default AbstractDoubleAssert<?>	assumeThat(Double actual)	Creates a new instance of DoubleAssert assumption.
default AbstractFloatAssert<?>	assumeThat(Float actual)	Creates a new instance of FloatAssert assumption.
default AbstractIntegerAssert<?>	assumeThat(Integer actual)	Creates a new instance of IntegerAssert assumption.
default <ELEMENT> ProxyableIterableAssert<ELEMENT>	assumeThat(Iterable<? extends ELEMENT> actual)	Creates a new instance of IterableAssert assumption.
default AbstractLongAssert<?>	assumeThat(Long actual)	Creates a new instance of LongAssert assumption.
default AbstractShortAssert<?>	assumeThat(Short actual)	Creates a new instance of ShortAssert assumption.
default AbstractStringAssert<?>	assumeThat(String actual)	Creates a new instance of StringAssert assumption.
default AbstractCharSequenceAssert<?,? extends CharSequence>	assumeThat(StringBuffer actual)	Creates a new instance of CharSequenceAssert assumption from a StringBuffer.
default AbstractCharSequenceAssert<?,? extends CharSequence>	assumeThat(StringBuilder actual)	Creates a new instance of CharSequenceAssert assumption from a StringBuilder.
default AbstractThrowableAssert<?,? extends Throwable>	assumeThat(Throwable actual)	Creates a new instance of ThrowableAssert assumption.
default AbstractBigDecimalAssert<?>	assumeThat(BigDecimal actual)	Creates a new instance of BigDecimalAssert assumption.
default AbstractBigIntegerAssert<?>	assumeThat(BigInteger actual)	Creates a new instance of BigIntegerAssert assumption.
default AbstractUriAssert<?>	assumeThat(URI uri)	Creates a new instance of UriAssert assumption.
default AbstractUrlAssert<?>	assumeThat(URL url)	Creates a new instance of UrlAssert assumption.
default AbstractPathAssert<?>	assumeThat(Path actual)	Creates a new instance of PathAssert assumption.
default AbstractDurationAssert<?>	assumeThat(Duration duration)	Creates a new instance of DurationAssert assumption.
default AbstractInstantAssert<?>	assumeThat(Instant instant)	Creates a new instance of InstantAssert assumption.
default AbstractLocalDateAssert<?>	assumeThat(LocalDate localDate)	Creates a new instance of LocalDateAssert assumption.
default AbstractLocalDateTimeAssert<?>	assumeThat(LocalDateTime localDateTime)	Creates a new instance of LocalDateTimeAssert assumption.
default AbstractLocalTimeAssert<?>	assumeThat(LocalTime localTime)	Creates a new instance of LocalTimeAssert assumption.
default AbstractOffsetDateTimeAssert<?>	assumeThat(OffsetDateTime offsetDateTime)	Creates a new instance of OffsetDateTimeAssert assumption.
default AbstractOffsetTimeAssert<?>	assumeThat(OffsetTime offsetTime)	Creates a new instance of OffsetTimeAssert assumption.
default AbstractPeriodAssert<?>	assumeThat(Period period)	Creates a new instance of PeriodAssert assumption.
default AbstractZonedDateTimeAssert<?>	assumeThat(ZonedDateTime zonedDateTime)	Creates a new instance of ZonedDateTimeAssert assumption.
default AtomicBooleanAssert	assumeThat(AtomicBoolean actual)	Creates a new instance of AtomicBooleanAssert assumption.
default AtomicIntegerAssert	assumeThat(AtomicInteger actual)	Creates a new instance of AtomicIntegerAssert assumption.
default AtomicIntegerArrayAssert	assumeThat(AtomicIntegerArray actual)	Creates int[] assumption for AtomicIntegerArray.
default <OBJECT> AtomicIntegerFieldUpdaterAssert<OBJECT>	assumeThat(AtomicIntegerFieldUpdater<OBJECT> actual)	Creates a new instance of AtomicIntegerFieldUpdaterAssert assumption.
default AtomicLongAssert	assumeThat(AtomicLong actual)	Creates a new instance of AtomicLongAssert assumption.
default AtomicLongArrayAssert	assumeThat(AtomicLongArray actual)	Creates a new instance of AtomicLongArrayAssert assumption.
default <OBJECT> AtomicLongFieldUpdaterAssert<OBJECT>	assumeThat(AtomicLongFieldUpdater<OBJECT> actual)	Creates a new instance of AtomicLongFieldUpdaterAssert assumption.
default <VALUE> AtomicMarkableReferenceAssert<VALUE>	assumeThat(AtomicMarkableReference<VALUE> actual)	Creates a new instance of AtomicMarkableReferenceAssert assumption.
default <VALUE> AtomicReferenceAssert<VALUE>	assumeThat(AtomicReference<VALUE> actual)	Creates a new instance of AtomicReferenceAssert assumption.
default <ELEMENT> AtomicReferenceArrayAssert<ELEMENT>	assumeThat(AtomicReferenceArray<ELEMENT> actual)	Creates a new instance of AtomicReferenceArrayAssert assumption.
default <FIELD, OBJECT> AtomicReferenceFieldUpdaterAssert<FIELD,OBJECT>	assumeThat(AtomicReferenceFieldUpdater<OBJECT,FIELD> actual)	Creates a new instance of AtomicReferenceFieldUpdaterAssert assumption.
default <VALUE> AtomicStampedReferenceAssert<VALUE>	assumeThat(AtomicStampedReference<VALUE> actual)	Creates a new instance of AtomicStampedReferenceAssert assumption.
default LongAdderAssert	assumeThat(LongAdder actual)	Creates a new instance of LongAdderAssert assumption.
default <RESULT> CompletableFutureAssert<RESULT>	assumeThat(CompletableFuture<RESULT> future)	Creates a new instance of CompletableFutureAssert assumption.
default <RESULT> CompletableFutureAssert<RESULT>	assumeThat(CompletionStage<RESULT> actual)	Creates a new instance of CompletableFutureAssert assumption for a CompletionStage by converting it to a CompletableFuture and returning a CompletableFutureAssert.
default <RESULT> AbstractFutureAssert<?,? extends Future<? extends RESULT>,RESULT>	assumeThat(Future<RESULT> actual)	Create assertion for FutureAssert assumption.
default AbstractDateAssert<?>	assumeThat(Date actual)	Creates a new instance of DateAssert assumption.
default DoublePredicateAssert	assumeThat(DoublePredicate doublePredicate)	Creates a new instance of DoublePredicateAssert assumption.
default IntPredicateAssert	assumeThat(IntPredicate intPredicate)	Creates a new instance of IntPredicateAssert assumption.
default LongPredicateAssert	assumeThat(LongPredicate longPredicate)	Creates a new instance of LongPredicateAssert assumption.
default <T> ProxyablePredicateAssert<T>	assumeThat(Predicate<T> predicate)	Creates a new instance of PredicateAssert assumption.
default <ELEMENT> IteratorAssert<ELEMENT>	assumeThat(Iterator<? extends ELEMENT> actual)	Creates a new instance of IteratorAssert assumption.
default <ELEMENT> FactoryBasedNavigableListAssert<ProxyableListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>	assumeThat(List<? extends ELEMENT> list)	Creates a new instance of ListAssert assumption.
default <K, V> AbstractMapAssert<?,?,K,V>	assumeThat(Map<K,V> actual)	Creates a new instance of MapAssert assumption.
default <VALUE> OptionalAssert<VALUE>	assumeThat(Optional<VALUE> optional)	Creates a new instance of OptionalAssert assumption.
default OptionalDoubleAssert	assumeThat(OptionalDouble optionalDouble)	Creates a new instance of OptionalDoubleAssert assumption.
default OptionalIntAssert	assumeThat(OptionalInt optionalInt)	Creates a new instance of OptionalIntAssert assumption.
default OptionalLongAssert	assumeThat(OptionalLong optionalLong)	Creates a new instance of OptionalLongAssert assumption.
default <ELEMENT> AbstractSpliteratorAssert<?,ELEMENT>	assumeThat(Spliterator<ELEMENT> spliterator)	Creates a new instance of SpliteratorAssert assumption.
default AbstractListAssert<?,List<? extends Double>,Double,ObjectAssert<Double>>	assumeThat(DoubleStream doubleStream)	Creates a new instance of ListAssert assumption from the given DoubleStream.
default AbstractListAssert<?,List<? extends Integer>,Integer,ObjectAssert<Integer>>	assumeThat(IntStream intStream)	Creates a new instance of ListAssert assumption from the given IntStream.
default AbstractListAssert<?,List<? extends Long>,Long,ObjectAssert<Long>>	assumeThat(LongStream longStream)	Creates a new instance of ListAssert assumption from the given LongStream.
default <ELEMENT> AbstractListAssert<?,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>	assumeThat(Stream<? extends ELEMENT> stream)	Creates a new instance of ListAssert assumption from the given Stream.
default <T> ProxyableObjectAssert<T>	assumeThat(T actual)	Creates a new instance of ObjectAssert assumption.
default <T> ProxyableObjectArrayAssert<T>	assumeThat(T[] actual)	Creates a new instance of ObjectArrayAssert assumption.
default <T> Object2DArrayAssert<T>	assumeThat(T[][] actual)	Creates a new instance of Object2DArrayAssert assumption.
default AbstractThrowableAssert<?,? extends Throwable>	assumeThatCode(ThrowableAssert.ThrowingCallable shouldRaiseOrNotThrowable)	Allows to capture and then assume on a Throwable (easier done with lambdas).
default <T> ProxyableObjectAssert<T>	assumeThatObject(T actual)	Creates a new instance of ObjectAssert for any object.
default AbstractThrowableAssert<?,? extends Throwable>	assumeThatThrownBy(ThrowableAssert.ThrowingCallable shouldRaiseThrowable)	Allows to capture and then assume on a Throwable (easier done with lambdas).

Method Details

assumeThat

default <T> ProxyableObjectArrayAssert<T> assumeThat(T[] actual)

Creates a new instance of ObjectArrayAssert assumption.

Type Parameters:

T - the type of elements.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <T> Object2DArrayAssert<T> assumeThat(T[][] actual)

Creates a new instance of Object2DArrayAssert assumption.

Type Parameters:

T - the type of elements.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default <K,
V> AbstractMapAssert<?,?,K,V> assumeThat(Map<K,V> actual)

Creates a new instance of MapAssert assumption.

Type Parameters:

K - the type of keys in the map.

V - the type of values in the map.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractShortAssert<?> assumeThat(short actual)

Creates a new instance of ShortAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLongAssert<?> assumeThat(long actual)

Creates a new instance of LongAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLongAssert<?> assumeThat(Long actual)

Creates a new instance of LongAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLongArrayAssert<?> assumeThat(long[] actual)

Creates a new instance of LongArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Long2DArrayAssert assumeThat(long[][] actual)

Creates a new instance of Long2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default <T> ProxyableObjectAssert<T> assumeThat(T actual)

Creates a new instance of ObjectAssert assumption.

Type Parameters:

T - the type of the actual value.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractStringAssert<?> assumeThat(String actual)

Creates a new instance of StringAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractDateAssert<?> assumeThat(Date actual)

Creates a new instance of DateAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractThrowableAssert<?,? extends Throwable> assumeThat(Throwable actual)

Creates a new instance of ThrowableAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractBigDecimalAssert<?> assumeThat(BigDecimal actual)

Creates a new instance of BigDecimalAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractBigIntegerAssert<?> assumeThat(BigInteger actual)

Creates a new instance of BigIntegerAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AtomicBooleanAssert assumeThat(AtomicBoolean actual)

Creates a new instance of AtomicBooleanAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AtomicIntegerAssert assumeThat(AtomicInteger actual)

Creates a new instance of AtomicIntegerAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default AtomicIntegerArrayAssert assumeThat(AtomicIntegerArray actual)

Creates int[] assumption for AtomicIntegerArray.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <OBJECT>
AtomicIntegerFieldUpdaterAssert<OBJECT> assumeThat(AtomicIntegerFieldUpdater<OBJECT> actual)

Creates a new instance of AtomicIntegerFieldUpdaterAssert assumption.

Type Parameters:

OBJECT - the type of the object holding the updatable field.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default LongAdderAssert assumeThat(LongAdder actual)

Creates a new instance of LongAdderAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default AtomicLongAssert assumeThat(AtomicLong actual)

Creates a new instance of AtomicLongAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default AtomicLongArrayAssert assumeThat(AtomicLongArray actual)

Creates a new instance of AtomicLongArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <OBJECT>
AtomicLongFieldUpdaterAssert<OBJECT> assumeThat(AtomicLongFieldUpdater<OBJECT> actual)

Creates a new instance of AtomicLongFieldUpdaterAssert assumption.

Type Parameters:

OBJECT - the type of the object holding the updatable field.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <VALUE> AtomicReferenceAssert<VALUE> assumeThat(AtomicReference<VALUE> actual)

Creates a new instance of AtomicReferenceAssert assumption.

Type Parameters:

VALUE - the type of the value contained in the AtomicReference.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <ELEMENT>
AtomicReferenceArrayAssert<ELEMENT> assumeThat(AtomicReferenceArray<ELEMENT> actual)

Creates a new instance of AtomicReferenceArrayAssert assumption.

Type Parameters:

ELEMENT - the type of the value contained in the AtomicReferenceArray.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <FIELD,
OBJECT>
AtomicReferenceFieldUpdaterAssert<FIELD,OBJECT> assumeThat(AtomicReferenceFieldUpdater<OBJECT,FIELD> actual)

Creates a new instance of AtomicReferenceFieldUpdaterAssert assumption.

Type Parameters:

FIELD - the type of the field which gets updated by the AtomicReferenceFieldUpdater.

OBJECT - the type of the object holding the updatable field.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <VALUE>
AtomicMarkableReferenceAssert<VALUE> assumeThat(AtomicMarkableReference<VALUE> actual)

Creates a new instance of AtomicMarkableReferenceAssert assumption.

Type Parameters:

VALUE - the type of the value contained in the AtomicMarkableReference.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default <VALUE> AtomicStampedReferenceAssert<VALUE> assumeThat(AtomicStampedReference<VALUE> actual)

Creates a new instance of AtomicStampedReferenceAssert assumption.

Type Parameters:

VALUE - the type of the value contained in the AtomicStampedReference.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

assumeThat

default AbstractCharSequenceAssert<?,? extends CharSequence> assumeThat(CharSequence actual)

Creates a new instance of CharSequenceAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractCharSequenceAssert<?,? extends CharSequence> assumeThat(StringBuilder actual)

Creates a new instance of CharSequenceAssert assumption from a StringBuilder.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.11.0

assumeThat

default AbstractCharSequenceAssert<?,? extends CharSequence> assumeThat(StringBuffer actual)

Creates a new instance of CharSequenceAssert assumption from a StringBuffer.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.11.0

assumeThat

default AbstractShortArrayAssert<?> assumeThat(short[] actual)

Creates a new instance of ShortArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Short2DArrayAssert assumeThat(short[][] actual)

Creates a new instance of Short2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractShortAssert<?> assumeThat(Short actual)

Creates a new instance of ShortAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractClassAssert<?> assumeThat(Class<?> actual)

Creates a new instance of ClassAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractCharacterAssert<?> assumeThat(Character actual)

Creates a new instance of CharacterAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractCharArrayAssert<?> assumeThat(char[] actual)

Creates a new instance of CharArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Char2DArrayAssert assumeThat(char[][] actual)

Creates a new instance of Char2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractCharacterAssert<?> assumeThat(char actual)

Creates a new instance of CharacterAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <T extends Comparable<? super T>>
AbstractComparableAssert<?,T> assumeThat(T actual)

Creates a new instance of GenericComparableAssert assumption.

Type Parameters:

T - the type of actual.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <ELEMENT> ProxyableIterableAssert<ELEMENT> assumeThat(Iterable<? extends ELEMENT> actual)

Creates a new instance of IterableAssert assumption.

Type Parameters:

ELEMENT - the type of elements.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <ELEMENT> IteratorAssert<ELEMENT> assumeThat(Iterator<? extends ELEMENT> actual)

Creates a new instance of IteratorAssert assumption.

Breaking change in version 3.12.0: this method does not return anymore an ProxyableIterableAssert but an IteratorAssert.

Type Parameters:

ELEMENT - the type of elements.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractBooleanAssert<?> assumeThat(Boolean actual)

Creates a new instance of BooleanAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractBooleanArrayAssert<?> assumeThat(boolean[] actual)

Creates a new instance of BooleanArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Boolean2DArrayAssert assumeThat(boolean[][] actual)

Creates a new instance of Boolean2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractByteAssert<?> assumeThat(byte actual)

Creates a new instance of ByteAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractByteAssert<?> assumeThat(Byte actual)

Creates a new instance of ByteAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractByteArrayAssert<?> assumeThat(byte[] actual)

Creates a new instance of ByteArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Byte2DArrayAssert assumeThat(byte[][] actual)

Creates a new instance of Byte2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractBooleanAssert<?> assumeThat(boolean actual)

Creates a new instance of BooleanAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractFloatAssert<?> assumeThat(float actual)

Creates a new instance of FloatAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractInputStreamAssert<?,? extends InputStream> assumeThat(InputStream actual)

Creates a new instance of InputStreamAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractFileAssert<?> assumeThat(File actual)

Creates a new instance of FileAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <RESULT>
AbstractFutureAssert<?,? extends Future<? extends RESULT>,RESULT> assumeThat(Future<RESULT> actual)

Create assertion for FutureAssert assumption.

Type Parameters:

RESULT - the type of the value contained in the Future.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractPathAssert<?> assumeThat(Path actual)

Creates a new instance of PathAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractIntArrayAssert<?> assumeThat(int[] actual)

Creates a new instance of IntArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Int2DArrayAssert assumeThat(int[][] actual)

Creates a new instance of Int2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractFloatAssert<?> assumeThat(Float actual)

Creates a new instance of FloatAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Float2DArrayAssert assumeThat(float[][] actual)

Creates a new instance of Float2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractIntegerAssert<?> assumeThat(int actual)

Creates a new instance of IntegerAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractFloatArrayAssert<?> assumeThat(float[] actual)

Creates a new instance of FloatArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractIntegerAssert<?> assumeThat(Integer actual)

Creates a new instance of IntegerAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractDoubleAssert<?> assumeThat(double actual)

Creates a new instance of DoubleAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractDoubleAssert<?> assumeThat(Double actual)

Creates a new instance of DoubleAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <ELEMENT>
FactoryBasedNavigableListAssert<ProxyableListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>> assumeThat(List<? extends ELEMENT> list)

Creates a new instance of ListAssert assumption.

Type Parameters:

ELEMENT - the type of elements.

Parameters:

list - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <ELEMENT>
AbstractListAssert<?,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>> assumeThat(Stream<? extends ELEMENT> stream)

Creates a new instance of ListAssert assumption from the given Stream.

Type Parameters:

ELEMENT - the type of elements.

Parameters:

stream - the Stream to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default AbstractListAssert<?,List<? extends Double>,Double,ObjectAssert<Double>> assumeThat(DoubleStream doubleStream)

Creates a new instance of ListAssert assumption from the given DoubleStream.

Parameters:

doubleStream - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractListAssert<?,List<? extends Long>,Long,ObjectAssert<Long>> assumeThat(LongStream longStream)

Creates a new instance of ListAssert assumption from the given LongStream.

Parameters:

longStream - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractListAssert<?,List<? extends Integer>,Integer,ObjectAssert<Integer>> assumeThat(IntStream intStream)

Creates a new instance of ListAssert assumption from the given IntStream.

Parameters:

intStream - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractDoubleArrayAssert<?> assumeThat(double[] actual)

Creates a new instance of DoubleArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default Double2DArrayAssert assumeThat(double[][] actual)

Creates a new instance of Double2DArrayAssert assumption.

Parameters:

actual - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractZonedDateTimeAssert<?> assumeThat(ZonedDateTime zonedDateTime)

Creates a new instance of ZonedDateTimeAssert assumption.

Parameters:

zonedDateTime - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default <RESULT> CompletableFutureAssert<RESULT> assumeThat(CompletableFuture<RESULT> future)

Creates a new instance of CompletableFutureAssert assumption.

Type Parameters:

RESULT - the CompletableFuture wrapped type.

Parameters:

future - the CompletableFuture to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default <RESULT> CompletableFutureAssert<RESULT> assumeThat(CompletionStage<RESULT> actual)

Creates a new instance of CompletableFutureAssert assumption for a CompletionStage by converting it to a CompletableFuture and returning a CompletableFutureAssert.

If the given CompletionStage is null, the CompletableFuture in the returned CompletableFutureAssert will also be null.

Type Parameters:

RESULT - the CompletableFuture wrapped type.

Parameters:

actual - the CompletableFuture to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default <VALUE> OptionalAssert<VALUE> assumeThat(Optional<VALUE> optional)

Creates a new instance of OptionalAssert assumption.

Type Parameters:

VALUE - the Optional wrapped type.

Parameters:

optional - the Optional to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default OptionalDoubleAssert assumeThat(OptionalDouble optionalDouble)

Creates a new instance of OptionalDoubleAssert assumption.

Parameters:

optionalDouble - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default OptionalIntAssert assumeThat(OptionalInt optionalInt)

Creates a new instance of OptionalIntAssert assumption.

Parameters:

optionalInt - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default OptionalLongAssert assumeThat(OptionalLong optionalLong)

Creates a new instance of OptionalLongAssert assumption.

Parameters:

optionalLong - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLocalDateTimeAssert<?> assumeThat(LocalDateTime localDateTime)

Creates a new instance of LocalDateTimeAssert assumption.

Parameters:

localDateTime - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLocalDateAssert<?> assumeThat(LocalDate localDate)

Creates a new instance of LocalDateAssert assumption.

Parameters:

localDate - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractLocalTimeAssert<?> assumeThat(LocalTime localTime)

Creates a new instance of LocalTimeAssert assumption.

Parameters:

localTime - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractInstantAssert<?> assumeThat(Instant instant)

Creates a new instance of InstantAssert assumption.

Parameters:

instant - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractDurationAssert<?> assumeThat(Duration duration)

Creates a new instance of DurationAssert assumption.

Parameters:

duration - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.15.0

assumeThat

default AbstractPeriodAssert<?> assumeThat(Period period)

Creates a new instance of PeriodAssert assumption.

Parameters:

period - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.17.0

assumeThat

default AbstractOffsetTimeAssert<?> assumeThat(OffsetTime offsetTime)

Creates a new instance of OffsetTimeAssert assumption.

Parameters:

offsetTime - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractOffsetDateTimeAssert<?> assumeThat(OffsetDateTime offsetDateTime)

Creates a new instance of OffsetDateTimeAssert assumption.

Parameters:

offsetDateTime - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThatThrownBy

default AbstractThrowableAssert<?,? extends Throwable> assumeThatThrownBy(ThrowableAssert.ThrowingCallable shouldRaiseThrowable)

Allows to capture and then assume on a Throwable (easier done with lambdas).

Example :

  @Test
  public void testException() {
    assumeThatThrownBy(() -> { throw new Exception("boom!") }).isInstanceOf(Exception.class)
                                                              .hasMessageContaining("boom");
 }

Parameters:

shouldRaiseThrowable - The ThrowableAssert.ThrowingCallable or lambda with the code that should raise the throwable.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThatCode

default AbstractThrowableAssert<?,? extends Throwable> assumeThatCode(ThrowableAssert.ThrowingCallable shouldRaiseOrNotThrowable)

Allows to capture and then assume on a Throwable (easier done with lambdas).

Example :

 ThrowingCallable callable = () -> {
   throw new Exception("boom!");
 };

 // assertion succeeds
 assumeThatCode(callable).isInstanceOf(Exception.class)
                         .hasMessageContaining("boom");

 // assertion fails
 assumeThatCode(callable).doesNotThrowAnyException();

This method was not named assumeThat because the java compiler reported it ambiguous when used directly with a lambda :(

Parameters:

shouldRaiseOrNotThrowable - The ThrowableAssert.ThrowingCallable or lambda with the code that should raise the throwable.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThatObject

default <T> ProxyableObjectAssert<T> assumeThatObject(T actual)

Creates a new instance of ObjectAssert for any object.

This overload is useful, when an overloaded method of assertThat(...) takes precedence over the generic assumeThat(Object).

Example:

Cast necessary because assumeThat(List) "forgets" actual type:

assumeThat(new LinkedList<>(asList("abc"))).matches(list -> ((Deque<String>) list).getFirst().equals("abc")); 

No cast needed, but also no additional list assertions:

assumeThatObject(new LinkedList<>(asList("abc"))).matches(list -> list.getFirst().equals("abc")); 

Type Parameters:

T - the type of the actual value.

Parameters:

actual - the actual value.

Returns:

the created assertion object.

Since:

3.12.0

assumeThat

default <T> ProxyablePredicateAssert<T> assumeThat(Predicate<T> predicate)

Creates a new instance of PredicateAssert assumption.

Type Parameters:

T - the Predicate type.

Parameters:

predicate - the Predicate to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default IntPredicateAssert assumeThat(IntPredicate intPredicate)

Creates a new instance of IntPredicateAssert assumption.

Parameters:

intPredicate - the IntPredicate to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default LongPredicateAssert assumeThat(LongPredicate longPredicate)

Creates a new instance of LongPredicateAssert assumption.

Parameters:

longPredicate - the LongPredicate to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default DoublePredicateAssert assumeThat(DoublePredicate doublePredicate)

Creates a new instance of DoublePredicateAssert assumption.

Parameters:

doublePredicate - the DoublePredicate to test

Returns:

the created assumption for assertion object.

Since:

3.9.0

assumeThat

default AbstractUrlAssert<?> assumeThat(URL url)

Creates a new instance of UrlAssert assumption.

Parameters:

url - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default AbstractUriAssert<?> assumeThat(URI uri)

Creates a new instance of UriAssert assumption.

Parameters:

uri - the actual value.

Returns:

the created assumption for assertion object.

Since:

2.9.0 / 3.9.0

assumeThat

default <ELEMENT>
AbstractSpliteratorAssert<?,ELEMENT> assumeThat(Spliterator<ELEMENT> spliterator)

Creates a new instance of SpliteratorAssert assumption.

Type Parameters:

ELEMENT - the type of the elements.

Parameters:

spliterator - the actual value.

Returns:

the created assumption for assertion object.

Since:

3.14.0