Package com.puppycrawl.tools.checkstyle.api

Class Violation

java.lang.Object
com.puppycrawl.tools.checkstyle.api.Violation
All Implemented Interfaces:
Comparable<Violation>
public final class Violation extends Object implements Comparable<Violation>
Represents a violation that can be localised. The translations come from message.properties files. The underlying implementation uses java.text.MessageFormat.

  • Field Details

    • DEFAULT_SEVERITY

      private static final SeverityLevel DEFAULT_SEVERITY
      The default severity level if one is not specified.

    • lineNo

      private final int lineNo
      The line number.

    • columnNo

      private final int columnNo
      The column number.

    • columnCharIndex

      private final int columnCharIndex
      The column char index.

    • tokenType

      private final int tokenType
      The token type constant. See TokenTypes.

    • severityLevel

      private final SeverityLevel severityLevel
      The severity level.

    • moduleId

      private final String moduleId
      The id of the module generating the violation.

    • key

      private final String key
      Key for the violation format.

    • args

      private final Object[] args
      Arguments for MessageFormat.

    • bundle

      private final String bundle
      Name of the resource bundle to get violations from.

    • sourceClass

      private final Class<?> sourceClass
      Class of the source for this Violation.

    • customMessage

      private final String customMessage
      A custom violation overriding the default violation from the bundle.

  • Constructor Details

    • Violation

      public Violation(int lineNo, int columnNo, int columnCharIndex, int tokenType, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance.
      Parameters:
      lineNo - line number associated with the violation
      columnNo - column number associated with the violation
      columnCharIndex - column char index associated with the violation
      tokenType - token type of the event associated with violation. See TokenTypes
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the violation
      moduleId - the id of the module the violation is associated with
      sourceClass - the Class that is the source of the violation
      customMessage - optional custom violation overriding the default

    • Violation

      public Violation(int lineNo, int columnNo, int tokenType, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance.
      Parameters:
      lineNo - line number associated with the violation
      columnNo - column number associated with the violation
      tokenType - token type of the event associated with violation. See TokenTypes
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the violation
      moduleId - the id of the module the violation is associated with
      sourceClass - the Class that is the source of the violation
      customMessage - optional custom violation overriding the default

    • Violation

      public Violation(int lineNo, int columnNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance.
      Parameters:
      lineNo - line number associated with the violation
      columnNo - column number associated with the violation
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the violation
      moduleId - the id of the module the violation is associated with
      sourceClass - the Class that is the source of the violation
      customMessage - optional custom violation overriding the default

    • Violation

      public Violation(int lineNo, int columnNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance.
      Parameters:
      lineNo - line number associated with the violation
      columnNo - column number associated with the violation
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      moduleId - the id of the module the violation is associated with
      sourceClass - the Class that is the source of the violation
      customMessage - optional custom violation overriding the default

    • Violation

      public Violation(int lineNo, String bundle, String key, Object[] args, SeverityLevel severityLevel, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance.
      Parameters:
      lineNo - line number associated with the violation
      bundle - resource bundle name
      key - the key to locate the translation
      args - arguments for the translation
      severityLevel - severity level for the violation
      moduleId - the id of the module the violation is associated with
      sourceClass - the source class for the violation
      customMessage - optional custom violation overriding the default

    • Violation

      public Violation(int lineNo, String bundle, String key, Object[] args, String moduleId, Class<?> sourceClass, String customMessage)
      Creates a new Violation instance. The column number defaults to 0.
      Parameters:
      lineNo - line number associated with the violation
      bundle - name of a resource bundle that contains audit event violations
      key - the key to locate the translation
      args - arguments for the translation
      moduleId - the id of the module the violation is associated with
      sourceClass - the name of the source for the violation
      customMessage - optional custom violation overriding the default

  • Method Details

    • getLineNo

      public int getLineNo()
      Gets the line number.
      Returns:
      the line number

    • getColumnNo

      public int getColumnNo()
      Gets the column number.
      Returns:
      the column number

    • getColumnCharIndex

      public int getColumnCharIndex()
      Gets the column char index.
      Returns:
      the column char index

    • getTokenType

      public int getTokenType()
      Gets the token type.
      Returns:
      the token type

    • getSeverityLevel

      public SeverityLevel getSeverityLevel()
      Gets the severity level.
      Returns:
      the severity level

    • getModuleId

      public String getModuleId()
      Returns id of module.
      Returns:
      the module identifier.

    • getKey

      public String getKey()
      Returns the violation key to locate the translation, can also be used in IDE plugins to map audit event violations to corrective actions.
      Returns:
      the violation key

    • getSourceName

      public String getSourceName()
      Gets the name of the source for this Violation.
      Returns:
      the name of the source for this Violation

    • equals

      public boolean equals(Object object)
      Indicates whether some other object is "equal to" this one. Suppression on enumeration is needed so code stays consistent.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(Violation other)
      Specified by:
      compareTo in interface Comparable<Violation>

    • getViolation

      public String getViolation()
      Gets the translated violation.
      Returns:
      the translated violation