Package com.puppycrawl.tools.checkstyle.site

Record Class AllCheckSummaries.CheckInfo

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.site.AllCheckSummaries.CheckInfo

Record Components:

simpleName - check simple name

link - documentation link

summary - module summary

Enclosing class:

AllCheckSummaries

private static record AllCheckSummaries.CheckInfo(String simpleName, String link, String summary)
extends Record

Data holder for each Check module entry.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	link	The field for the link record component.
private final String	simpleName	The field for the simpleName record component.
private final String	summary	The field for the summary record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CheckInfo(String simpleName, String link, String summary)	Creates an instance of a CheckInfo 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.
String	link()	Returns the value of the link record component.
String	simpleName()	Returns the value of the simpleName record component.
String	summary()	Returns the value of the summary 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

simpleName

private final String simpleName

The field for the simpleName record component.

link

private final String link

The field for the link record component.

summary

private final String summary

The field for the summary record component.

Constructor Details

CheckInfo

private CheckInfo(String simpleName,
 String link,
 String summary)

Creates an instance of a CheckInfo record class.

Parameters:

simpleName - the value for the simpleName record component

link - the value for the link record component

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

simpleName

public String simpleName()

Returns the value of the simpleName record component.

Returns:

the value of the simpleName record component

link

public String link()

Returns the value of the link record component.

Returns:

the value of the link record component

summary

public String summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component