org.fest.assertions.api
Class BooleanAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<BooleanAssert,Boolean>
      extended by org.fest.assertions.api.BooleanAssert
All Implemented Interfaces:
Assert<BooleanAssert,Boolean>, Descriptable<BooleanAssert>, ExtensionPoints<BooleanAssert,Boolean>

public class BooleanAssert
extends AbstractAssert<BooleanAssert,Boolean>

Assertion methods for bytes.

To create an instance of this class, invoke Assertions.assertThat(Boolean) or Assertions.assertThat(boolean).

Author:
Alex Ruiz, Yvonne Wang, David DIDIER, Ansgar Konermann

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected BooleanAssert(Boolean actual)
           
 
Method Summary
 BooleanAssert isEqualTo(boolean expected)
          Verifies that the actual value is equal to the given one.
 BooleanAssert isFalse()
          Verifies that the actual value is false.
 BooleanAssert isNotEqualTo(boolean other)
          Verifies that the actual value is not equal to the given one.
 BooleanAssert isTrue()
          Verifies that the actual value is true.
 BooleanAssert usingComparator(Comparator<?> customComparator)
          Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
 
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, usingDefaultComparator
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanAssert

protected BooleanAssert(Boolean actual)
Method Detail

isTrue

public BooleanAssert isTrue()
Verifies that the actual value is true.

Returns:
this assertion object.
Throws:
AssertionError - if the actual value is null.
AssertionError - if the actual value is not true.

isFalse

public BooleanAssert isFalse()
Verifies that the actual value is false.

Returns:
this assertion object.
Throws:
AssertionError - if the actual value is null.
AssertionError - if the actual value is not false.

isEqualTo

public BooleanAssert isEqualTo(boolean 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 BooleanAssert isNotEqualTo(boolean 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.

usingComparator

public BooleanAssert 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<BooleanAssert,Boolean>
Overrides:
usingComparator in class AbstractAssert<BooleanAssert,Boolean>
Parameters:
customComparator - the comparator to use for incoming assertion checks.
Returns:
this assertion object.


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