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

Class MultiFileRegexpHeaderCheck.MatchResult

java.lang.Object

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

Enclosing class:

MultiFileRegexpHeaderCheck

private static final class MultiFileRegexpHeaderCheck.MatchResult
extends Object

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	Whether the header matched the file.
private final int	lineNumber	Line number where the mismatch occurred (1-based).
private final String	messageArg	The argument for the message.
private final String	messageKey	The message key for the violation.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MatchResult(boolean isMatching, int lineNumber, String messageKey, String messageArg)	Private constructor.

Method Summary

Modifier and Type	Method	Description
static MultiFileRegexpHeaderCheck.MatchResult	matching()	Creates a matching result.
static MultiFileRegexpHeaderCheck.MatchResult	mismatch(int lineNumber, String messageKey, String messageArg)	Creates a mismatch result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

isMatching

private final boolean isMatching

Whether the header matched the file.

lineNumber

private final int lineNumber

Line number where the mismatch occurred (1-based).

messageKey

private final String messageKey

The message key for the violation.

messageArg

private final String messageArg

The argument for the message.

Constructor Details

MatchResult

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

Private constructor.

Parameters:

isMatching - whether the header matched

lineNumber - line number of mismatch (1-based)

messageKey - message key for violation

messageArg - message argument

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