/**
 * <p>
 * Copyright © 2009-2010, Bruce-Robert Pocock
 * </p>
 * <p>
 * Based upon public domain sample code provided by Authorize.net
 * </p>
 * <p>
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 * </p>
 * <p>
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * </p>
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * </p>
 * 
 * @author brpocock
 */

package org.starhope.appius.messaging;

import org.starhope.appius.sys.op.FilterResult;

/**
 * 
 * TODO: The documentation for this type (AbstractCensor) is incomplete.
 * (brpocock, Nov 19, 2009)
 * 
 * @author brpocock
 * 
 */
public interface AbstractCensor {

	/**
	 * 
	 * TODO: document this method (brpocock, Oct 13, 2009)
	 * 
	 * @param token WRITEME
	 * @return WRITEME
	 */
	public abstract FilterResult checkLists (final String token);

	/**
	 * Filter the message.
	 * 
	 * @param text WRITEME
	 * @return true if message should be filtered.
	 */
	public abstract FilterResult filterMessage (final String text);

	/**
	 * 
	 * TODO: document this method (brpocock, Oct 13, 2009)
	 * 
	 * @return WRITEME
	 */
	public abstract int getWhiteListLength ();


}