Package com.puppycrawl.tools.checkstyle.checks

Record Class SuppressWarningsHolder.Entry

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry

Record Components:

checkName - the source name of the suppressed check

firstLine - the first line of the suppression region

firstColumn - the first column of the suppression region

lastLine - the last line of the suppression region

lastColumn - the last column of the suppression region

Enclosing class:

SuppressWarningsHolder

private static record SuppressWarningsHolder.Entry(String checkName, int firstLine, int firstColumn, int lastLine, int lastColumn)
extends Record

Records a particular suppression for a region of a file.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	checkName	The field for the checkName record component.
private final int	firstColumn	The field for the firstColumn record component.
private final int	firstLine	The field for the firstLine record component.
private final int	lastColumn	The field for the lastColumn record component.
private final int	lastLine	The field for the lastLine record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Entry(String checkName, int firstLine, int firstColumn, int lastLine, int lastColumn)	Creates an instance of a Entry record class.

Method Summary

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

checkName

private final String checkName

The field for the checkName record component.

firstLine

private final int firstLine

The field for the firstLine record component.

firstColumn

private final int firstColumn

The field for the firstColumn record component.

lastLine

private final int lastLine

The field for the lastLine record component.

lastColumn

private final int lastColumn

The field for the lastColumn record component.

Constructor Details

Entry

private Entry(String checkName,
 int firstLine,
 int firstColumn,
 int lastLine,
 int lastColumn)

Creates an instance of a Entry record class.

Parameters:

checkName - the value for the checkName record component

firstLine - the value for the firstLine record component

firstColumn - the value for the firstColumn record component

lastLine - the value for the lastLine record component

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

checkName

public String checkName()

Returns the value of the checkName record component.

Returns:

the value of the checkName record component

firstLine

public int firstLine()

Returns the value of the firstLine record component.

Returns:

the value of the firstLine record component

firstColumn

public int firstColumn()

Returns the value of the firstColumn record component.

Returns:

the value of the firstColumn record component

lastLine

public int lastLine()

Returns the value of the lastLine record component.

Returns:

the value of the lastLine record component

lastColumn

public int lastColumn()

Returns the value of the lastColumn record component.

Returns:

the value of the lastColumn record component