Package com.puppycrawl.tools.checkstyle.checks

Class SuppressWarningsHolder.Entry

java.lang.Object
com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
Enclosing class:
SuppressWarningsHolder
private static final class SuppressWarningsHolder.Entry extends Object
Records a particular suppression for a region of a file.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    checkName
    The source name of the suppressed check.
    private final int
    firstColumn
    The suppression region for the check - first column.
    private final int
    firstLine
    The suppression region for the check - first line.
    private final int
    lastColumn
    The suppression region for the check - last column.
    private final int
    lastLine
    The suppression region for the check - last line.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Entry(String checkName, int firstLine, int firstColumn, int lastLine, int lastColumn)
    Constructs a new suppression region entry.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCheckName()
    Gets the source name of the suppressed check.
    int
    getFirstColumn()
    Gets the first column of the suppression region.
    int
    getFirstLine()
    Gets the first line of the suppression region.
    int
    getLastColumn()
    Gets the last column of the suppression region.
    int
    getLastLine()
    Gets the last line of the suppression region.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • checkName

      private final String checkName
      The source name of the suppressed check.

    • firstLine

      private final int firstLine
      The suppression region for the check - first line.

    • firstColumn

      private final int firstColumn
      The suppression region for the check - first column.

    • lastLine

      private final int lastLine
      The suppression region for the check - last line.

    • lastColumn

      private final int lastColumn
      The suppression region for the check - last column.

  • Constructor Details

    • Entry

      private Entry(String checkName, int firstLine, int firstColumn, int lastLine, int lastColumn)
      Constructs a new suppression region entry.
      Parameters:
      checkName - the source name of the suppressed check
      firstLine - the first line of the suppression region
      firstColumn - the first column of the suppression region
      lastLine - the last line of the suppression region
      lastColumn - the last column of the suppression region

  • Method Details

    • getCheckName

      public String getCheckName()
      Gets the source name of the suppressed check.
      Returns:
      the source name of the suppressed check

    • getFirstLine

      public int getFirstLine()
      Gets the first line of the suppression region.
      Returns:
      the first line of the suppression region

    • getFirstColumn

      public int getFirstColumn()
      Gets the first column of the suppression region.
      Returns:
      the first column of the suppression region

    • getLastLine

      public int getLastLine()
      Gets the last line of the suppression region.
      Returns:
      the last line of the suppression region

    • getLastColumn

      public int getLastColumn()
      Gets the last column of the suppression region.
      Returns:
      the last column of the suppression region