Package org.languagetool

Class ShortDescriptionProvider

java.lang.Object

org.languagetool.ShortDescriptionProvider

public class ShortDescriptionProvider
extends Object

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

Since:

4.5

Constructor Summary

Constructors

Constructor	Description
ShortDescriptionProvider(Language lang)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getShortDescription(String word)

Methods inherited from class java.lang.Object

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

Constructor Details

ShortDescriptionProvider

public ShortDescriptionProvider(Language lang)

Method Details

getShortDescription

@Nullable
public @Nullable String getShortDescription(String word)