| /******************************************************************************* |
| * Copyright (c) 2000, 2005 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.jdt.internal.ui.text.spelling.engine; |
| |
| import java.util.Iterator; |
| |
| /** |
| * Interface for iterators used for spell-checking. |
| * |
| * @since 3.0 |
| */ |
| 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(); |
| } |