lucene-java-3.5.0/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/spell/Dictionary.java

   1 package org.apache.lucene.search.spell;
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one or more
   4  * contributor license agreements.  See the NOTICE file distributed with
   5  * this work for additional information regarding copyright ownership.
   6  * The ASF licenses this file to You under the Apache License, Version 2.0
   7  * (the "License"); you may not use this file except in compliance with
   8  * the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import java.util.Iterator;
  20
  21 /**
  22  * A simple interface representing a Dictionary. A Dictionary
  23  * here is just a list of words.
  24  *
  25  *
  26  * @version 1.0
  27  */
  28 public interface Dictionary {
  29
  30   /**
  31    * Return all words present in the dictionary
  32    * @return Iterator
  33    */
  34   Iterator<String> getWordsIterator();
  35 }