Package com.puppycrawl.tools.checkstyle.checks.header

Record Class MultiFileRegexpHeaderCheck.MatchResult

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.checks.header.MultiFileRegexpHeaderCheck.MatchResult

Record Components:

isMatching - whether the header matched

lineNumber - line number of mismatch (1-based)

messageKey - message key for violation

messageArg - message argument

Enclosing class:

MultiFileRegexpHeaderCheck

private static record MultiFileRegexpHeaderCheck.MatchResult(boolean isMatching, int lineNumber, String messageKey, String messageArg)
extends Record

Represents the result of a header match check, containing information about any mismatch.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	isMatching	The field for the isMatching record component.
private final int	lineNumber	The field for the lineNumber record component.
private final String	messageArg	The field for the messageArg record component.
private final String	messageKey	The field for the messageKey record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MatchResult(boolean isMatching, int lineNumber, String messageKey, String messageArg)	Creates an instance of a MatchResult 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.
boolean	isMatching()	Returns the value of the isMatching record component.
int	lineNumber()	Returns the value of the lineNumber record component.
static MultiFileRegexpHeaderCheck.MatchResult	matching()	Creates a matching result.
String	messageArg()	Returns the value of the messageArg record component.
String	messageKey()	Returns the value of the messageKey record component.
static MultiFileRegexpHeaderCheck.MatchResult	mismatch(int lineNumber, String messageKey, String messageArg)	Creates a mismatch result.
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

isMatching

private final boolean isMatching

The field for the isMatching record component.

lineNumber

private final int lineNumber

The field for the lineNumber record component.

messageKey

private final String messageKey

The field for the messageKey record component.

messageArg

private final String messageArg

The field for the messageArg record component.

Constructor Details

MatchResult

private MatchResult(boolean isMatching,
 int lineNumber,
 String messageKey,
 String messageArg)

Creates an instance of a MatchResult record class.

Parameters:

isMatching - the value for the isMatching record component

lineNumber - the value for the lineNumber record component

messageKey - the value for the messageKey record component

messageArg - the value for the messageArg record component

Method Details

matching

public static MultiFileRegexpHeaderCheck.MatchResult matching()

Creates a matching result.

Returns:

a matching result

mismatch

public static MultiFileRegexpHeaderCheck.MatchResult mismatch(int lineNumber,
 String messageKey,
 String messageArg)

Creates a mismatch result.

Parameters:

lineNumber - the line number where mismatch occurred (1-based)

messageKey - the message key for the violation

messageArg - the argument for the message

Returns:

a mismatch result

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.

isMatching

public boolean isMatching()

Returns the value of the isMatching record component.

Returns:

the value of the isMatching record component

lineNumber

public int lineNumber()

Returns the value of the lineNumber record component.

Returns:

the value of the lineNumber record component

messageKey

public String messageKey()

Returns the value of the messageKey record component.

Returns:

the value of the messageKey record component

messageArg

public String messageArg()

Returns the value of the messageArg record component.

Returns:

the value of the messageArg record component