org.languagetool.commandline

Class CommandLineOptions

java.lang.Object

org.languagetool.commandline.CommandLineOptions

public class CommandLineOptions
extends Object

Options that can be set via command line arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandLineOptions.OutputFormat Constants for rule matches output in command-line.

Constructor Summary

Constructors

Constructor and Description
CommandLineOptions()

Method Summary

Modifier and Type	Method and Description
String	getBitextRuleFile()
Set<CategoryId>	getDisabledCategories()
List<String>	getDisabledRules()
Set<CategoryId>	getEnabledCategories()
List<String>	getEnabledRules()
String	getEncoding()
String	getFalseFriendFile()
File	getFasttextBinary()
File	getFasttextModel()
String	getFilename()
Language	getLanguage()
File	getLanguageModel()
JLanguageTool.Level	getLevel()
Language	getMotherTongue()
String	getRemoteRulesFile()
String	getRuleFile()
boolean	isApplySuggestions()
boolean	isAutoDetect()
boolean	isBitext()
boolean	isCleanOverlapping()
boolean	isEnableTempOff()
boolean	isJsonFormat()
boolean	isLineByLine()
boolean	isListUnknown()
boolean	isPrintLanguages()
boolean	isPrintUsage()
boolean	isPrintVersion()
boolean	isProfile()
boolean	isRecursive()
boolean	isSingleLineBreakMarksParagraph()
boolean	isTaggerOnly()
boolean	isUseEnabledOnly()
boolean	isVerbose()
boolean	isXmlFiltering()
void	setApplySuggestions(boolean applySuggestions)
void	setAutoDetect(boolean autoDetect)
void	setBitext(boolean bitext)
void	setBitextRuleFile(String bitextRuleFile)
void	setCleanOverlapping(boolean cleanOverlapping)
void	setDisabledCategories(List<String> categoryIds)
void	setDisabledRules(List<String> disabledRules)
void	setEnabledCategories(List<String> categoryIds)
void	setEnabledRules(List<String> enabledRules)
void	setEnableTempOff(boolean enableTempOff)
void	setEncoding(String encoding)
void	setFalseFriendFile(String file)
void	setFasttextBinary(File fasttextBinary)
void	setFasttextModel(File fasttextModel)
void	setFilename(String filename)
void	setJsonFormat()
void	setLanguage(Language language)
void	setLanguageModel(File languageModel)
void	setLevel(JLanguageTool.Level level)
void	setLineByLine(boolean lineByLine)
void	setListUnknown(boolean listUnknown)
void	setMotherTongue(Language motherTongue)
void	setPrintLanguages(boolean printLanguages)
void	setPrintUsage(boolean printUsage)
void	setPrintVersion(boolean printVersion)
void	setProfile(boolean profile)
void	setRecursive(boolean recursive)
void	setRemoteRulesFile(String remoteRulesFile)
void	setRuleFile(String ruleFile)
void	setSingleLineBreakMarksParagraph(boolean singleLineBreakMarksParagraph)
void	setTaggerOnly(boolean taggerOnly)
void	setUseEnabledOnly()
void	setVerbose(boolean verbose)
void	setXmlFiltering(boolean xmlFiltering)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineOptions

public CommandLineOptions()

Method Detail

isPrintUsage

public boolean isPrintUsage()

setPrintUsage

public void setPrintUsage(boolean printUsage)

isPrintVersion

public boolean isPrintVersion()

setPrintVersion

public void setPrintVersion(boolean printVersion)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

isLineByLine

public boolean isLineByLine()

setLineByLine

public void setLineByLine(boolean lineByLine)

isEnableTempOff

public boolean isEnableTempOff()

setEnableTempOff

public void setEnableTempOff(boolean enableTempOff)

isCleanOverlapping

public boolean isCleanOverlapping()

Since:

6.1

setCleanOverlapping

public void setCleanOverlapping(boolean cleanOverlapping)

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

isTaggerOnly

public boolean isTaggerOnly()

setTaggerOnly

public void setTaggerOnly(boolean taggerOnly)

isSingleLineBreakMarksParagraph

