Uses of Interface org.hamcrest.Description (Hamcrest)
Date: 2018-08-04

## Uses of Interface
org.hamcrest.Description

- Packages that use Description
  Package | Description
  --- | ---
  org.hamcrest | The stable API defining Matcher and its associated interfaces and classes.
  org.hamcrest.beans | Matchers of Java Bean properties and their values.
  org.hamcrest.collection | Matchers of arrays and collections.
  org.hamcrest.core | Fundamental matchers of objects and values, and composite matchers.
  org.hamcrest.internal |
  org.hamcrest.number | Matchers that perform numeric comparisons.
  org.hamcrest.object | Matchers that inspect objects and classes.
  org.hamcrest.text | Matchers that perform text comparisons.
  org.hamcrest.xml | Matchers of XML documents.

- - ### Uses of Description in org.hamcrest

    Classes in org.hamcrest that implement Description
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BaseDescription` A `Description` that is stored as a string.
    `static class` | `Description.NullDescription`
    `class` | `StringDescription` A `Description` that is stored as a string.

    Fields in org.hamcrest declared as Description
    Modifier and Type | Field and Description
    --- | ---
    `static Description` | Description.`NONE` A description that consumes input but does nothing.

    Methods in org.hamcrest that return Description
    Modifier and Type | Method and Description
    --- | ---
    `Description` | Description.`appendDescriptionOf(SelfDescribing value)` Appends the description of a `SelfDescribing` value to this description.
    `Description` | Description.NullDescription.`appendDescriptionOf(SelfDescribing value)`
    `Description` | BaseDescription.`appendDescriptionOf(SelfDescribing value)`
    `Description` | Description.`appendList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<? extends SelfDescribing> values)` Appends a list of `SelfDescribing` objects to the description.
    `Description` | Description.NullDescription.`appendList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<? extends SelfDescribing> values)`
    `Description` | BaseDescription.`appendList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<? extends SelfDescribing> values)`
    `Description` | Description.`appendText(java.lang.String text)` Appends some plain text to the description.
    `Description` | Description.NullDescription.`appendText(java.lang.String text)`
    `Description` | BaseDescription.`appendText(java.lang.String text)`
    `Description` | Description.`appendValue(java.lang.Object value)` Appends an arbitary value to the description.
    `Description` | Description.NullDescription.`appendValue(java.lang.Object value)`
    `Description` | BaseDescription.`appendValue(java.lang.Object value)`
    `<T> Description` | Description.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<T> values)` Appends a list of values to the description.
    `<T> Description` | Description.NullDescription.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<T> values)`
    `<T> Description` | BaseDescription.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, java.lang.Iterable<T> values)`
    `<T> Description` | Description.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, T... values)` Appends a list of values to the description.
    `<T> Description` | Description.NullDescription.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, T... values)`
    `<T> Description` | BaseDescription.`appendValueList(java.lang.String start, java.lang.String separator, java.lang.String end, T... values)`

    Methods in org.hamcrest with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `Condition<O>` | Condition.Step.`apply(I value, Description mismatch)`
    `void` | TypeSafeDiagnosingMatcher.`describeMismatch(java.lang.Object item, Description mismatchDescription)`
    `void` | DiagnosingMatcher.`describeMismatch(java.lang.Object item, Description mismatchDescription)`
    `void` | TypeSafeMatcher.`describeMismatch(java.lang.Object item, Description description)`
    `void` | Matcher.`describeMismatch(java.lang.Object item, Description mismatchDescription)` Generate a description of why the matcher has not accepted the item.
    `void` | BaseMatcher.`describeMismatch(java.lang.Object item, Description description)`
    `protected void` | TypeSafeMatcher.`describeMismatchSafely(T item, Description mismatchDescription)` Subclasses should override this.
    `void` | FeatureMatcher.`describeTo(Description description)`
    `void` | CustomTypeSafeMatcher.`describeTo(Description description)`
    `void` | SelfDescribing.`describeTo(Description description)` Generates a description of the object.
    `void` | CustomMatcher.`describeTo(Description description)`
    `static <T> Condition<T>` | Condition.`matched(T theValue, Description mismatch)`
    `protected abstract boolean` | DiagnosingMatcher.`matches(java.lang.Object item, Description mismatchDescription)`
    `protected abstract boolean` | TypeSafeDiagnosingMatcher.`matchesSafely(T item, Description mismatchDescription)` Subclasses should implement this.
    `protected boolean` | FeatureMatcher.`matchesSafely(T actual, Description mismatch)`

  - ### Uses of Description in org.hamcrest.beans

    Methods in org.hamcrest.beans with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | HasProperty.`describeMismatchSafely(T item, Description mismatchDescription)`
    `void` | HasPropertyWithValue.`describeTo(Description description)`
    `void` | SamePropertyValuesAs.`describeTo(Description description)`
    `void` | SamePropertyValuesAs.PropertyMatcher.`describeTo(Description description)`
    `void` | HasProperty.`describeTo(Description description)`
    `boolean` | SamePropertyValuesAs.PropertyMatcher.`matches(java.lang.Object actual, Description mismatch)`
    `boolean` | HasPropertyWithValue.`matchesSafely(T bean, Description mismatch)`
    `boolean` | SamePropertyValuesAs.`matchesSafely(T bean, Description mismatch)`

  - ### Uses of Description in org.hamcrest.collection

    Methods in org.hamcrest.collection with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | IsEmptyCollection.`describeMismatchSafely(java.util.Collection<? extends E> item, Description mismatchDescription)`
    `void` | IsArrayContainingInOrder.`describeMismatchSafely(E[] item, Description mismatchDescription)`
    `void` | IsArrayContainingInAnyOrder.`describeMismatchSafely(E[] item, Description mismatchDescription)`
    `void` | IsEmptyIterable.`describeMismatchSafely(java.lang.Iterable<? extends E> iter, Description mismatchDescription)`
    `void` | IsMapContaining.`describeMismatchSafely(java.util.Map<? extends K,? extends V> map, Description mismatchDescription)`
    `void` | IsArrayContaining.`describeMismatchSafely(T[] item, Description mismatchDescription)`
    `void` | IsArray.`describeMismatchSafely(T[] actual, Description mismatchDescription)`
    `void` | IsArrayContainingInOrder.`describeTo(Description description)`
    `void` | IsArrayContainingInAnyOrder.`describeTo(Description description)`
    `void` | IsArrayContaining.`describeTo(Description description)`
    `void` | IsIterableContainingInAnyOrder.`describeTo(Description description)`
    `void` | IsEmptyCollection.`describeTo(Description description)`
    `void` | IsMapContaining.`describeTo(Description description)`
    `void` | IsEmptyIterable.`describeTo(Description description)`
    `void` | IsArray.`describeTo(Description description)`
    `void` | IsIn.`describeTo(Description buffer)`
    `void` | IsIterableContainingInOrder.`describeTo(Description description)`
    `protected boolean` | IsIterableContainingInOrder.`matchesSafely(java.lang.Iterable<? extends E> iterable, Description mismatchDescription)`
    `protected boolean` | IsIterableContainingInAnyOrder.`matchesSafely(java.lang.Iterable<? extends T> items, Description mismatchDescription)`

  - ### Uses of Description in org.hamcrest.core

    Methods in org.hamcrest.core with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | Is.`describeMismatch(java.lang.Object item, Description mismatchDescription)`
    `void` | DescribedAs.`describeMismatch(java.lang.Object item, Description description)`
    `void` | SubstringMatcher.`describeMismatchSafely(java.lang.String item, Description mismatchDescription)`
    `void` | AnyOf.`describeTo(Description description)`
    `void` | CombinableMatcher.`describeTo(Description description)`
    `void` | AllOf.`describeTo(Description description)`
    `void` | IsSame.`describeTo(Description description)`
    `void` | SubstringMatcher.`describeTo(Description description)`
    `void` | IsInstanceOf.`describeTo(Description description)`
    `void` | IsCollectionContaining.`describeTo(Description description)`
    `void` | IsAnything.`describeTo(Description description)`
    `void` | Is.`describeTo(Description description)`
    `void` | Every.`describeTo(Description description)`
    `void` | IsNull.`describeTo(Description description)`
    `void` | IsNot.`describeTo(Description description)`
    `void` | IsEqual.`describeTo(Description description)`
    `void` | DescribedAs.`describeTo(Description description)`
    `boolean` | AllOf.`matches(java.lang.Object o, Description mismatch)`
    `protected boolean` | IsInstanceOf.`matches(java.lang.Object item, Description mismatch)`
    `protected boolean` | IsCollectionContaining.`matchesSafely(java.lang.Iterable<? super T> collection, Description mismatchDescription)`
    `boolean` | Every.`matchesSafely(java.lang.Iterable<T> collection, Description mismatchDescription)`
    `protected boolean` | CombinableMatcher.`matchesSafely(T item, Description mismatch)`

  - ### Uses of Description in org.hamcrest.internal

    Methods in org.hamcrest.internal with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | SelfDescribingValue.`describeTo(Description description)`

  - ### Uses of Description in org.hamcrest.number

    Methods in org.hamcrest.number with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | BigDecimalCloseTo.`describeMismatchSafely(java.math.BigDecimal item, Description mismatchDescription)`
    `void` | IsCloseTo.`describeMismatchSafely(java.lang.Double item, Description mismatchDescription)`
    `void` | OrderingComparison.`describeMismatchSafely(T actual, Description mismatchDescription)`
    `void` | IsCloseTo.`describeTo(Description description)`
    `void` | OrderingComparison.`describeTo(Description description)`
    `void` | BigDecimalCloseTo.`describeTo(Description description)`

  - ### Uses of Description in org.hamcrest.object

    Methods in org.hamcrest.object with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | IsCompatibleType.`describeMismatchSafely(java.lang.Class<?> cls, Description mismatchDescription)`
    `void` | IsCompatibleType.`describeTo(Description description)`
    `void` | IsEventFrom.`describeTo(Description description)`
    `boolean` | IsEventFrom.`matchesSafely(java.util.EventObject item, Description mismatchDescription)`

  - ### Uses of Description in org.hamcrest.text

    Methods in org.hamcrest.text with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | StringContainsInOrder.`describeMismatchSafely(java.lang.String item, Description mismatchDescription)`
    `void` | IsEqualIgnoringCase.`describeMismatchSafely(java.lang.String item, Description mismatchDescription)`
    `void` | IsEqualIgnoringWhiteSpace.`describeMismatchSafely(java.lang.String item, Description mismatchDescription)`
    `void` | StringContainsInOrder.`describeTo(Description description)`
    `void` | IsEmptyString.`describeTo(Description description)`
    `void` | IsEqualIgnoringCase.`describeTo(Description description)`
    `void` | IsEqualIgnoringWhiteSpace.`describeTo(Description description)`

  - ### Uses of Description in org.hamcrest.xml

    Methods in org.hamcrest.xml with parameters of type Description
    Modifier and Type | Method and Description
    --- | ---
    `void` | HasXPath.`describeTo(Description description)`
    `boolean` | HasXPath.`matchesSafely(org.w3c.dom.Node item, Description mismatch)`