/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.jsdt.internal.ui.text.spelling.engine;
import java.util.Iterator;
/**
* Interface for iterators used for spell checking.
*
*
*/
public interface ISpellCheckIterator extends Iterator {
/**
* Returns the begin index (inclusive) of the current word.
*
* @return The begin index of the current word
*/
public int getBegin();
/**
* Returns the end index (exclusive) of the current word.
*
* @return The end index of the current word
*/
public int getEnd();
/**
* Does the current word start a new sentence?
*
* @return <code>true<code> iff the current word starts a new sentence, <code>false</code> otherwise
*/
public boolean startsSentence();
/**
* Tells whether to ignore single letters
* from being checked.
*
*
* @param state <code>true</code> if single letters should be ignored
*/
public void setIgnoreSingleLetters(boolean state);
}