org.assertj.core.api

Class CharacterAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.assertj.core.api.AbstractComparableAssert<CharacterAssert,Character>

org.assertj.core.api.CharacterAssert

All Implemented Interfaces:

Assert<CharacterAssert,Character>, ComparableAssert<CharacterAssert,Character>, Descriptable<CharacterAssert>, ExtensionPoints<CharacterAssert,Character>

public class CharacterAssert
extends AbstractComparableAssert<CharacterAssert,Character>

Assertion methods for characters.

To create an instance of this class, invoke Assertions.assertThat(Character) or Assertions.assertThat(char).

Author:

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

Field Summary

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CharacterAssert(Character actual)

Method Summary

Methods

Modifier and Type	Method and Description
CharacterAssert	isEqualTo(char expected) Verifies that the actual value is equal to the given one.
CharacterAssert	isGreaterThan(char other) Verifies that the actual value is greater than the given one.
CharacterAssert	isGreaterThanOrEqualTo(char other) Verifies that the actual value is greater than or equal to the given one.
CharacterAssert	isLessThan(char other) Verifies that the actual value is less than the given one.
CharacterAssert	isLessThanOrEqualTo(char other) Verifies that the actual value is less than or equal to the given one.
CharacterAssert	isLowerCase() Verifies that the actual value is a lowercase character.
CharacterAssert	isNotEqualTo(char other) Verifies that the actual value is not equal to the given one.
CharacterAssert	isUpperCase() Verifies that the actual value is a uppercase character.
CharacterAssert	usingComparator(Comparator<? super Character> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
CharacterAssert	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.

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

isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

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

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterAssert

protected CharacterAssert(Character actual)

Method Detail

isEqualTo

public CharacterAssert isEqualTo(char 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 null.

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

isNotEqualTo

public CharacterAssert isNotEqualTo(char 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 null.

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

isLessThan

public CharacterAssert isLessThan(char other)

Verifies that the actual value is less than 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 null.

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

isLessThanOrEqualTo

public CharacterAssert isLessThanOrEqualTo(char other)

Verifies that the actual value is less than or 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 null.

AssertionError - if the actual value is greater than the given one.

isGreaterThan

public CharacterAssert isGreaterThan(char other)

Verifies that the actual value is greater than 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 null.

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

isGreaterThanOrEqualTo

public CharacterAssert isGreaterThanOrEqualTo(char other)

Verifies that the actual value is greater than or 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 null.

AssertionError - if the actual value is less than the given one.

isLowerCase

public CharacterAssert isLowerCase()

Verifies that the actual value is a lowercase character.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not a lowercase character.

isUpperCase

public CharacterAssert isUpperCase()

Verifies that the actual value is a uppercase character.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not a uppercase character.

usingComparator

public CharacterAssert usingComparator(Comparator<? super Character> customComparator)

Description copied from class: AbstractAssert

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); 
 

Specified by:

usingComparator in interface Assert<CharacterAssert,Character>

Overrides:

usingComparator in class AbstractComparableAssert<CharacterAssert,Character>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public CharacterAssert usingDefaultComparator()

Description copied from class: AbstractAssert

Revert to standard comparison for incoming assertion checks.

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

Specified by:

usingDefaultComparator in interface Assert<CharacterAssert,Character>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<CharacterAssert,Character>

Returns:

this assertion object.