org.fest.assertions
Class ByteAssert

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

All Implemented Interfaces:

NumberAssert

public class ByteAssert
extends PrimitiveAssert
implements NumberAssert

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

Since:

1.2

Author:

Yvonne Wang, David DIDIER

Constructor Summary

protected

ByteAssert(byte actual) Creates a new ByteAssert.

Method Summary

ByteAssert	as(Description description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
ByteAssert	as(String description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
ByteAssert	describedAs(Description description) Alias for as(Description), since "as" is a keyword in Groovy.
ByteAssert	describedAs(String description) Alias for as(String), since "as" is a keyword in Groovy.
ByteAssert	isEqualTo(byte expected) Verifies that the actual byte value is equal to the given one.
ByteAssert	isGreaterThan(byte other) Verifies that the actual byte value is greater than the given one.
ByteAssert	isGreaterThanOrEqualTo(byte other) Verifies that the actual byte value is greater or equal to the given one.
ByteAssert	isLessThan(byte other) Verifies that the actual byte value is less than the given one.
ByteAssert	isLessThanOrEqualTo(byte other) Verifies that the actual byte value is less or equal to the given one.
ByteAssert	isNegative() Verifies that the actual byte value is negative.
ByteAssert	isNotEqualTo(byte other) Verifies that the actual byte value is not equal to the given one.
ByteAssert	isPositive() Verifies that the actual byte value is positive.
ByteAssert	isZero() Verifies that the actual byte value is equal to zero.
ByteAssert	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

ByteAssert

protected ByteAssert(byte actual)

Creates a new ByteAssert.

Parameters:

actual - the target to verify.

Method Detail

as

public ByteAssert 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 ByteAssert 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 ByteAssert 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 ByteAssert 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 ByteAssert isEqualTo(byte expected)

Verifies that the actual byte 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 byte value is not equal to the given one.

isNotEqualTo

public ByteAssert isNotEqualTo(byte other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThan

public ByteAssert isGreaterThan(byte other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThan

public ByteAssert isLessThan(byte other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThanOrEqualTo

public ByteAssert isGreaterThanOrEqualTo(byte other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThanOrEqualTo

public ByteAssert isLessThanOrEqualTo(byte other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isZero

public ByteAssert isZero()

Verifies that the actual byte value is equal to zero.

Specified by:

isZero in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual byte value is not equal to zero.

isPositive

public ByteAssert isPositive()

Verifies that the actual byte value is positive.

Specified by:

isPositive in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual byte value is not positive.

isNegative

public ByteAssert isNegative()

Verifies that the actual byte value is negative.

Specified by:

isNegative in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual byte value is not negative.

overridingErrorMessage

public ByteAssert 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.