Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.hunspell

Record Class WordFormGenerator.State

java.lang.Object

java.lang.Record

org.apache.lucene.analysis.hunspell.WordFormGenerator.State

Enclosing class:

WordFormGenerator

private static record WordFormGenerator.State(Map<String,Set<WordFormGenerator.FlagSet>> stemToFlags, int underGenerated, int overGenerated, int potentialCoverage)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
private final int	overGenerated	The field for the overGenerated record component.
private final int	potentialCoverage	The field for the potentialCoverage record component.
private final Map<String,Set<WordFormGenerator.FlagSet>>	stemToFlags	The field for the stemToFlags record component.
private final int	underGenerated	The field for the underGenerated record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	State(Map<String,Set<WordFormGenerator.FlagSet>> stemToFlags, int underGenerated, int overGenerated, int potentialCoverage)	Creates an instance of a State 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.
int	overGenerated()	Returns the value of the overGenerated record component.
int	potentialCoverage()	Returns the value of the potentialCoverage record component.
Map<String,Set<WordFormGenerator.FlagSet>>	stemToFlags()	Returns the value of the stemToFlags record component.
final String	toString()	Returns a string representation of this record class.
int	underGenerated()	Returns the value of the underGenerated record component.

Methods inherited from class java.lang.Object

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

Field Details

stemToFlags

private final Map<String,Set<WordFormGenerator.FlagSet>> stemToFlags

The field for the stemToFlags record component.

underGenerated

private final int underGenerated

The field for the underGenerated record component.

overGenerated

private final int overGenerated

The field for the overGenerated record component.

potentialCoverage

private final int potentialCoverage

The field for the potentialCoverage record component.

Constructor Details

State

private State(Map<String,Set<WordFormGenerator.FlagSet>> stemToFlags,
 int underGenerated,
 int overGenerated,
 int potentialCoverage)

Creates an instance of a State record class.

Parameters:

stemToFlags - the value for the stemToFlags record component

underGenerated - the value for the underGenerated record component

overGenerated - the value for the overGenerated record component

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

stemToFlags

public Map<String,Set<WordFormGenerator.FlagSet>> stemToFlags()

Returns the value of the stemToFlags record component.

Returns:

the value of the stemToFlags record component

underGenerated

public int underGenerated()

Returns the value of the underGenerated record component.

Returns:

the value of the underGenerated record component

overGenerated

public int overGenerated()

Returns the value of the overGenerated record component.

Returns:

the value of the overGenerated record component

potentialCoverage

public int potentialCoverage()

Returns the value of the potentialCoverage record component.

Returns:

the value of the potentialCoverage record component