Record Class ReadabilityIndex.ReadabilityResult

java.lang.Object

java.lang.Record

org.episteme.social.linguistics.ReadabilityIndex.ReadabilityResult

All Implemented Interfaces:

Serializable

Enclosing class:

ReadabilityIndex

public static record ReadabilityIndex.ReadabilityResult(double score, String indexName, String gradeLevel, String interpretation)
extends Record
implements Serializable

Encapsulates the evaluation of a readability calculation.

Since:

1.0

Version:

2.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ReadabilityResult(double score, String indexName, String gradeLevel, String interpretation)	Creates an instance of a ReadabilityResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	gradeLevel()	Returns the value of the gradeLevel record component.
final int	hashCode()	Returns a hash code value for this object.
String	indexName()	Returns the value of the indexName record component.
String	interpretation()	Returns the value of the interpretation record component.
double	score()	Returns the value of the score 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

ReadabilityResult

public ReadabilityResult(double score,
 String indexName,
 String gradeLevel,
 String interpretation)

Creates an instance of a ReadabilityResult record class.

Parameters:

score - the value for the score record component

indexName - the value for the indexName record component

gradeLevel - the value for the gradeLevel record component

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

score

public double score()

Returns the value of the score record component.

Returns:

the value of the score record component

indexName

public String indexName()

Returns the value of the indexName record component.

Returns:

the value of the indexName record component

gradeLevel

public String gradeLevel()

Returns the value of the gradeLevel record component.

Returns:

the value of the gradeLevel record component

interpretation

public String interpretation()

Returns the value of the interpretation record component.

Returns:

the value of the interpretation record component