Module com.github.robtimus.junit.support

Package com.github.robtimus.junit.support

Class AssertionFailedErrorBuilder.ReasonBuilder

java.lang.Object

com.github.robtimus.junit.support.AssertionFailedErrorBuilder.ReasonBuilder

Enclosing class:

AssertionFailedErrorBuilder

public static final class AssertionFailedErrorBuilder.ReasonBuilder
extends Object

A builder for the reason why the assertion failed.

Author:

Rob Spoor

Since:

2.0

Method Summary

Modifier and Type	Method	Description
AssertionFailedErrorBuilder	format()	Sets the reason on the AssertionFailedErrorBuilder that returned this object.
AssertionFailedErrorBuilder.ReasonBuilder	withValue(Object value)	Adds a single formatted value.
AssertionFailedErrorBuilder.ReasonBuilder	withValues(Object... values)	Adds multiple formatted values, separated by commas.
AssertionFailedErrorBuilder.ReasonBuilder	withValues(Collection<?> values)	Adds multiple formatted values, separated by commas.

Methods inherited from class java.lang.Object

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

Method Detail

withValue

public AssertionFailedErrorBuilder.ReasonBuilder withValue(Object value)

Adds a single formatted value. This value should match a single string place holder in the pattern used to create this object.

Parameters:

value - The value to add.

Returns:

This object.

withValues

public AssertionFailedErrorBuilder.ReasonBuilder withValues(Object... values)

Adds multiple formatted values, separated by commas. These values should match a single string place holder in the pattern used to create this object.

Parameters:

values - The values to add.

Returns:

This object.

withValues

public AssertionFailedErrorBuilder.ReasonBuilder withValues(Collection<?> values)

Adds multiple formatted values, separated by commas. These values should match a single string place holder in the pattern used to create this object.

Parameters:

values - The values to add.

Returns:

This object.

Throws:

NullPointerException - If the given collection is null.

format

public AssertionFailedErrorBuilder format()

Sets the reason on the AssertionFailedErrorBuilder that returned this object. The reason will be a formatted string using the format used to create this object and arguments added to this object.

Returns:

The AssertionFailedErrorBuilder that returned this object.

Throws:

IllegalFormatException - If the formatted string could not be created.

See Also:

String.format(String, Object...)