Class RuleUtil


  • public final class RuleUtil
    extends Object
    Tooling for Checkstyle rules conventions: names, categories.
    Since:
    2.13
    Author:
    Hervé Boutemy
    • Method Detail

      • getName

        public static String getName​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Get the rule name from an audit event.
        Parameters:
        event - the audit event
        Returns:
        the rule name, which is the class name without package and removed eventual "Check" suffix
      • getName

        public static String getName​(String eventSrcName)
        Get the rule name from an audit event source name.
        Parameters:
        eventSrcName - the audit event source name
        Returns:
        the rule name, which is the class name without package and removed eventual "Check" suffix
      • getCategory

        public static String getCategory​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Get the rule category from an audit event.
        Parameters:
        event - the audit event
        Returns:
        the rule category, which is the last package name or "misc" or "extension"
      • getCategory

        public static String getCategory​(String eventSrcName)
        Get the rule category from an audit event source name.
        Parameters:
        eventSrcName - the audit event source name
        Returns:
        the rule category, which is the last package name or "misc" or "extension"