ISpellCheckIterator


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.jdt.internal.ui.text.spelling.engine;
13  
14  import java.util.Iterator  ;
15  
16  /**
17   * Interface for iterators used for spell checking.
18   *
19   * @since 3.0
20   */
21  public interface ISpellCheckIterator extends Iterator   {
22  
23      /**
24       * Returns the begin index (inclusive) of the current word.
25       *
26       * @return The begin index of the current word
27       */
28      public int getBegin();
29  
30      /**
31       * Returns the end index (exclusive) of the current word.
32       *
33       * @return The end index of the current word
34       */
35      public int getEnd();
36  
37      /**
38       * Does the current word start a new sentence?
39       *
40       * @return <code>true<code> iff the current word starts a new sentence, <code>false</code> otherwise
41       */
42      public boolean startsSentence();
43  
44      /**
45       * Tells whether to ignore single letters
46       * from being checked.
47       * 
48       * @since 3.3
49       * @param state <code>true</code> if single letters should be ignored
50       */
51      public void setIgnoreSingleLetters(boolean state);
52  }
53

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags