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

Record Class JavadocMethodCheck.Token

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
Record Components:
text - Token's text.
Enclosing class:
JavadocMethodCheck
private static record JavadocMethodCheck.Token(String text) extends Record
Represents text element with location in the text.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    text
    The field for the text record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Token(FullIdent fullIdent)
    Converts FullIdent to Token.
    private
    Token(String text)
    Creates an instance of a Token record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    text()
    Returns the value of the text 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

    • text

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

  • Constructor Details

    • Token

      private Token(FullIdent fullIdent)
      Converts FullIdent to Token.
      Parameters:
      fullIdent - full ident to convert.

    • Token

      private Token(String text)
      Creates an instance of a Token record class.
      Parameters:
      text - the value for the text record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • text

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