KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > mail > spellcheck > cswilly > Engine


1 /*
2  * $Revision: 1.1 $
3  * $Date: 2006/06/10 13:32:32 $
4  * $Author: fdietz $
5  *
6  * Copyright (C) 2001 C. Scott Willy
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21  */
22 package org.columba.mail.spellcheck.cswilly;
23
24 import java.util.List JavaDoc;
25
26
27 /**
28  * Models a spelling checking engine
29  *<p>
30  *
31  */
32 public interface Engine {
33     /**
34  * Spell check a list of words
35  *<p>
36  * Spell checks the list of works in <code>words</code> and returns a list of
37  * {@link Result}s. There is one {@link Result} for each word in
38  * <code>words</code>.
39  *<p>
40  * @param words {@link String} with list of works to be spell checked.
41  * @return List of {@link Result}
42  */
43     public List JavaDoc checkLine(String JavaDoc line) throws SpellException;
44
45     // to be defined
46 //public void addWord( String word );
47 }
48
Popular Tags