org.assertj.core.api

Class AbstractBooleanAssert<SELF extends AbstractBooleanAssert<SELF>>

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,Boolean>

org.assertj.core.api.AbstractBooleanAssert<SELF>

Type Parameters:

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

All Implemented Interfaces:

Assert<SELF,Boolean>, Descriptable<SELF>, ExtensionPoints<SELF,Boolean>

Direct Known Subclasses:

BooleanAssert

public abstract class AbstractBooleanAssert<SELF extends AbstractBooleanAssert<SELF>>
extends AbstractAssert<SELF,Boolean>

Base class for all implementations of assertions for Booleans.

Author:

Alex Ruiz, Yvonne Wang, David DIDIER, Ansgar Konermann, Mikhail Mazursky

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Constructor and Description
AbstractBooleanAssert(Boolean actual, Class<?> selfType)

Method Summary

Modifier and Type	Method and Description
SELF	isEqualTo(boolean expected) Verifies that the actual value is equal to the given one.
SELF	isFalse() Verifies that the actual value is false.
SELF	isNotEqualTo(boolean other) Verifies that the actual value is not equal to the given one.
SELF	isTrue() Verifies that the actual value is true.
SELF	usingComparator(Comparator<? super Boolean> customComparator) Deprecated. Custom Comparator is not supported for Boolean comparison.
SELF	usingComparator(Comparator<? super Boolean> customComparator, String customComparatorDescription) Deprecated. Custom Comparator is not supported for Boolean comparison.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, throwAssertionError, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBooleanAssert

public AbstractBooleanAssert(Boolean actual,
                             Class<?> selfType)

Method Detail

isTrue

public SELF isTrue()

Verifies that the actual value is true.

Example:

 // assertions will pass
 assertThat(true).isTrue();
 assertThat(Boolean.TRUE).isTrue();

 // assertions will fail
 assertThat(false).isTrue();
 assertThat(Boolean.FALSE).isTrue();

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not true.

isFalse

public SELF isFalse()

Verifies that the actual value is false.

Example:

 // assertions will pass
 assertThat(false).isFalse();
 assertThat(Boolean.FALSE).isFalse();

 // assertions will fail
 assertThat(true).isFalse();
 assertThat(Boolean.TRUE).isFalse();

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not false.

isEqualTo

public SELF isEqualTo(boolean expected)

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

Example:

 // assertions will pass
 assertThat(true).isEqualTo(true);
 assertThat(Boolean.FALSE).isEqualTo(false);
 
 // assertions will fail
 assertThat(true).isEqualTo(false);
 assertThat(Boolean.TRUE).isEqualTo(false);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

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

isNotEqualTo

public SELF isNotEqualTo(boolean other)

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

Example:

 // assertions will pass
 assertThat(true).isNotEqualTo(false);
 assertThat(Boolean.FALSE).isNotEqualTo(true);

 // assertions will fail
 assertThat(true).isNotEqualTo(true);
 assertThat(Boolean.FALSE).isNotEqualTo(false);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

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

usingComparator

@Deprecated
public final SELF usingComparator(Comparator<? super Boolean> customComparator)

Deprecated. Custom Comparator is not supported for Boolean comparison.

Do not use this method.

Specified by:

usingComparator in interface Assert<SELF extends AbstractBooleanAssert<SELF>,Boolean>

Overrides:

usingComparator in class AbstractAssert<SELF extends AbstractBooleanAssert<SELF>,Boolean>

Parameters:

customComparator - the comparator to use for the incoming assertion checks.

Returns:

this assertion object.

Throws:

UnsupportedOperationException - if this method is called.

usingComparator

@Deprecated
public final SELF usingComparator(Comparator<? super Boolean> customComparator,
                                              String customComparatorDescription)

Deprecated. Custom Comparator is not supported for Boolean comparison.

Do not use this method.

Specified by:

usingComparator in interface Assert<SELF extends AbstractBooleanAssert<SELF>,Boolean>

Overrides:

usingComparator in class AbstractAssert<SELF extends AbstractBooleanAssert<SELF>,Boolean>

Parameters:

customComparator - the comparator to use for the incoming assertion checks.

customComparatorDescription - comparator description to be used in assertion error messages

Returns:

this assertion object.

Throws:

UnsupportedOperationException - if this method is called.