Class SuppressionsStringPrinter

java.lang.Object
com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter

public final class SuppressionsStringPrinter extends Object
Class for constructing xpath queries to suppress nodes with specified line and column number.
  • Field Details

    • VALID_SUPPRESSION_LINE_COLUMN_NUMBER_REGEX

      private static final Pattern VALID_SUPPRESSION_LINE_COLUMN_NUMBER_REGEX
      Line and column number config value pattern.
    • LINE_SEPARATOR

      private static final String LINE_SEPARATOR
      OS specific line separator.
  • Constructor Details

    • SuppressionsStringPrinter

      private SuppressionsStringPrinter()
      Prevent instances.
  • Method Details

    • printSuppressions

      public static String printSuppressions(File file, String suppressionLineColumnNumber, int tabWidth) throws IOException, CheckstyleException
      Prints generated suppressions.
      Parameters:
      file - the file to process.
      suppressionLineColumnNumber - line and column number of the suppression
      tabWidth - length of the tab character
      Returns:
      generated suppressions.
      Throws:
      IOException - if the file could not be read.
      IllegalStateException - if suppressionLineColumnNumber is not of a valid format.
      CheckstyleException - if the file is not a Java source.
    • generate

      private static String generate(FileText fileText, DetailAST detailAST, int lineNumber, int columnNumber, int tabWidth)
      Creates XpathQueryGenerator instance and generates suppressions.
      Parameters:
      fileText - FileText object.
      detailAST - DetailAST object.
      lineNumber - line number.
      columnNumber - column number.
      tabWidth - length of the tab character.
      Returns:
      generated suppressions.