Package org.hamcrest

Interface Description

All Known Implementing Classes:

BaseDescription, Description.NullDescription, StringDescription

public interface Description

A description of a Matcher. A Matcher will describe itself to a description which can later be used for reporting.

See Also:

• SelfDescribing.describeTo(Description)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Description.NullDescription	A description that consumes input but does nothing.

Field Summary

Fields

Modifier and Type	Field	Description
static final Description	NONE	A description that consumes input but does nothing, implemented by Description.NullDescription.

Method Summary

Modifier and Type	Method	Description
Description	appendDescriptionOf(SelfDescribing value)	Appends the description of a SelfDescribing value to this description.
Description	appendList(String start, String separator, String end, Iterable<? extends SelfDescribing> values)	Appends a list of SelfDescribing objects to the description.
Description	appendText(String text)	Appends some plain text to the description.
Description	appendValue(Object value)	Appends an arbitrary value to the description.
<T> Description	appendValueList(String start, String separator, String end, Iterable<T> values)	Appends a list of values to the description.
<T> Description	appendValueList(String start, String separator, String end, T... values)	Appends a list of values to the description.

Field Details

NONE

static final Description NONE

A description that consumes input but does nothing, implemented by Description.NullDescription.

Method Details

appendText

Description appendText(String text)

Appends some plain text to the description.

Parameters:

text - the text to append.

Returns:

the update description when displaying the matcher error.

appendDescriptionOf

Description appendDescriptionOf(SelfDescribing value)

Appends the description of a SelfDescribing value to this description.

Parameters:

value - the value to append.

Returns:

the update description when displaying the matcher error.

appendValue

Description appendValue(Object value)

Appends an arbitrary value to the description.

Parameters:

value - the object to append.

Returns:

the update description when displaying the matcher error.

appendValueList

<T> Description appendValueList(String start,
 String separator,
 String end,
 T... values)

Appends a list of values to the description.

Type Parameters:

T - the description type.

Parameters:

start - the prefix.

separator - the separator.

end - the suffix.

values - the values to append.

Returns:

the update description when displaying the matcher error.

appendValueList

<T> Description appendValueList(String start,
 String separator,
 String end,
 Iterable<T> values)

Appends a list of values to the description.

Type Parameters:

T - the description type.

Parameters:

start - the prefix.

separator - the separator.

end - the suffix.

values - the values to append.

Returns:

the update description when displaying the matcher error.

appendList

Description appendList(String start,
 String separator,
 String end,
 Iterable<? extends SelfDescribing> values)

Appends a list of SelfDescribing objects to the description.

Parameters:

start - the prefix.

separator - the separator.

end - the suffix.

values - the values to append.

Returns:

the update description when displaying the matcher error.