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 in our wiki.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field	Description
private final com.fasterxml.jackson.databind.ObjectMapper	mapper
private final URL	serverBaseUrl
private static final String	V2_CHECK
private static final String	V2_CONFIGINFO
private static final String	V2_MAXTEXTLENGTH

Constructor Summary

Constructors

Constructor	Description
RemoteLanguageTool(URL serverBaseUrl)

Method Summary

Modifier and Type	Method	Description
private void	append(StringBuilder params, String paramName, String paramValue)
private RemoteResult	check(String urlParameters)
RemoteResult	check(String text, String langCode)
RemoteResult	check(String text, CheckConfiguration config)
private String	encode(String text)
RemoteConfigurationInfo	getConfigurationInfo(String urlParameters)
(package private) HttpURLConnection	getConnection(byte[] postData, URL url)
private RemoteRuleMatch	getMatch(Map<String,Object> match)
int	getMaxTextLength()
private String	getOrNull(Map<String,Object> elem, String propertyName)
private Object	getRequired(Map<String,Object> elem, String propertyName)
private String	getRequiredString(Map<String,Object> elem, String propertyName)
private String	getUrlParams(String text, CheckConfiguration config)
private List<String>	getValueList(Map<String,Object> match, String propertyName)
private RemoteResult	parseJson(InputStream inputStream)
private String	readStream(InputStream stream, String encoding)

Methods inherited from class Object

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

Field Details

V2_CHECK

private static final String V2_CHECK

See Also:

• Constant Field Values

V2_MAXTEXTLENGTH

private static final String V2_MAXTEXTLENGTH

See Also:

• Constant Field Values

V2_CONFIGINFO

private static final String V2_CONFIGINFO

See Also:

• Constant Field Values

mapper

private final com.fasterxml.jackson.databind.ObjectMapper mapper

serverBaseUrl

private final URL serverBaseUrl

Constructor Details

RemoteLanguageTool

public RemoteLanguageTool(URL serverBaseUrl)

Parameters:

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

Method Details

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,
 CheckConfiguration config)

Parameters:

text - the text to be checked

getUrlParams

private String getUrlParams(String text,
 CheckConfiguration config)

append

private void append(StringBuilder params,
 String paramName,
 String paramValue)

encode

private String encode(String text)

check

private RemoteResult check(String urlParameters)

getConfigurationInfo

public RemoteConfigurationInfo getConfigurationInfo(String urlParameters)

getMaxTextLength

public int getMaxTextLength()

getConnection

HttpURLConnection getConnection(byte[] postData,
 URL url)

readStream

private String readStream(InputStream stream,
 String encoding)
                   throws IOException

Throws:

IOException

parseJson

private RemoteResult parseJson(InputStream inputStream)
                        throws XMLStreamException,
IOException

Throws:

XMLStreamException

IOException

getMatch

private RemoteRuleMatch getMatch(Map<String,Object> match)

getRequired

private Object getRequired(Map<String,Object> elem,
 String propertyName)

getRequiredString

private String getRequiredString(Map<String,Object> elem,
 String propertyName)

getOrNull

private String getOrNull(Map<String,Object> elem,
 String propertyName)

getValueList

private List<String> getValueList(Map<String,Object> match,
 String propertyName)