Package com.inet.jortho
Class Suggestion
- java.lang.Object
-
- com.inet.jortho.Suggestion
-
- All Implemented Interfaces:
java.lang.Comparable<Suggestion>
final class Suggestion extends java.lang.Object implements java.lang.Comparable<Suggestion>
This class hold one Suggestion for another spelling. Note: this class has a natural ordering that is inconsistent with equals.
-
-
Constructor Summary
Constructors Constructor Description Suggestion(java.lang.CharSequence word, int diff)
Construct a suggestion
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Suggestion sugg)
boolean
equals(java.lang.Object sugg)
int
getDissimilarity()
Return a value that descript dissimilarity to the original word.java.lang.String
getWord()
Get the suggested word.int
hashCode()
java.lang.String
toString()
Return the suggested word and it equals to getWord().
-
-
-
Method Detail
-
toString
public java.lang.String toString()
Return the suggested word and it equals to getWord().- Overrides:
toString
in classjava.lang.Object
-
getWord
public java.lang.String getWord()
Get the suggested word.- Returns:
- the word
-
getDissimilarity
public int getDissimilarity()
Return a value that descript dissimilarity to the original word. A vaulue of 0 means that the value is 100% identical. This should not occur.- Returns:
- the dissimilarity, so larger to differ the word.
-
equals
public boolean equals(java.lang.Object sugg)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
compareTo
public int compareTo(Suggestion sugg)
- Specified by:
compareTo
in interfacejava.lang.Comparable<Suggestion>
-
-