public boolean isSingleLineBreakMarksParagraph()

setSingleLineBreakMarksParagraph

public void setSingleLineBreakMarksParagraph(boolean singleLineBreakMarksParagraph)

isJsonFormat

public boolean isJsonFormat()

Since:

3.6

setJsonFormat

public void setJsonFormat()

Since:

3.6

isListUnknown

public boolean isListUnknown()

setListUnknown

public void setListUnknown(boolean listUnknown)

isApplySuggestions

public boolean isApplySuggestions()

setApplySuggestions

public void setApplySuggestions(boolean applySuggestions)

isProfile

public boolean isProfile()

setProfile

public void setProfile(boolean profile)

isBitext

public boolean isBitext()

setBitext

public void setBitext(boolean bitext)

isAutoDetect

public boolean isAutoDetect()

setAutoDetect

public void setAutoDetect(boolean autoDetect)

getLanguage

@Nullable
public Language getLanguage()

setLanguage

public void setLanguage(Language language)

getMotherTongue

@Nullable
public Language getMotherTongue()

setMotherTongue

public void setMotherTongue(Language motherTongue)

getLanguageModel

@Nullable
public File getLanguageModel()

Returns:

a directory with Lucene index sub directories like (3grams), or null

Since:

2.7

setLanguageModel

public void setLanguageModel(File languageModel)

Since:

2.7

getFasttextModel

@Nullable
public File getFasttextModel()

Since:

4.3

setFasttextModel

public void setFasttextModel(File fasttextModel)

Since:

4.3

getFasttextBinary

@Nullable
public File getFasttextBinary()

Since:

4.3

setFasttextBinary

public void setFasttextBinary(File fasttextBinary)

Since:

4.3

getRuleFile

@Nullable
public String getRuleFile()

Returns:

an additional rule file name to use

Since:

2.9

setRuleFile

public void setRuleFile(String ruleFile)

Parameters:

ruleFile - absolute file name of the XML rule file

Since:

2.9

getRemoteRulesFile

@Nullable
public String getRemoteRulesFile()

Since:

4.9

setRemoteRulesFile

public void setRemoteRulesFile(String remoteRulesFile)

Since:

4.9

getEncoding

@Nullable
public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getFilename

@Nullable
public String getFilename()

setFilename

public void setFilename(String filename)

getDisabledRules

public List<String> getDisabledRules()

setDisabledRules

public void setDisabledRules(List<String> disabledRules)

getEnabledRules

public List<String> getEnabledRules()

setEnabledRules

public void setEnabledRules(List<String> enabledRules)

setEnabledCategories

public void setEnabledCategories(List<String> categoryIds)

Since:

3.3

getEnabledCategories

public Set<CategoryId> getEnabledCategories()

Since:

3.3

setDisabledCategories

public void setDisabledCategories(List<String> categoryIds)

Since:

3.3

getDisabledCategories

public Set<CategoryId> getDisabledCategories()

Since:

3.3

isUseEnabledOnly

public boolean isUseEnabledOnly()

Since:

2.9

setUseEnabledOnly

public void setUseEnabledOnly()

Since:

2.7

isXmlFiltering

public boolean isXmlFiltering()

setXmlFiltering

public void setXmlFiltering(boolean xmlFiltering)

isPrintLanguages

public boolean isPrintLanguages()

setPrintLanguages

public void setPrintLanguages(boolean printLanguages)

setFalseFriendFile

public void setFalseFriendFile(String file)

Parameters:

file - False friends filename

Since:

2.9

getFalseFriendFile

@Nullable
public String getFalseFriendFile()

Returns:

False friends file name or null

Since:

2.9

getBitextRuleFile

@Nullable
public String getBitextRuleFile()

Returns:

the bitext rule file name or null

Since:

2.9

setBitextRuleFile

public void setBitextRuleFile(String bitextRuleFile)

Parameters:

bitextRuleFile - the bitext rule file name

Since:

2.9

setLevel

public void setLevel(JLanguageTool.Level level)

Since:

5.1

getLevel

public JLanguageTool.Level getLevel()

Since:

5.1