Class SuppressionCommentFilter.Tag

    • Constructor Detail

    • Method Detail

      • getLine

        public int getLine()
        Returns line number of the tag in the source file.
        Returns:
        the line number of the tag in the source file.
      • getColumn

        public int getColumn()
        Determines the column number of the tag in the source file. Will be 0 for all lines of multiline comment, except the first line.
        Returns:
        the column number of the tag in the source file.
      • getTagType

        public SuppressionCommentFilter.TagType getTagType()
        Determines whether the suppression turns checkstyle reporting on or off.
        Returns:
        ON if the suppression turns reporting on.
      • compareTo

        public int compareTo​(SuppressionCommentFilter.Tag object)
        Compares the position of this tag in the file with the position of another tag.
        Specified by:
        compareTo in interface Comparable<SuppressionCommentFilter.Tag>
        Parameters:
        object - the tag to compare with this one.
        Returns:
        a negative number if this tag is before the other tag, 0 if they are at the same position, and a positive number if this tag is after the other tag.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isMatch

        public boolean isMatch​(TreeWalkerAuditEvent event)
        Determines whether the source of an audit event matches the text of this tag.
        Parameters:
        event - the TreeWalkerAuditEvent to check.
        Returns:
        true if the source of event matches the text of this tag.