Record Class SourceLineMetrics

java.lang.Object
java.lang.Record
dev.archunitjava.metrics.SourceLineMetrics
public record SourceLineMetrics(long physicalLines, long blankLines, long commentLines, long codeLines) extends Record
Physical Java line counts. Mixed code/comment lines are code; whitespace-only lines inside a block comment are comments; text-block content is code. Empty text has zero physical lines.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SourceLineMetrics(long physicalLines, long blankLines, long commentLines, long codeLines)
    Creates an instance of a SourceLineMetrics record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    blankLines()
    Returns the value of the blankLines record component.
    long
    codeLines()
    Returns the value of the codeLines record component.
    long
    commentLines()
    Returns the value of the commentLines record component.
    static SourceLineMetrics
    count(String source)
     
    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.
    long
    physicalLines()
    Returns the value of the physicalLines record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • SourceLineMetrics

      public SourceLineMetrics(long physicalLines, long blankLines, long commentLines, long codeLines)
      Creates an instance of a SourceLineMetrics record class.
      Parameters:
      physicalLines - the value for the physicalLines record component
      blankLines - the value for the blankLines record component
      commentLines - the value for the commentLines record component
      codeLines - the value for the codeLines record component

  • Method Details

    • count

      public static SourceLineMetrics count(String source)

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • physicalLines

      public long physicalLines()
      Returns the value of the physicalLines record component.
      Returns:
      the value of the physicalLines record component

    • blankLines

      public long blankLines()
      Returns the value of the blankLines record component.
      Returns:
      the value of the blankLines record component

    • commentLines

      public long commentLines()
      Returns the value of the commentLines record component.
      Returns:
      the value of the commentLines record component

    • codeLines

      public long codeLines()
      Returns the value of the codeLines record component.
      Returns:
      the value of the codeLines record component