Class RegexpSinglelineJavaCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class RegexpSinglelineJavaCheck extends AbstractCheck
Implementation of a check that looks for a single line in Java files. Supports ignoring comments for matches.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
format
The format of the regular expression to match.private boolean
ignoreCase
Whether to ignore case when matching.private boolean
ignoreComments
Suppress comments.private int
maximum
The maximum number of matches required per file.private java.lang.String
message
The message to report for a match.private int
minimum
The minimum number of matches required per file.
-
Constructor Summary
Constructors Constructor Description RegexpSinglelineJavaCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.void
setFormat(java.lang.String format)
Set the format of the regular expression to match.void
setIgnoreCase(boolean ignoreCase)
Set whether to ignore case when matching.void
setIgnoreComments(boolean ignore)
Set whether to ignore comments when matching.void
setMaximum(int maximum)
Set the maximum number of matches required per file.void
setMessage(java.lang.String message)
Set the message to report for a match.void
setMinimum(int minimum)
Set the minimum number of matches required per file.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
format
private java.lang.String format
The format of the regular expression to match.
-
message
private java.lang.String message
The message to report for a match.
-
minimum
private int minimum
The minimum number of matches required per file.
-
maximum
private int maximum
The maximum number of matches required per file.
-
ignoreCase
private boolean ignoreCase
Whether to ignore case when matching.
-
ignoreComments
private boolean ignoreComments
Suppress comments.
-
-
Method Detail
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
setFormat
public void setFormat(java.lang.String format)
Set the format of the regular expression to match.- Parameters:
format
- the format of the regular expression to match.
-
setMessage
public void setMessage(java.lang.String message)
Set the message to report for a match.- Parameters:
message
- the message to report for a match.
-
setMinimum
public void setMinimum(int minimum)
Set the minimum number of matches required per file.- Parameters:
minimum
- the minimum number of matches required per file.
-
setMaximum
public void setMaximum(int maximum)
Set the maximum number of matches required per file.- Parameters:
maximum
- the maximum number of matches required per file.
-
setIgnoreCase
public void setIgnoreCase(boolean ignoreCase)
Set whether to ignore case when matching.- Parameters:
ignoreCase
- whether to ignore case when matching.
-
setIgnoreComments
public void setIgnoreComments(boolean ignore)
Set whether to ignore comments when matching.- Parameters:
ignore
- whether to ignore comments when matching.
-
-