ca.odell.glazedlists.TextFilterator Maven / Gradle / Ivy
/* Glazed Lists (c) 2003-2006 */
/* http://publicobject.com/glazedlists/ publicobject.com,*/
/* O'Dell Engineering Ltd.*/
package ca.odell.glazedlists;
import java.util.List;
/**
* An interface through which a list of Strings for a given object
* can be extracted for testing whether a filter matches.
*
* @see Glazed Lists Tutorial
* @see GlazedLists#textFilterator(String[])
*
* @author Jesse Wilson
*/
public interface TextFilterator {
/**
* Gets the specified object as a list of Strings. These Strings
* should contain all object information so that it can be compared
* to the filter set.
*
* @param baseList a list that the implementor shall add their filter
* strings to via baseList.add()
. This may be a non-empty
* List and it is an error to call any method other than add().
* @param element the object to extract the filter strings from.
*/
public void getFilterStrings(List baseList, E element);
}