Package org.languagetool

Enum Class RemoteRuleFallbackManager

java.lang.Object

java.lang.Enum<RemoteRuleFallbackManager>

org.languagetool.RemoteRuleFallbackManager

All Implemented Interfaces:

Serializable, Comparable<RemoteRuleFallbackManager>, Constable

public enum RemoteRuleFallbackManager
extends Enum<RemoteRuleFallbackManager>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,RemoteRuleConfig>	fallbackConfigs
private final AtomicBoolean	initCalled

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RemoteRuleFallbackManager()

Method Summary

Modifier and Type	Method	Description
RemoteRuleConfig	getInhouseFallback(String ruleId)
void	init(File remoteRuleConfigFile)	Initialize RemoteRuleFallbackManager from remoteRuleConfigFile, can only been called once
void	init_for_tests_only(List<RemoteRuleConfig> config)	This method is only for internal tests and must not been called from production code
String	isRuleOrFallbackAvailable(RemoteRule rule, Map<String,RemoteRule> remoteRules)	Check the current status of the circuitBreaker of a remoteRule, and get the fallback option if not available
private String	isRuleOrFallbackAvailable(RemoteRule rule, Map<String,RemoteRule> remoteRules, Set<String> visited)
private void	setup(List<RemoteRuleConfig> finalConfig)
static RemoteRuleFallbackManager	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RemoteRuleFallbackManager[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final RemoteRuleFallbackManager INSTANCE

Field Details

initCalled

private final AtomicBoolean initCalled

fallbackConfigs

private final Map<String,RemoteRuleConfig> fallbackConfigs

Constructor Details

RemoteRuleFallbackManager

private RemoteRuleFallbackManager()

Method Details

values

public static RemoteRuleFallbackManager[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RemoteRuleFallbackManager valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

init

public void init(@NotNull
 File remoteRuleConfigFile)

Initialize RemoteRuleFallbackManager from remoteRuleConfigFile, can only been called once

Parameters:

remoteRuleConfigFile -

init_for_tests_only

@TestOnly
public void init_for_tests_only(@NotNull
 List<RemoteRuleConfig> config)

This method is only for internal tests and must not been called from production code

Parameters:

config -

setup

private void setup(@NotNull
 List<RemoteRuleConfig> finalConfig)

getInhouseFallback

@Nullable
public RemoteRuleConfig getInhouseFallback(@NotNull
 String ruleId)

Parameters:

ruleId - a remote RuleId

Returns:

the RemoteRuleConfig for the given RuleId

isRuleOrFallbackAvailable

@Nullable
public String isRuleOrFallbackAvailable(@NotNull
 RemoteRule rule,
 @NotNull
 Map<String,RemoteRule> remoteRules)

Check the current status of the circuitBreaker of a remoteRule, and get the fallback option if not available

Parameters:

rule -

remoteRules -

Returns:

A RuleId: 1. Same RuleID as rule.getId() -> The rule is available 2. Other RuleID as rule.getId() -> The rule is not available, and you get the fallbackID 3. Null -> The rule is not available and has no available fallbacks

isRuleOrFallbackAvailable

@Nullable
private String isRuleOrFallbackAvailable(@NotNull
 RemoteRule rule,
 @NotNull
 Map<String,RemoteRule> remoteRules,
 Set<String> visited)