Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class InvalidJavadocTag

java.lang.Object
com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
public final class InvalidJavadocTag extends Object
Value object for storing data about an invalid Javadoc validTags.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    col
    The column in which the invalid tag occurs.
    private final int
    line
    The line in which the invalid tag occurs.
    private final String
    name
    The name of the invalid tag.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InvalidJavadocTag(int line, int col, String name)
    Creates an instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCol()
    Getter for col field.
    int
    getLine()
    Getter for line field.
    String
    getName()
    Getter for name field.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • line

      private final int line
      The line in which the invalid tag occurs.

    • col

      private final int col
      The column in which the invalid tag occurs.

    • name

      private final String name
      The name of the invalid tag.

  • Constructor Details

    • InvalidJavadocTag

      public InvalidJavadocTag(int line, int col, String name)
      Creates an instance.
      Parameters:
      line - the line of the tag
      col - the column of the tag
      name - the name of the invalid tag

  • Method Details

    • getLine

      public int getLine()
      Getter for line field.
      Returns:
      line field

    • getCol

      public int getCol()
      Getter for col field.
      Returns:
      col field

    • getName

      public String getName()
      Getter for name field.
      Returns:
      name field