org.fest.assertions
Class CharAssert

java.lang.Object
  org.fest.assertions.Assert
      org.fest.assertions.PrimitiveAssert
          org.fest.assertions.CharAssert

public class CharAssert
extends PrimitiveAssert

Understands assertion methods for chars. To create a new instance of this class use the method Assertions.assertThat(char).

Author:

Yvonne Wang, David DIDIER

Constructor Summary

protected

CharAssert(char actual) Creates a new CharAssert.

Method Summary

CharAssert	as(Description description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
CharAssert	as(String description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
CharAssert	describedAs(Description description) Alias for as(Description), since "as" is a keyword in Groovy.
CharAssert	describedAs(String description) Alias for as(String), since "as" is a keyword in Groovy.
CharAssert	isEqualTo(char expected) Verifies that the actual char value is equal to the given one.
CharAssert	isGreaterThan(char other) Verifies that the actual char value is greater than the given one.
CharAssert	isGreaterThanOrEqualTo(char other) Verifies that the actual char value is greater or equal to the given one.
CharAssert	isLessThan(char other) Verifies that the actual char value is less than the given one.
CharAssert	isLessThanOrEqualTo(char other) Verifies that the actual char value is less or equal to the given one.
CharAssert	isLowerCase() Verifies that the actual char value is an lowercase value.
CharAssert	isNotEqualTo(char other) Verifies that the actual char value is not equal to the given one.
CharAssert	isUpperCase() Verifies that the actual char value is an uppercase value.
CharAssert	overridingErrorMessage(String message) Replaces the default message displayed in case of a failure with the given one.

Methods inherited from class org.fest.assertions.Assert

customErrorMessage, description, description, description, equals, fail, fail, failIfCustomMessageIsSet, failIfCustomMessageIsSet, failure, formattedErrorMessage, hashCode, rawDescription, replaceDefaultErrorMessagesWith

Methods inherited from class java.lang.Object

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

Constructor Detail

CharAssert

protected CharAssert(char actual)

Creates a new CharAssert.

Parameters:

actual - the target to verify.

Method Detail

as

public CharAssert as(String description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).as("Some value").isEqualTo(otherValue);
 

Specified by:

as in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public CharAssert describedAs(String description)

Alias for as(String), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).describedAs("Some value").isEqualTo(otherValue);
 

Specified by:

describedAs in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

as

public CharAssert as(Description description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).as(new BasicDescription("Some value")).isEqualTo(otherValue);
 

Specified by:

as in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public CharAssert describedAs(Description description)

Alias for as(Description), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).describedAs(new BasicDescription("Some value")).isEqualTo(otherValue);
 

Specified by:

describedAs in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

isEqualTo

public CharAssert isEqualTo(char expected)

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

Parameters:

expected - the value to compare the actual one to.

Returns:

this assertion object.

Throws:

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

isNotEqualTo

public CharAssert isNotEqualTo(char other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThan

public CharAssert isGreaterThan(char other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThan

public CharAssert isLessThan(char other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThanOrEqualTo

public CharAssert isGreaterThanOrEqualTo(char other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThanOrEqualTo

public CharAssert isLessThanOrEqualTo(char other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isUpperCase

public CharAssert isUpperCase()

Verifies that the actual char value is an uppercase value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual char value is not an uppercase value.

isLowerCase

public CharAssert isLowerCase()

Verifies that the actual char value is an lowercase value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual char value is not an lowercase value.

overridingErrorMessage

public CharAssert overridingErrorMessage(String message)

Replaces the default message displayed in case of a failure with the given one.

For example, the following assertion:

 assertThat("Hello").isEqualTo("Bye");
 

will fail with the default message "expected:<'[Bye]'> but was:<'[Hello]'>."

We can replace this message with our own:

 assertThat("Hello").overridingErrorMessage("'Hello' should be equal to 'Bye'").isEqualTo("Bye");
 

in this case, the assertion will fail showing the message "'Hello' should be equal to 'Bye'".

Specified by:

overridingErrorMessage in class PrimitiveAssert

Parameters:

message - the given error message, which will replace the default one.

Returns:

this assertion.