ca.odell.glazedlists.matchers.Matcher Maven / Gradle / Ivy

/* Glazed Lists                                                 (c) 2003-2006 */
/* http://publicobject.com/glazedlists/                      publicobject.com,*/
/*                                                     O'Dell Engineering Ltd.*/
package ca.odell.glazedlists.matchers;

/**
 * Determines which values should be filtered.
 *
 * For best safety, implementations of {@link Matcher} should be
 * immutable. This
 * guarantees that {@link ca.odell.glazedlists.FilterList}s can safely call
 * {@link #matches(Object) matches()} without synchronization.
 *
 * In order to create dynamic filtering, use a
 * {@link ca.odell.glazedlists.matchers.MatcherEditor}, which
 * can create immutable {@link Matcher} Objects each time the matching constraints
 * change.
 *
 * @author Rob Eden
 * @see ca.odell.glazedlists.FilterList
 * @see ca.odell.glazedlists.matchers.MatcherEditor
 */
public interface Matcher {

    /**
     * Return true if an item matches a filter.
     *
     * @param item The item possibly being filtered.
     */
    public boolean matches(E item);
}