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

Record Class InvalidJavadocTag

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
Record Components:
line - the line of the invalid tag
col - the column of the invalid tag
name - the name of the invalid tag
public record InvalidJavadocTag(int line, int col, String name) extends Record
Value object for storing data about an invalid Javadoc tag.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    col
    The field for the col record component.
    private final int
    line
    The field for the line record component.
    private final String
    name
    The field for the name record component.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    col()
    Returns the value of the col record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    getCol()
    Legacy getter for col (backward compatibility).
    int
    getLine()
    Legacy getter for line (backward compatibility).
    String
    getName()
    Legacy getter for name (backward compatibility).
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    line()
    Returns the value of the line record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • line

      private final int line
      The field for the line record component.

    • col

      private final int col
      The field for the col record component.

    • name

      private final String name
      The field for the name record component.

  • Constructor Details

    • InvalidJavadocTag

      public InvalidJavadocTag(int line, int col, String name)
      Creates an instance of a InvalidJavadocTag record class.
      Parameters:
      line - the value for the line record component
      col - the value for the col record component
      name - the value for the name record component

  • Method Details

    • getLine

      public int getLine()
      Legacy getter for line (backward compatibility).

    • getCol

      public int getCol()
      Legacy getter for col (backward compatibility).

    • getName

      public String getName()
      Legacy getter for name (backward compatibility).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • line

      public int line()
      Returns the value of the line record component.
      Returns:
      the value of the line record component

    • col

      public int col()
      Returns the value of the col record component.
      Returns:
      the value of the col record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component