Case Study: adding data and statistics

[ifi-stolz-refaktor.git] / case-study / jdt-after / ui / org / eclipse / jdt / internal / ui / text / spelling / engine / ISpellCheckIterator.java

diff --git a/case-study/jdt-after/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/ISpellCheckIterator.java b/case-study/jdt-after/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/ISpellCheckIterator.java
new file mode 100644 (file)
index 0000000..7d2e3e8
--- /dev/null
+++ b/case-study/jdt-after/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/ISpellCheckIterator.java
@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2011 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<String> {
+
+       /**
+        * 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.
+        *
+        * @since 3.3
+        * @param state <code>true</code> if single letters should be ignored
+        */
+       public void setIgnoreSingleLetters(boolean state);
+}