Package com.puppycrawl.tools.checkstyle.site

Record Class TocMacro.TocContext

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.site.TocMacro.TocContext

Record Components:

sourceContent - the full template source text.

propertyDetails - documented property defaults for this module.

repoRoot - repository root, for resolving example file paths.

Enclosing class:

TocMacro

private static record TocMacro.TocContext(String sourceContent, Map<String,PropertyDetails> propertyDetails, Path repoRoot)
extends Record

Bundles the per-page context needed while writing TOC entries, so helper methods don't need long parameter lists.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,PropertyDetails>	propertyDetails	The field for the propertyDetails record component.
private final Path	repoRoot	The field for the repoRoot record component.
private final String	sourceContent	The field for the sourceContent record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TocContext(String sourceContent, Map<String,PropertyDetails> propertyDetails, Path repoRoot)	Creates an instance of a TocContext 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.
Map<String,PropertyDetails>	propertyDetails()	Returns the value of the propertyDetails record component.
Path	repoRoot()	Returns the value of the repoRoot record component.
String	sourceContent()	Returns the value of the sourceContent 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

sourceContent

private final String sourceContent

The field for the sourceContent record component.

propertyDetails

private final Map<String,PropertyDetails> propertyDetails

The field for the propertyDetails record component.

repoRoot

private final Path repoRoot

The field for the repoRoot record component.

Constructor Details

TocContext

private TocContext(String sourceContent,
 Map<String,PropertyDetails> propertyDetails,
 Path repoRoot)

Creates an instance of a TocContext record class.

Parameters:

sourceContent - the value for the sourceContent record component

propertyDetails - the value for the propertyDetails record component

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

sourceContent

public String sourceContent()

Returns the value of the sourceContent record component.

Returns:

the value of the sourceContent record component

propertyDetails

public Map<String,PropertyDetails> propertyDetails()

Returns the value of the propertyDetails record component.

Returns:

the value of the propertyDetails record component

repoRoot

public Path repoRoot()

Returns the value of the repoRoot record component.

Returns:

the value of the repoRoot record component