org.assertj.core.api

Interface Assert<S extends Assert<S,A>,A>

Type Parameters:

S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

A - the type of the "actual" value.

All Superinterfaces:

Descriptable<S>, ExtensionPoints<S,A>

All Known Implementing Classes:

AbstractArrayAssert, AbstractAssert, AbstractBigDecimalAssert, AbstractBooleanArrayAssert, AbstractBooleanAssert, AbstractByteArrayAssert, AbstractByteAssert, AbstractCharacterAssert, AbstractCharArrayAssert, AbstractCharSequenceAssert, AbstractClassAssert, AbstractComparableAssert, AbstractDateAssert, AbstractDoubleArrayAssert, AbstractDoubleAssert, AbstractEnumerableAssert, AbstractFileAssert, AbstractFloatArrayAssert, AbstractFloatAssert, AbstractInputStreamAssert, AbstractIntArrayAssert, AbstractIntegerAssert, AbstractIterableAssert, AbstractListAssert, AbstractLocalDateAssert, AbstractLocalDateTimeAssert, AbstractLocalTimeAssert, AbstractLongArrayAssert, AbstractLongAssert, AbstractMapAssert, AbstractObjectArrayAssert, AbstractObjectAssert, AbstractOptionalAssert, AbstractPathAssert, AbstractShortArrayAssert, AbstractShortAssert, AbstractThrowableAssert, AbstractUnevenComparableAssert, AbstractZonedDateTimeAssert, BigDecimalAssert, BooleanArrayAssert, BooleanAssert, ByteArrayAssert, ByteAssert, CharacterAssert, CharArrayAssert, CharSequenceAssert, ClassAssert, DateAssert, DoubleArrayAssert, DoubleAssert, FileAssert, FloatArrayAssert, FloatAssert, GenericComparableAssert, InputStreamAssert, IntArrayAssert, IntegerAssert, IterableAssert, ListAssert, LocalDateAssert, LocalDateTimeAssert, LocalTimeAssert, LongArrayAssert, LongAssert, MapAssert, ObjectArrayAssert, ObjectAssert, OptionalAssert, PathAssert, ShortArrayAssert, ShortAssert, SoftAssertionClassAssert, SoftAssertionMapAssert, StringAssert, ThrowableAssert, ZonedDateTimeAssert

public interface Assert<S extends Assert<S,A>,A>
extends Descriptable<S>, ExtensionPoints<S,A>

Base contract of all assertion objects: the minimum functionality that any assertion object should provide.

Author:

Yvonne Wang, Alex Ruiz, Nicolas François, Mikhail Mazursky

Method Summary

