Package com.puppycrawl.tools.checkstyle.checks.coding

Record Class UnusedPrivateFieldCheck.FieldUsage

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.checks.coding.UnusedPrivateFieldCheck.FieldUsage

Record Components:

name - the field name referenced.

ancestorFieldMaps - the currently open field maps at the time of the reference, innermost first (index 0).

ancestorTypeNames - the currently open type names, parallel to ancestorFieldMaps.

qualifierTypeName - the type name in a ClassName.this.field reference, or null if not that form.

bareThisQualified - true for a this.field reference.

Enclosing class:

UnusedPrivateFieldCheck

private static record UnusedPrivateFieldCheck.FieldUsage(String name, List<Map<String,DetailAST>> ancestorFieldMaps, List<String> ancestorTypeNames, String qualifierTypeName, boolean bareThisQualified)
extends Record

A recorded, not-yet-resolved reference to a field name, with enough context to resolve it precisely once the whole file has been visited.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<Map<String,DetailAST>>	ancestorFieldMaps	The field for the ancestorFieldMaps record component.
private final List<String>	ancestorTypeNames	The field for the ancestorTypeNames record component.
private final boolean	bareThisQualified	The field for the bareThisQualified record component.
private final String	name	The field for the name record component.
private final String	qualifierTypeName	The field for the qualifierTypeName record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FieldUsage(String name, List<Map<String,DetailAST>> ancestorFieldMaps, List<String> ancestorTypeNames, String qualifierTypeName, boolean bareThisQualified)	Creates an instance of a FieldUsage record class.

Method Summary

Modifier and Type	Method	Description
List<Map<String,DetailAST>>	ancestorFieldMaps()	Returns the value of the ancestorFieldMaps record component.
List<String>	ancestorTypeNames()	Returns the value of the ancestorTypeNames record component.
boolean	bareThisQualified()	Returns the value of the bareThisQualified record component.
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.
String	name()	Returns the value of the name record component.
String	qualifierTypeName()	Returns the value of the qualifierTypeName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

name

private final String name

The field for the name record component.

ancestorFieldMaps

private final List<Map<String,DetailAST>> ancestorFieldMaps

The field for the ancestorFieldMaps record component.

ancestorTypeNames

private final List<String> ancestorTypeNames

The field for the ancestorTypeNames record component.

qualifierTypeName

private final String qualifierTypeName

The field for the qualifierTypeName record component.

bareThisQualified

private final boolean bareThisQualified

The field for the bareThisQualified record component.

Constructor Details

FieldUsage

private FieldUsage(String name,
 List<Map<String,DetailAST>> ancestorFieldMaps,
 List<String> ancestorTypeNames,
 String qualifierTypeName,
 boolean bareThisQualified)

Creates an instance of a FieldUsage record class.

Parameters:

name - the value for the name record component

ancestorFieldMaps - the value for the ancestorFieldMaps record component

ancestorTypeNames - the value for the ancestorTypeNames record component

qualifierTypeName - the value for the qualifierTypeName record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

ancestorFieldMaps

public List<Map<String,DetailAST>> ancestorFieldMaps()

Returns the value of the ancestorFieldMaps record component.

Returns:

the value of the ancestorFieldMaps record component

ancestorTypeNames

public List<String> ancestorTypeNames()

Returns the value of the ancestorTypeNames record component.

Returns:

the value of the ancestorTypeNames record component

qualifierTypeName

public String qualifierTypeName()

Returns the value of the qualifierTypeName record component.

Returns:

the value of the qualifierTypeName record component

bareThisQualified

public boolean bareThisQualified()

Returns the value of the bareThisQualified record component.

Returns:

the value of the bareThisQualified record component