Package org.languagetool.remote

Class CheckConfigurationBuilder

java.lang.Object

org.languagetool.remote.CheckConfigurationBuilder

public class CheckConfigurationBuilder
extends java.lang.Object

Builder for a CheckConfiguration.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	autoDetectLanguage
private java.util.List<java.lang.String>	disabledRuleIds
private boolean	enabledOnly
private java.util.List<java.lang.String>	enabledRuleIds
private java.lang.String	langCode
private java.lang.String	mode
private java.lang.String	motherTongueLangCode
private java.util.List<java.lang.String>	ruleValues

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

langCode

private final java.lang.String langCode

motherTongueLangCode

private java.lang.String motherTongueLangCode

autoDetectLanguage

private boolean autoDetectLanguage

enabledOnly

private boolean enabledOnly

enabledRuleIds

private java.util.List<java.lang.String> enabledRuleIds

disabledRuleIds

private java.util.List<java.lang.String> disabledRuleIds

mode

private java.lang.String mode

ruleValues

private java.util.List<java.lang.String> ruleValues

Constructor Detail

CheckConfigurationBuilder

public CheckConfigurationBuilder(java.lang.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 Detail

build

public CheckConfiguration build()

setMotherTongueLangCode

public CheckConfigurationBuilder setMotherTongueLangCode(java.lang.String motherTongueLangCode)

enabledRuleIds

public CheckConfigurationBuilder enabledRuleIds(java.util.List<java.lang.String> ruleIds)

enabledRuleIds

public CheckConfigurationBuilder enabledRuleIds(java.lang.String... ruleIds)

enabledOnly

public CheckConfigurationBuilder enabledOnly()

disabledRuleIds

public CheckConfigurationBuilder disabledRuleIds(java.util.List<java.lang.String> ruleIds)

disabledRuleIds

public CheckConfigurationBuilder disabledRuleIds(java.lang.String... ruleIds)

mode

public CheckConfigurationBuilder mode(java.lang.String mode)

ruleValues

public CheckConfigurationBuilder ruleValues(java.util.List<java.lang.String> ruleValues)