Record Class MetricScanner.MetricalAnalysis

java.lang.Object
java.lang.Record
org.episteme.social.linguistics.MetricScanner.MetricalAnalysis
Enclosing class:
MetricScanner
public static record MetricScanner.MetricalAnalysis(String line, String stressPattern, MetricScanner.MetricalFoot dominantFoot, int footCount, String meterName, List<String> scanningNotes) extends Record

  • Constructor Details

    • MetricalAnalysis

      public MetricalAnalysis(String line, String stressPattern, MetricScanner.MetricalFoot dominantFoot, int footCount, String meterName, List<String> scanningNotes)
      Creates an instance of a MetricalAnalysis record class.
      Parameters:
      line - the value for the line record component
      stressPattern - the value for the stressPattern record component
      dominantFoot - the value for the dominantFoot record component
      footCount - the value for the footCount record component
      meterName - the value for the meterName record component
      scanningNotes - the value for the scanningNotes 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 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.

    • line

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

    • stressPattern

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

    • dominantFoot

      public MetricScanner.MetricalFoot dominantFoot()
      Returns the value of the dominantFoot record component.
      Returns:
      the value of the dominantFoot record component

    • footCount

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

    • meterName

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

    • scanningNotes

      public List<String> scanningNotes()
      Returns the value of the scanningNotes record component.
      Returns:
      the value of the scanningNotes record component