OSDN Git Service

a8d01e3e390b87aaf74b4540f6726fd55a86d888
[neighbornote/NeighborNote.git] / src / com / swabunga / spell / event / WordFinder.java
1 /*\r
2 Jazzy - a Java library for Spell Checking\r
3 Copyright (C) 2001 Mindaugas Idzelis\r
4 Full text of license can be found in LICENSE.txt\r
5 \r
6 This library is free software; you can redistribute it and/or\r
7 modify it under the terms of the GNU Lesser General Public\r
8 License as published by the Free Software Foundation; either\r
9 version 2.1 of the License, or (at your option) any later version.\r
10 \r
11 This library is distributed in the hope that it will be useful,\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
14 Lesser General Public License for more details.\r
15 \r
16 You should have received a copy of the GNU Lesser General Public\r
17 License along with this library; if not, write to the Free Software\r
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA\r
19 */\r
20 package com.swabunga.spell.event;\r
21 \r
22 /**\r
23  * <p>An interface for objects which take a String as input, and iterates through\r
24  * the words in the string.\r
25  * </P>\r
26  *\r
27  * <P>\r
28  * When the object is instantiated, and before the first call to <CODE>next()</CODE> is made,\r
29  * the following methods should throw a <CODE>WordNotFoundException</CODE>:<br>\r
30  * <CODE>current()</CODE>,\r
31  *  <CODE>startsSentence()</CODE> and <CODE>replace()</CODE>.\r
32  * </P>\r
33  *\r
34  * <P>A call to <CODE>next()</CODE> when <CODE>hasMoreWords()</CODE> returns false\r
35  * should throw a <CODE>WordNotFoundException</CODE>.</P>\r
36  * @author Jason Height (jheight@chariot.net.au)\r
37  */\r
38 \r
39 public interface WordFinder {\r
40 \r
41   //~ Methods .................................................................\r
42 \r
43   /**\r
44    * This method returns the text through which the WordFinder is iterating.\r
45    * The text may have been modified through calls to replace().\r
46    *\r
47    * @return the (possibly modified) text being searched.\r
48    */\r
49   public String getText();\r
50 \r
51   /**\r
52    * This method resets the text through which the WordFinder iterates.\r
53    * It must also re-initialize the WordFinder.\r
54    *\r
55    * @param newText the new text to search.\r
56    */\r
57   public void setText(String newText);\r
58 \r
59   /**\r
60    * This method should return the  Word object representing the current word\r
61    * in the iteration.\r
62    * This method should not affect the state of the  WordFinder object.\r
63    *\r
64    * @return the current Word object.\r
65    * @throws WordNotFoundException current word has not yet been set.\r
66    */\r
67   public Word current();\r
68 \r
69   /**\r
70    * Tests the finder to see if any more words are available.\r
71    *\r
72    * @return true if more words are available.\r
73    */\r
74   public boolean hasNext();\r
75 \r
76   /**\r
77    * This method should return the  Word object representing the next word\r
78    * in the iteration (the first word if next() has not yet been called.)\r
79    *\r
80    * @return the next Word in the iteration.\r
81    * @throws WordNotFoundException search string contains no more words.\r
82    */\r
83   public Word next();\r
84 \r
85   /**\r
86    * This method should replace the current Word object with a Word object\r
87    * representing the String newWord.\r
88    *\r
89    * @param newWord the word to replace the current word with.\r
90    * @throws WordNotFoundException current word has not yet been set.\r
91    */\r
92   public void replace(String newWord);\r
93 \r
94   /**\r
95    * Indicates if the current word starts a new sentence.\r
96    * @return true if the current word starts a new sentence.\r
97    * @throws WordNotFoundException current word has not yet been set.\r
98    */\r
99   public boolean startsSentence();\r
100 \r
101   // public void setText();\r
102 }\r