Record Class JavadocTags

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
Record Components:
validTags - valid tags
invalidTags - invalid tags
public record JavadocTags(List<JavadocTag> validTags, List<InvalidJavadocTag> invalidTags) extends Record
Value object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment.

  • Field Details

  • Constructor Details

  • 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.

    • validTags

      public List<JavadocTag> validTags()
      Returns the value of the validTags record component.
      Returns:
      the value of the validTags record component

    • invalidTags

      public List<InvalidJavadocTag> invalidTags()
      Returns the value of the invalidTags record component.
      Returns:
      the value of the invalidTags record component