org.languagetool.remote

Class RemoteLanguageTool

java.lang.Object

org.languagetool.remote.RemoteLanguageTool

public class RemoteLanguageTool
extends Object

Check a text using a remote LanguageTool server via HTTP or HTTPS. Our public HTTPS API and its restrictions are documented here.

Since:

3.4

Constructor Summary

Constructors

Constructor and Description
RemoteLanguageTool(URL serverBaseUrl)

Method Summary

Modifier and Type	Method and Description
RemoteResult	check(String text, CheckConfiguration config)
RemoteResult	check(String text, CheckConfiguration config, Map<String,String> customParams)
RemoteResult	check(String text, String langCode)
RemoteResult	check(String text, String langCode, Map<String,String> customParams)
RemoteConfigurationInfo	getConfigurationInfo(String urlParameters)
int	getMaxTextLength()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteLanguageTool

public RemoteLanguageTool(URL serverBaseUrl)

Parameters:

serverBaseUrl - for example https://languagetool.org/api (not ending in slash)

Method Detail

check

public RemoteResult check(String text,
                          String langCode)

Parameters:

text - the text to be checked

langCode - the language code like en or en-US - note that for some languages (like English) you need to specify the country code (like US or GB) to get spell checking

check

public RemoteResult check(String text,
                          String langCode,
                          Map<String,String> customParams)

check

public RemoteResult check(String text,
                          CheckConfiguration config)

Parameters:

text - the text to be checked

check

public RemoteResult check(String text,
                          CheckConfiguration config,
                          Map<String,String> customParams)

getConfigurationInfo

public RemoteConfigurationInfo getConfigurationInfo(String urlParameters)

getMaxTextLength

public int getMaxTextLength()