Class AbstractViolationReporter

    • Method Detail

      • setSeverity

        public final void setSeverity​(String severity)
        Sets the severity level. The string should be one of the names defined in the SeverityLevel class.
        Parameters:
        severity - The new severity level
        See Also:
        SeverityLevel
      • getSeverity

        public final String getSeverity()
        Get the severity level's name.
        Returns:
        the check's severity level name.
      • getId

        public final String getId()
        Returns the identifier of the reporter. Can be null.
        Returns:
        the id
      • setId

        public final void setId​(String id)
        Sets the identifier of the reporter. Can be null.
        Parameters:
        id - the id
      • getCustomMessages

        protected Map<String,​StringgetCustomMessages()
        Returns an unmodifiable map instance containing the custom messages for this configuration.
        Returns:
        unmodifiable map containing custom messages
      • getMessageBundle

        protected String getMessageBundle()
        Returns the message bundle name resource bundle that contains the messages used by this module.

        The default implementation expects the resource files to be named messages.properties, messages_de.properties, etc. The file must be placed in the same package as the module implementation.

        Example: If you write com/foo/MyCoolCheck, create resource files com/foo/messages.properties, com/foo/messages_de.properties, etc.

        Returns:
        name of a resource bundle that contains the messages used by this module.
      • getMessageBundle

        private static String getMessageBundle​(String className)
        For unit tests, especially with a class with no package name.
        Parameters:
        className - class name of the module.
        Returns:
        name of a resource bundle that contains the messages used by the module.
      • log

        public abstract void log​(int line,
                                 String key,
                                 Object... args)
        Log a message that has no column information.
        Parameters:
        line - the line number where the audit event was found
        key - the message that describes the audit event
        args - the details of the message
        See Also:
        MessageFormat
      • log

        public abstract void log​(int line,
                                 int col,
                                 String key,
                                 Object... args)
        Log a message that has column information.
        Parameters:
        line - the line number where the audit event was found
        col - the column number where the audit event was found
        key - the message that describes the audit event
        args - the details of the message
        See Also:
        MessageFormat