org.hamcrest.Description Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hamcrest-all

A self-contained hamcrest jar containing all of the sub-modules in a single artifact.

There is a newer version: 1.3

package org.hamcrest;

/**
 * A description of a Matcher. A Matcher will describe itself to a description which can later be used for reporting.
 *
 * @see Matcher#describeTo(Description)
 */
public interface Description {

    /**
     * Appends some plain text to the description.
     */
    Description appendText(String text);
    
    /**
     * Appends an arbitary value to the description.
     */
    Description appendValue(Object value);
    
    /**
     * Appends a list of values to the description.
     */
     Description appendValueList(String start, String separator, String end,
    							    T... values);

    /**
     * Appends a list of values to the description.
     */
     Description appendValueList(String start, String separator, String end,
    							    Iterable values);
    
    /** 
     * Appends a list of {@link org.hamcrest.SelfDescribing} objects
     * to the description. 
     */
    Description appendList(String start, String separator, String end, 
                           Iterable values);
}