/*
 * WordStream.java
 *
 * Copyright (C) 2005 Crutcher Dunnavant <crutcher@gmail.com>
 *
 * 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 2 of the License, or
 * (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
public interface WordStream {
	/**
	 * Returns the WordStream title.
	 */
	public String getWordStreamTitle();

	/**
	 * Returns the WordStream size.
	 * Not required to be constant, but required to be
	 * monotonically increasing.
	 */
	public int getWordStreamSize();

	/**
	 * Returns the word at idx.
	 * The first word is at 0.
	 */
	public String getWordStreamWord(int idx);

	/**
	 * Sets the WordStream watcher.
	 * setWatcher(null) unsets the watcher.
	 */
	public void setWatcher(WordStreamWatcher watcher);
}