Package cdc.issues.rules

Class Rule

java.lang.Object
cdc.issues.rules.Rule
public class Rule extends Object
Class used to describe a Rule.
Author:
Damien Carbonne

  • Field Details

    • DOMAIN_NAME_SEPARATOR

      public static final String DOMAIN_NAME_SEPARATOR
      Default domain name separator.
      See Also:

    • ID_COMPARATOR

      public static final Comparator<Rule> ID_COMPARATOR
      Comparator of Rules based on their id (domain, name).

    • DOMAIN_TITLE_NAME_COMPARATOR

      public static final Comparator<Rule> DOMAIN_TITLE_NAME_COMPARATOR
      Comparator of Rules based on their domain, title and name.

  • Constructor Details

  • Method Details

    • getId

      public RuleId getId()
      Returns:
      The rule identifier.

    • getDomain

      public String getDomain()
      Returns:
      The rule domain.

    • getName

      public String getName()
      Returns:
      The rule name.

    • getName

      public <T extends Enum<T>> T getName(Class<T> cls)
      Type Parameters:
      T - The enum type.
      Parameters:
      cls - The enum class.
      Returns:
      The rule name as an enum.

    • getTitle

      public String getTitle()
      Returns:
      The rule title.

    • getSeverity

      public IssueSeverity getSeverity()
      Returns:
      The default rule severity.

    • getDescription

      public String getDescription()
      Returns:
      The rule description.

    • getParams

      public FormalParams getParams()
      Returns:
      The rule formal parameters.

    • getMetas

      public Metas getMetas()
      Returns:
      The rule meta data.

    • getLabels

      public Labels getLabels()
      Returns:
      The rule labels.

    • getRefDigest

      public String getRefDigest()
      Returns:
      A digest of the rule: {domain}-{name} {title}.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • builder

      public static Rule.Builder builder()