org.assertj.core.api

Class AbstractCharacterAssert<S extends AbstractCharacterAssert<S>>

java.lang.Object

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

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

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

org.assertj.core.api.AbstractCharacterAssert<S>

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.

All Implemented Interfaces:

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

Direct Known Subclasses:

CharacterAssert

public abstract class AbstractCharacterAssert<S extends AbstractCharacterAssert<S>>
extends AbstractComparableAssert<S,Character>

Base class for all implementations of assertions for Characters.

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	AbstractCharacterAssert(Character actual, Class<?> selfType)

Method Summary

Methods

Modifier and Type	Method and Description
S	inUnicode() Use unicode character representation instead of standard representation in error messages.
S	isEqualTo(char expected) Verifies that the actual value is equal to the given one.
S	isGreaterThan(char other) Verifies that the actual value is greater than the given one.
S	isGreaterThanOrEqualTo(char other) Verifies that the actual value is greater than or equal to the given one.
S	isLessThan(char other) Verifies that the actual value is less than the given one.
S	isLessThanOrEqualTo(char other) Verifies that the actual value is less than or equal to the given one.
S	isLowerCase() Verifies that the actual value is a lowercase character.
S	isNotEqualTo(char other) Verifies that the actual value is not equal to the given one.
S	isUpperCase() Verifies that the actual value is a uppercase character.
S	usingComparator(Comparator<? super Character> 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.

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

inBinary, inHexadecimal, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

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

isEqualToComparingFieldByField, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields

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

as, as, asList, asString, 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, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCharacterAssert

protected AbstractCharacterAssert(Character actual,
                       Class<?> selfType)

Method Detail

isEqualTo

public S 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 S 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 S isLessThan(char other)

Verifies that the actual value is less than the given one.

Example:

 // assertion will pass
 assertThat('A').isLessThan('a');
 assertThat('a').isLessThan('b');

 // assertion will fail
 assertThat('a').isLessThan('A');
 assertThat('b').isLessThan('a');
 

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 S isLessThanOrEqualTo(char other)

Verifies that the actual value is less than or equal to the given one.

Example:

 // assertion will pass
 assertThat('A').isLessThanOrEqualTo('a');
 assertThat('A').isLessThanOrEqualTo('A');

 // assertion will fail
 assertThat('b').isLessThanOrEqualTo('a');
 

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 S isGreaterThan(char other)

Verifies that the actual value is greater than the given one.

Example:

 // assertion will pass
 assertThat('a').isGreaterThan('A');
 assertThat('b').isGreaterThan('a');

 // assertion will fail
 assertThat('A').isGreaterThan('a');
 assertThat('a').isGreaterThan('b');
 

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.

inUnicode

public S inUnicode()

Use unicode character representation instead of standard representation in error messages.

It can be useful when comparing UNICODE characters - many unicode chars have duplicate characters assigned, it is thus impossible to find differences from the standard error message:

With standard error message:

 assertThat('µ').isEqualTo('μ');

 org.junit.ComparisonFailure:
 Expected :'μ'
 Actual   :'µ'
 

With unicode based error message:

 assertThat('µ').inUnicode().isEqualTo('μ');

 org.junit.ComparisonFailure:
 Expected :μ
 Actual   :µ
 

Returns:

this assertion object.

isGreaterThanOrEqualTo

public S isGreaterThanOrEqualTo(char other)

Verifies that the actual value is greater than or equal to the given one.

Example:

 // assertion will pass
 assertThat('A').isGreaterThanOrEqualTo('A');
 assertThat('b').isGreaterThanOrEqualTo('a');
 
 // assertion will fail
 assertThat('a').isGreaterThanOrEqualTo('b');
 

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 S isLowerCase()

Verifies that the actual value is a lowercase character.

Example:

 // assertion will pass
 assertThat('a').isLowerCase();

 // assertion will fail
 assertThat('A').isLowerCase();
 

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

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

isUpperCase

public S isUpperCase()

Verifies that the actual value is a uppercase character.

Example:

 // assertion will pass
 assertThat('A').isLowerCase();
 
 // assertion will fail
 assertThat('a').isLowerCase();
 

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

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

usingComparator

public S 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<S extends AbstractCharacterAssert<S>,Character>

Overrides:

usingComparator in class AbstractComparableAssert<S extends AbstractCharacterAssert<S>,Character>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public S 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<S extends AbstractCharacterAssert<S>,Character>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<S extends AbstractCharacterAssert<S>,Character>

Returns:

this assertion object.