RemoteRuleConfig (LanguageTool 6.4-SNAPSHOT API)

java.lang.Object
- org.languagetool.rules.RemoteRuleConfig

public class RemoteRuleConfig
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`baseTimeoutMilliseconds`
`long`	`downMilliseconds`
`float`	`failureRateThreshold`
`String`	`language`
`int`	`minimumNumberOfCalls`
`Map<String,String>`	`options`
`Integer`	`port`
`String`	`ruleId`
`int`	`slidingWindowSize`
`String`	`slidingWindowType`
`float`	`timeoutPerCharacterMilliseconds`
`String`	`type`
`String`	`url`

Constructor Summary

Constructors
Constructor and Description

RemoteRuleConfig()

RemoteRuleConfig(RemoteRuleConfig copy)

Constructors
Constructor and Description
`RemoteRuleConfig()`
`RemoteRuleConfig(RemoteRuleConfig copy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`long`	`getBaseTimeoutMilliseconds()`
`long`	`getDownMilliseconds()`
`float`	`getFailureRateThreshold()`
`String`	`getLanguage()` Regex to match language codes for which this rule should be applied
`int`	`getMinimumNumberOfCalls()`
`Map<String,String>`	`getOptions()` miscellaneous options for remote rules allows implementing additional behavior in subclasses some options defined in `RemoteRule`: fixOffsets: boolean - adjust offsets of matches because of discrepancies in string length for some unicode characters between Java and Python filterMatches: boolean - enable anti-patterns from remote-rule-filters.xml suppressMisspelledMatch: regex - filter out matches with matching rule IDs that have misspelled suggestions suppressMisspelledSuggestions: regex - filter out misspelled suggestions from matches with matching rule IDs
`int`	`getPort()`
`static RemoteRuleConfig`	`getRelevantConfig(String rule, List<RemoteRuleConfig> configs)`
`String`	`getRuleId()`
`int`	`getSlidingWindowSize()`
`String`	`getSlidingWindowType()`
`float`	`getTimeoutPerCharacterMilliseconds()`
`String`	`getType()` Identifier for the implementation of RemoteRule that this configuration is meant for
`String`	`getUrl()`
`int`	`hashCode()`
`static Predicate<RemoteRuleConfig>`	`isRelevantConfig(String type, Language language)`
`static List<RemoteRuleConfig>`	`load(File configFile)`
`static List<RemoteRuleConfig>`	`parse(InputStream json)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ruleId
```
public String ruleId
```

url
```
public String url
```

port
```
public Integer port
```

baseTimeoutMilliseconds
```
public long baseTimeoutMilliseconds
```

timeoutPerCharacterMilliseconds

public float timeoutPerCharacterMilliseconds

downMilliseconds
```
public long downMilliseconds
```

failureRateThreshold
```
public float failureRateThreshold
```

slidingWindowType
```
public String slidingWindowType
```

slidingWindowSize
```
public int slidingWindowSize
```

minimumNumberOfCalls
```
public int minimumNumberOfCalls
```

options
```
public Map<String,String> options
```

language
```
public String language
```

type
```
public String type
```

Constructor Detail

RemoteRuleConfig
```
public RemoteRuleConfig()
```

RemoteRuleConfig

public RemoteRuleConfig(RemoteRuleConfig copy)

Method Detail

getRelevantConfig

public static RemoteRuleConfig getRelevantConfig(String rule,
                                                 List<RemoteRuleConfig> configs)

isRelevantConfig

public static Predicate<RemoteRuleConfig> isRelevantConfig(String type,
                                                           Language language)

parse

public static List<RemoteRuleConfig> parse(InputStream json)
                                    throws IOException

Throws:: IOException

load

public static List<RemoteRuleConfig> load(File configFile)
                                   throws ExecutionException

Throws:: ExecutionException

getFailureRateThreshold

public float getFailureRateThreshold()

getSlidingWindowType
```
public String getSlidingWindowType()
```

getSlidingWindowSize
```
public int getSlidingWindowSize()
```

getRuleId
```
public String getRuleId()
```

getUrl
```
public String getUrl()
```

getPort
```
public int getPort()
```

getDownMilliseconds
```
public long getDownMilliseconds()
```

getBaseTimeoutMilliseconds

public long getBaseTimeoutMilliseconds()

getTimeoutPerCharacterMilliseconds

public float getTimeoutPerCharacterMilliseconds()

getMinimumNumberOfCalls
```
public int getMinimumNumberOfCalls()
```

getOptions
```
public Map<String,String> getOptions()
```
miscellaneous options for remote rules allows implementing additional behavior in subclasses some options defined in RemoteRule: fixOffsets: boolean - adjust offsets of matches because of discrepancies in string length for some unicode characters between Java and Python filterMatches: boolean - enable anti-patterns from remote-rule-filters.xml suppressMisspelledMatch: regex - filter out matches with matching rule IDs that have misspelled suggestions suppressMisspelledSuggestions: regex - filter out misspelled suggestions from matches with matching rule IDs

getLanguage
```
public String getLanguage()
```
Regex to match language codes for which this rule should be applied

getType
```
public String getType()
```
Identifier for the implementation of RemoteRule that this configuration is meant for

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class RemoteRuleConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ruleId

url

port

baseTimeoutMilliseconds

timeoutPerCharacterMilliseconds

downMilliseconds

failureRateThreshold

slidingWindowType

slidingWindowSize

minimumNumberOfCalls

options

language

type

Constructor Detail

RemoteRuleConfig

RemoteRuleConfig

Method Detail

getRelevantConfig

isRelevantConfig

parse

load

getFailureRateThreshold

getSlidingWindowType

getSlidingWindowSize

getRuleId

getUrl

getPort

getDownMilliseconds

getBaseTimeoutMilliseconds

getTimeoutPerCharacterMilliseconds

getMinimumNumberOfCalls

getOptions

getLanguage

getType

equals

hashCode

toString