Record Class MetricScanner.RhymeAnalysis

java.lang.Object

java.lang.Record

org.episteme.social.linguistics.MetricScanner.RhymeAnalysis

Enclosing class:

MetricScanner

public static record MetricScanner.RhymeAnalysis(List<String> lines, String rhymeScheme, Map<Character, List<String>> rhymeGroups)
extends Record

Constructor Summary

Constructors

Constructor	Description
RhymeAnalysis(List<String> lines, String rhymeScheme, Map<Character, List<String>> rhymeGroups)	Creates an instance of a RhymeAnalysis 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.
List<String>	lines()	Returns the value of the lines record component.
Map<Character, List<String>>	rhymeGroups()	Returns the value of the rhymeGroups record component.
String	rhymeScheme()	Returns the value of the rhymeScheme 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

RhymeAnalysis

public RhymeAnalysis(List<String> lines,
 String rhymeScheme,
 Map<Character, List<String>> rhymeGroups)

Creates an instance of a RhymeAnalysis record class.

Parameters:

lines - the value for the lines record component

rhymeScheme - the value for the rhymeScheme record component

rhymeGroups - the value for the rhymeGroups 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.

lines

public List<String> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

rhymeScheme

public String rhymeScheme()

Returns the value of the rhymeScheme record component.

Returns:

the value of the rhymeScheme record component

rhymeGroups

public Map<Character, List<String>> rhymeGroups()

Returns the value of the rhymeGroups record component.

Returns:

the value of the rhymeGroups record component