org.fest.assertions.api
Class CharacterAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<S,A>
      extended by org.fest.assertions.api.AbstractComparableAssert<CharacterAssert,Character>
          extended by org.fest.assertions.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

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected CharacterAssert(Character actual)
           
 
Method Summary
 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<?> 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.fest.assertions.api.AbstractComparableAssert
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo
 
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, equals, has, hashCode, is, isEqualTo, isIn, isIn, isNot, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNotSameAs, isNull, isSameAs
 
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<?> 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.

Example :
 // compares invoices by payee 
 assertThat(invoiceList).usingComparator(invoicePayeeComparator).isEqualTo(expectedInvoiceList).
 
 // compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator
 assertThat(invoiceList).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice)
 
 // as assertThat(invoiceList) creates a new assertion, it uses standard comparison strategy (Invoice's equal method) to compare invoiceList elements to lowestInvoice.                                                      
 assertThat(invoiceList).contains(lowestInvoice).
 
Custom comparator is not parameterized with actual type A (ie. Comparator<A>) because if it was, we could not write the following code :
 // frodo and sam are instances of Character (a Character having a Race)
 // raceComparator implements Comparator<Character> 
 // assertThat(frodo) returns an ObjectAssert and not a custom CharacterAssert implementing Assert<CharacterAssert, Character>  
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); // won't compile !
 
 The code does not compile because assertThat(frodo) returns an ObjectAssert, thus usingComparator expects a Comparator<Object> 
 and Comparator<Character> is not a Comparator<Object> as generics are not reified.
 
 Note that, it would have worked if assertThat(frodo) returned a CharacterAssert implementing Assert<CharacterAssert, Character>. 
 

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.


Copyright © 2007-2012 FEST (Fixtures for Easy Software Testing). All Rights Reserved.