Package cdc.issues.rules
Interface Profile
-
public interface ProfileInterface describing a Profile.It is a set of
ConfiguredRules, some of which are enabled.- Author:
- Damien Carbonne
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<ConfiguredRule>getConfiguredRules()StringgetDescription()Set<ConfiguredRule>getEnabledConfiguredRules()Set<Rule>getEnabledRules()ParamsgetMetas()StringgetName()ParamsgetParams(Rule rule)Returns the parameters to use for a rule.Set<Rule>getRules()booleanisEnabled(Rule rule)
-
-
-
Method Detail
-
getName
String getName()
- Returns:
- The profile name.
-
getDescription
String getDescription()
- Returns:
- The profile description.
-
getMetas
Params getMetas()
- Returns:
- The meta data associated to this profile.
-
getConfiguredRules
Set<ConfiguredRule> getConfiguredRules()
- Returns:
- The set of configured rules in this profile.
-
getEnabledRules
Set<Rule> getEnabledRules()
- Returns:
- The set of rules that are enabled in this profile.
-
getEnabledConfiguredRules
Set<ConfiguredRule> getEnabledConfiguredRules()
- Returns:
- The set of configured rules that are enabled in this profile.
-
isEnabled
boolean isEnabled(Rule rule)
- Parameters:
rule- The rule.- Returns:
trueifruleis enabled in this profile.- Throws:
IllegalArgumentException- Whenruleisnullor is unknown.
-
getParams
Params getParams(Rule rule)
Returns the parameters to use for a rule.- Parameters:
rule- The rule.- Returns:
- The parameters that are used to configure
rulein this profile. - Throws:
IllegalArgumentException- Whenruleisnullor is unknown.
-
-