Modifier and Type	Method and Description
AbstractListAssert<?,?,Object>	asList() Verifies that the actual value is an instance of List, and returns a list assertion, to allow chaining of list-specific assertions from this call.
AbstractCharSequenceAssert<?,String>	asString() Verifies that the actual value is an instance of String, and returns a String assertion, to allow chaining of String-specific assertions from this call.
S	doesNotHaveSameClassAs(Object other) Verifies that the actual value does not have the same class as the given object.
boolean	equals(Object obj) Deprecated. Throws UnsupportedOperationException if called. It is easy to accidentally call equals(Object) instead of isEqualTo(Object).
S	hasSameClassAs(Object other) Verifies that the actual value has the same class as the given object.
S	isEqualTo(Object expected) Verifies that the actual value is equal to the given one.
S	isExactlyInstanceOf(Class<?> type) Verifies that the actual value is exactly an instance of the given type.
S	isIn(Iterable<?> values) Verifies that the actual value is present in the given values.
S	isIn(Object... values) Verifies that the actual value is present in the given array of values.
S	isInstanceOf(Class<?> type) Verifies that the actual value is an instance of the given type.
S	isInstanceOfAny(Class<?>... types) Verifies that the actual value is an instance of any of the given types.
S	isNotEqualTo(Object other) Verifies that the actual value is not equal to the given one.
S	isNotExactlyInstanceOf(Class<?> type) Verifies that the actual value is not exactly an instance of given type.
S	isNotIn(Iterable<?> values) Verifies that the actual value is not present in the given values.
S	isNotIn(Object... values) Verifies that the actual value is not present in the given array of values.
S	isNotInstanceOf(Class<?> type) Verifies that the actual value is not an instance of the given type.
S	isNotInstanceOfAny(Class<?>... types) Verifies that the actual value is not an instance of any of the given types.
S	isNotNull() Verifies that the actual value is not null.
S	isNotOfAnyClassIn(Class<?>... types) Verifies that the actual value type is not in given types.
S	isNotSameAs(Object other) Verifies that the actual value is not the same as the given one.
void	isNull() Verifies that the actual value is null.
S	isOfAnyClassIn(Class<?>... types) Verifies that the actual value type is in given types.
S	isSameAs(Object expected) Verifies that the actual value is the same as the given one.
S	usingComparator(Comparator<? super A> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
S	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.
S	withThreadDumpOnError() In case of assertion error, the thread dump will be printed on System.err.

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, describedAs, describedAs

Methods inherited from interface org.assertj.core.api.ExtensionPoints

doesNotHave, has, is, isNot

Method Detail

isEqualTo

S isEqualTo(Object expected)

Verifies that the actual value is equal to the given one.

Parameters:

expected - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is not equal to the given one.

isNotEqualTo

S isNotEqualTo(Object other)

Verifies that the actual value is not equal to the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is equal to the given one.

isNull

void isNull()

Verifies that the actual value is null.

Throws:

AssertionError - if the actual value is not null.

isNotNull

S isNotNull()

Verifies that the actual value is not null.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

isSameAs

S isSameAs(Object expected)

Verifies that the actual value is the same as the given one.

Parameters:

expected - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is not the same as the given one.

isNotSameAs

S isNotSameAs(Object other)

Verifies that the actual value is not the same as the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is the same as the given one.

isIn

S isIn(Object... values)

Verifies that the actual value is present in the given array of values.

Parameters:

values - the given array to search the actual value in.

Returns:

this assertion object.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

AssertionError - if the actual value is not present in the given array.

isNotIn

S isNotIn(Object... values)

Verifies that the actual value is not present in the given array of values.

Parameters:

values - the given array to search the actual value in.

Returns:

this assertion object.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

AssertionError - if the actual value is present in the given array.

isIn

S isIn(Iterable<?> values)

Verifies that the actual value is present in the given values.

Parameters:

values - the given iterable to search the actual value in.

Returns:

this assertion object.

Throws:

NullPointerException - if the given collection is null.

IllegalArgumentException - if the given collection is empty.

AssertionError - if the actual value is not present in the given collection.

isNotIn

S isNotIn(Iterable<?> values)

Verifies that the actual value is not present in the given values.

Parameters:

values - the given iterable to search the actual value in.

Returns:

this assertion object.

Throws:

NullPointerException - if the given collection is null.

IllegalArgumentException - if the given collection is empty.

AssertionError - if the actual value is present in the given collection.

usingComparator

S usingComparator(Comparator<? super A> customComparator)

Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.

Examples :

 // frodo and sam are instances of Character with Hobbit race (obviously :).
 // raceComparator implements Comparator<Character> 
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); 
 

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

Throws:

NullPointerException - if the given comparator is null.

usingDefaultComparator

S usingDefaultComparator()

Revert to standard comparison for incoming assertion checks.

This method should be used to disable a custom comparison strategy set by calling usingComparator(Comparator).

Returns:

this assertion object.

isInstanceOf

S isInstanceOf(Class<?> type)

Verifies that the actual value is an instance of the given type.

Parameters:

type - the type to check the actual value against.

Returns:

this assertion object.

Throws:

NullPointerException - if the given type is null.

AssertionError - if the actual value is null.

AssertionError - if the actual value is not an instance of the given type.

isInstanceOfAny

S isInstanceOfAny(Class<?>... types)

Verifies that the actual value is an instance of any of the given types.

Parameters:

types - the types to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not an instance of any of the given types.

NullPointerException - if the given array of types is null.

NullPointerException - if the given array of types contains nulls.

isNotInstanceOf

S isNotInstanceOf(Class<?> type)

Verifies that the actual value is not an instance of the given type.

Parameters:

type - the type to check the actual value against.

Returns:

this assertion object.

Throws:

NullPointerException - if the given type is null.

AssertionError - if the actual value is null.

AssertionError - if the actual value is an instance of the given type.

isNotInstanceOfAny

S isNotInstanceOfAny(Class<?>... types)

Verifies that the actual value is not an instance of any of the given types.

Parameters:

types - the types to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is an instance of any of the given types.

NullPointerException - if the given array of types is null.

NullPointerException - if the given array of types contains nulls.

hasSameClassAs

S hasSameClassAs(Object other)

