com.jspell.domain
Class Suggestions

java.lang.Object
  extended by com.jspell.domain.Suggestions

public class Suggestions
extends java.lang.Object

This class is used to encapsulate an array of Strings representing the suggestions returned by the spell checker.


Constructor Summary
Suggestions(int count)
          Creates a new instance of Suggestions with an internal String array size of 'count'.
 
Method Summary
 void clear()
          Clear the contents of the internal String array.
 void clear(int count)
          Initialize an empty String array of size 'count'.
 int getCount()
          Returns the size of the suggestions String array.
 java.lang.String[] getSuggestions()
          Return a String array of the suggestions.
 void setSuggestions(java.lang.String[] suggestions)
          Update the suggestions String array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Suggestions

public Suggestions(int count)
Creates a new instance of Suggestions with an internal String array size of 'count'.

Parameters:
count - an int.
Method Detail

clear

public void clear()
Clear the contents of the internal String array.


clear

public void clear(int count)
Initialize an empty String array of size 'count'.

Parameters:
count - an int.

getSuggestions

public java.lang.String[] getSuggestions()
Return a String array of the suggestions.

Returns:
a String array.

setSuggestions

public void setSuggestions(java.lang.String[] suggestions)
Update the suggestions String array.

Parameters:
suggestions - a String array.

getCount

public int getCount()
Returns the size of the suggestions String array.

Returns:
an int.


JSpell SDK - Spell Checker for the Java ™ Platform
Copyright © 2009 Page Scholar Inc, All Rights Reserved - http://www.jspell.com