Class CheckConfigurationBuilder

java.lang.Object

org.languagetool.remote.CheckConfigurationBuilder

public class CheckConfigurationBuilder
extends Object

Builder for a CheckConfiguration.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	autoDetectLanguage
private List<String>	disabledRuleIds
private boolean	enabledOnly
private List<String>	enabledRuleIds
private final String	langCode
private String	mode
private String	motherTongueLangCode
private List<String>	ruleValues

Constructor Summary

Constructors

Constructor	Description
CheckConfigurationBuilder()	A configuration that causes the server to automatically detected the text language.
CheckConfigurationBuilder(String langCode)

Method Summary

Modifier and Type	Method	Description
CheckConfiguration	build()
CheckConfigurationBuilder	disabledRuleIds(String... ruleIds)
CheckConfigurationBuilder	disabledRuleIds(List<String> ruleIds)
CheckConfigurationBuilder	enabledOnly()
CheckConfigurationBuilder	enabledRuleIds(String... ruleIds)
CheckConfigurationBuilder	enabledRuleIds(List<String> ruleIds)
CheckConfigurationBuilder	mode(String mode)
CheckConfigurationBuilder	ruleValues(List<String> ruleValues)
CheckConfigurationBuilder	setMotherTongueLangCode(String motherTongueLangCode)

Methods inherited from class Object

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

Field Details

langCode

private final String langCode

motherTongueLangCode

private String motherTongueLangCode

autoDetectLanguage

private boolean autoDetectLanguage

enabledOnly

private boolean enabledOnly

enabledRuleIds

private List<String> enabledRuleIds

disabledRuleIds

private List<String> disabledRuleIds

mode

private String mode

ruleValues

private List<String> ruleValues

Constructor Details

CheckConfigurationBuilder

public CheckConfigurationBuilder(String langCode)

Parameters:

langCode - a language code like en or en-US

CheckConfigurationBuilder

public CheckConfigurationBuilder()

A configuration that causes the server to automatically detected the text language. Note that this requires at least a few sentences of text to work reliably.

Method Details

build

public CheckConfiguration build()

setMotherTongueLangCode

public CheckConfigurationBuilder setMotherTongueLangCode(String motherTongueLangCode)

enabledRuleIds

public CheckConfigurationBuilder enabledRuleIds(List<String> ruleIds)

enabledRuleIds

public CheckConfigurationBuilder enabledRuleIds(String... ruleIds)

enabledOnly

public CheckConfigurationBuilder enabledOnly()

disabledRuleIds

public CheckConfigurationBuilder disabledRuleIds(List<String> ruleIds)

disabledRuleIds

public CheckConfigurationBuilder disabledRuleIds(String... ruleIds)

mode

public CheckConfigurationBuilder mode(String mode)

ruleValues

public CheckConfigurationBuilder ruleValues(List<String> ruleValues)