org.apache.felix.examples.spellcheckservice
Interface SpellCheckService


public interface SpellCheckService

A simple service interface that defines a spell check service. A spell check service checks the spelling of all words in a given passage. A passage is any number of words separated by a space character and the following punctuation marks: comma, period, exclamation mark, question mark, semi-colon, and colon.

Author:
Felix Project Team

Method Summary
 java.lang.String[] check(java.lang.String passage)
          Checks a given passage for spelling errors.
 

Method Detail

check

java.lang.String[] check(java.lang.String passage)
Checks a given passage for spelling errors. A passage is any number of words separated by a space and any of the following punctuation marks: comma (,), period (.), exclamation mark (!), question mark (?), semi-colon (;), and colon(:).

Parameters:
passage - the passage to spell check.
Returns:
An array of misspelled words or null if no words are misspelled.