Package com.puppycrawl.tools.checkstyle.utils

Record Class InlineConfigUtils.MatchedDelimiter

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.utils.InlineConfigUtils.MatchedDelimiter
Record Components:
end - the end delimiter to search for, or null if the config block ends implicitly at the first blank line (properties-style).
xmlStyleConfig - true if the config content is XML (<module> form), false if it is the legacy bare key=value form.
Enclosing class:
InlineConfigUtils
public static record InlineConfigUtils.MatchedDelimiter(String end, boolean xmlStyleConfig) extends Record
Describes which delimiter convention matched the first line of a file, so callers can locate the end of the config block and know whether the config content should be parsed as XML module config or the legacy bare key=value format.

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    MatchedDelimiter(String end, boolean xmlStyleConfig)
    Creates an instance of a MatchedDelimiter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    end()
    Returns the value of the end record component.
    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.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    xmlStyleConfig()
    Returns the value of the xmlStyleConfig record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • MatchedDelimiter

      public MatchedDelimiter(String end, boolean xmlStyleConfig)
      Creates an instance of a MatchedDelimiter record class.
      Parameters:
      end - the value for the end record component
      xmlStyleConfig - the value for the xmlStyleConfig 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. 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.

    • end

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

    • xmlStyleConfig

      public boolean xmlStyleConfig()
      Returns the value of the xmlStyleConfig record component.
      Returns:
      the value of the xmlStyleConfig record component