Interface Profile


  • public interface Profile
    Interface describing a Profile.

    It is a set of ConfiguredRules, some of which are enabled.

    Author:
    Damien Carbonne
    • 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.
      • getRules

        Set<Rule> getRules()
        Returns:
        The set of rules in 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:
        true if rule is enabled in this profile.
        Throws:
        IllegalArgumentException - When rule is null or 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 rule in this profile.
        Throws:
        IllegalArgumentException - When rule is null or is unknown.