FileDocCategorySizeDatePackage
Dictionary.javaAPI DocApache Lucene 2.2.01172Sat Jun 16 22:21:02 BST 2007org.apache.lucene.search.spell

Dictionary.java

package org.apache.lucene.search.spell;
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.util.Iterator;

/**
 * A simple interface representing a Dictionary. A Dictionary
 * here is just a list of words.
 * 
 * @author Nicolas Maisonneuve
 * @version 1.0
 */
public interface Dictionary {

  /**
   * Return all words present in the dictionary
   * @return Iterator
   */
  Iterator getWordsIterator();
}