Verifies that the actual value has the same class as the given object.

Parameters:

other - the object to check type against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual has not the same type has the given object.

NullPointerException - if the actual value is null.

NullPointerException - if the given object is null.

doesNotHaveSameClassAs

S doesNotHaveSameClassAs(Object other)

Verifies that the actual value does not have the same class as the given object.

Parameters:

other - the object to check type against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual has the same type has the given object.

NullPointerException - if the actual value is null.

NullPointerException - if the given object is null.

isExactlyInstanceOf

S isExactlyInstanceOf(Class<?> type)

Verifies that the actual value is exactly an instance of the given type.

Parameters:

type - the type to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual is not exactly an instance of given type.

NullPointerException - if the actual value is null.

NullPointerException - if the given object is null.

isNotExactlyInstanceOf

S isNotExactlyInstanceOf(Class<?> type)

Verifies that the actual value is not exactly an instance of given type.

Parameters:

type - the type to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual is exactly a instance of given type.

NullPointerException - if the actual value is null.

NullPointerException - if the given object is null.

isOfAnyClassIn

S isOfAnyClassIn(Class<?>... types)

Verifies that the actual value type is in given types.

Parameters:

types - the types to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value type is not in given type.

NullPointerException - if the actual value is null.

NullPointerException - if the given types is null.

isNotOfAnyClassIn

S isNotOfAnyClassIn(Class<?>... types)

Verifies that the actual value type is not in given types.

Parameters:

types - the types to check the actual value against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value type is in given types.

NullPointerException - if the actual value is null.

NullPointerException - if the given types is null.

asList

AbstractListAssert<?,?,Object> asList()

Verifies that the actual value is an instance of List, and returns a list assertion, to allow chaining of list-specific assertions from this call.

Example :

 Object listAsObject = newArrayList(1, 2, 3);

 assertThat(listAsObject).asList().isSorted();
 

Returns:

a list assertion object

asString

AbstractCharSequenceAssert<?,String> asString()

Verifies that the actual value is an instance of String, and returns a String assertion, to allow chaining of String-specific assertions from this call.

Example :

 Object stringAsObject = "hello world";

 assertThat(stringAsObject).asString().contains("hello");
 

Returns:

a string assertion object

equals

@Deprecated
boolean equals(Object obj)

Deprecated. Throws UnsupportedOperationException if called. It is easy to accidentally call equals(Object) instead of isEqualTo(Object).

Overrides:

equals in class Object

Throws:

UnsupportedOperationException - if this method is called.

withThreadDumpOnError

S withThreadDumpOnError()

In case of assertion error, the thread dump will be printed on System.err.

Example :

 assertThat("Messi").withThreadDumpOnError().isEqualTo("Ronaldo");
 

will print the thread dump, something looking like:

 "JDWP Command Reader"
        java.lang.Thread.State: RUNNABLE
 
 "JDWP Event Helper Thread"
        java.lang.Thread.State: RUNNABLE
 
 "JDWP Transport Listener: dt_socket"
        java.lang.Thread.State: RUNNABLE
 
 "Signal Dispatcher"
        java.lang.Thread.State: RUNNABLE
 
 "Finalizer"
        java.lang.Thread.State: WAITING
                at java.lang.Object.wait(Native Method)
                at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:135)
                at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:151)
                at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:189)
 
 "Reference Handler"
        java.lang.Thread.State: WAITING
                at java.lang.Object.wait(Native Method)
                at java.lang.Object.wait(Object.java:503)
                at java.lang.ref.Reference$ReferenceHandler.run(Reference.java:133)
 
 "main"
        java.lang.Thread.State: RUNNABLE
                at sun.management.ThreadImpl.dumpThreads0(Native Method)
                at sun.management.ThreadImpl.dumpAllThreads(ThreadImpl.java:446)
                at org.assertj.core.internal.Failures.threadDumpDescription(Failures.java:193)
                at org.assertj.core.internal.Failures.printThreadDumpIfNeeded(Failures.java:141)
                at org.assertj.core.internal.Failures.failure(Failures.java:91)
                at org.assertj.core.internal.Objects.assertEqual(Objects.java:314)
                at org.assertj.core.api.AbstractAssert.isEqualTo(AbstractAssert.java:198)
                at org.assertj.examples.ThreadDumpOnErrorExample.main(ThreadDumpOnErrorExample.java:28)
 

Returns:

this assertion object.