Package org.languagetool

Class ShortDescriptionProvider

java.lang.Object

org.languagetool.ShortDescriptionProvider

public class ShortDescriptionProvider
extends Object

Provide short (up to ~ 40 characters) descriptions for words. Used to display as an additional hint when there are several suggestions.

Since:

4.5

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<Language,Map<String,String>>	descriptions

Constructor Summary

Constructors

Constructor	Description
ShortDescriptionProvider()

Method Summary

Modifier and Type	Method	Description
(package private) static Map<String,String>	getAllDescriptions(Language lang)
String	getShortDescription(String word, Language lang)
private static Map<String,String>	init(Language lang)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

descriptions

private static final Map<Language,Map<String,String>> descriptions

Constructor Details

ShortDescriptionProvider

public ShortDescriptionProvider()

Method Details

getShortDescription

@Nullable
public String getShortDescription(String word,
 Language lang)

getAllDescriptions

static Map<String,String> getAllDescriptions(Language lang)

init

private static Map<String,String> init(Language lang)