Package org.languagetool.rules

Class SuggestedReplacement

java.lang.Object

org.languagetool.rules.SuggestedReplacement

public class SuggestedReplacement
extends Object

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SuggestedReplacement.SuggestionType	classify the type of the suggestion so that downstream tasks (e.g.

Field Summary

Fields

Modifier and Type	Field	Description
private Float	confidence
private SortedMap<String,Float>	features
private String	replacement
private String	shortDescription
private String	suffix
private SuggestedReplacement.SuggestionType	type

Constructor Summary

Constructors

Constructor	Description
SuggestedReplacement(String replacement)
SuggestedReplacement(String replacement, String shortDescription)
SuggestedReplacement(String replacement, String shortDescription, String suffix)
SuggestedReplacement(SuggestedReplacement repl)

Method Summary

Modifier and Type	Method	Description
static List<SuggestedReplacement>	convert(List<String> suggestions)
boolean	equals(Object o)
Float	getConfidence()
SortedMap<String,Float>	getFeatures()
String	getReplacement()
String	getShortDescription()
String	getSuffix()	Value shown in the UI after the replacement (but not part of it).
SuggestedReplacement.SuggestionType	getType()
int	hashCode()
void	setConfidence(Float confidence)
void	setFeatures(SortedMap<String,Float> features)
void	setReplacement(String replacement)
void	setShortDescription(String desc)
void	setSuffix(String val)
void	setType(SuggestedReplacement.SuggestionType type)
static List<SuggestedReplacement>	topMatch(String word)
static List<SuggestedReplacement>	topMatch(String word, String shortDesc)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

replacement

private String replacement

shortDescription

private String shortDescription

suffix

private String suffix

features

private SortedMap<String,Float> features

confidence

private Float confidence

type

private SuggestedReplacement.SuggestionType type

Constructor Details

SuggestedReplacement

public SuggestedReplacement(String replacement)

SuggestedReplacement

public SuggestedReplacement(String replacement,
 String shortDescription)

SuggestedReplacement

public SuggestedReplacement(String replacement,
 String shortDescription,
 String suffix)

SuggestedReplacement

public SuggestedReplacement(SuggestedReplacement repl)

Method Details

getReplacement

public String getReplacement()

setReplacement

public void setReplacement(String replacement)

getShortDescription

@Nullable
public String getShortDescription()

setShortDescription

public void setShortDescription(String desc)

setType

public void setType(SuggestedReplacement.SuggestionType type)

Since:

4.9

getType

@NotNull
public SuggestedReplacement.SuggestionType getType()

Since:

4.9

getSuffix

@Nullable
public String getSuffix()

Value shown in the UI after the replacement (but not part of it).

setSuffix

public void setSuffix(String val)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getConfidence

@Nullable
public Float getConfidence()

setConfidence

public void setConfidence(@Nullable
 Float confidence)

getFeatures

@NotNull
public SortedMap<String,Float> getFeatures()

setFeatures

public void setFeatures(@NotNull
 SortedMap<String,Float> features)

convert

public static List<SuggestedReplacement> convert(List<String> suggestions)

topMatch

public static List<SuggestedReplacement> topMatch(String word)

topMatch

public static List<SuggestedReplacement> topMatch(String word,
 String shortDesc)