com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code
that adheres to a coding standard
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2020 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.regexp;
import java.io.File;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
/**
*
* Checks that a specified pattern matches a single line in any file type.
*
*
* Rationale: This check can be used to prototype checks and to find common bad
* practice such as calling {@code ex.printStacktrace()},
* {@code System.out.println()}, {@code System.exit()}, etc.
*
*
* -
* Property {@code format} - Specify the format of the regular expression to match.
* Default value is {@code "$."}.
*
* -
* Property {@code message} - Specify the message which is used to notify about
* violations, if empty then default (hard-coded) message is used.
* Default value is {@code null}.
*
* -
* Property {@code ignoreCase} - Control whether to ignore case when searching.
* Default value is {@code false}.
*
* -
* Property {@code minimum} - Specify the minimum number of matches required in each file.
* Default value is {@code 0}.
*
* -
* Property {@code maximum} - Specify the maximum number of matches required in each file.
* Default value is {@code 0}.
*
* -
* Property {@code fileExtensions} - Specify the file type extension of files to process.
* Default value is {@code all files}.
*
*
*
* To configure the check with default values:
*
*
* <module name="RegexpSingleline" />
*
*
* This configuration does not match to anything,
* so we do not provide any code example for it
* as no violation will ever be reported.
*
*
* To configure the check to find occurrences of 'System.exit('
* with some slack of allowing only one occurrence per file:
*
*
* <module name="RegexpSingleline">
* <property name="format" value="System.exit\("/>
* <!-- next line not required as 0 is the default -->
* <property name="minimum" value="0"/>
* <property name="maximum" value="1"/>
* </module>
*
* Example:
*
* class MyClass {
* void myFunction() {
* try {
* doSomething();
* } catch (Exception e) {
* System.exit(1); // OK, as only there is only one occurrence.
* }
* }
* void doSomething(){};
* }
*
*
* class MyClass {
* void myFunction() {
* try {
* doSomething();
* System.exit(0);
* } catch (Exception e) {
* System.exit(1); // Violation, as there are more than one occurrence.
* }
* }
* void doSomething(){};
* }
*
*
* An example of how to configure the check to make sure a copyright statement
* is included in the file:
*
*
* <module name="RegexpSingleline">
* <property name="format" value="This file is copyrighted"/>
* <property name="minimum" value="1"/>
* <!-- Need to specify a maximum, so 10 times is more than enough. -->
* <property name="maximum" value="10"/>
* </module>
*
* Example:
*
* /**
* * This file is copyrighted under CC. // Ok, as the file contains a copyright statement.
* */
* class MyClass {
*
* }
*
*
* /** // violation, as the file doesn't contain a copyright statement.
* * MyClass as a configuration example.
* */
* class MyClass {
*
* }
*
*
* An example of how to configure the check to make sure sql files contains the term 'license'.
*
*
* <module name="RegexpSingleline">
* <property name="format" value="license"/>
* <property name="minimum" value="1"/>
* <property name="maximum" value="9999"/>
* <property name="ignoreCase" value="true"/>
* <!-- Configure a message to be shown on violation of the Check. -->
* <property name="message"
* value="File must contain at least one occurrence of 'license' term"/>
* <!-- Perform the Check only on files with java extension. -->
* <property name="fileExtensions" value="sql"/>
* </module>
*
* Example:
*
* /*
* AP 2.0 License. // Ok, Check ignores the case of the term.
* */
* CREATE DATABASE MyDB;
*
*
* /* // violation, file doesn't contain the term.
* Example sql file.
* */
* CREATE DATABASE MyDB;
*
*
* @since 5.0
*/
@StatelessCheck
public class RegexpSinglelineCheck extends AbstractFileSetCheck {
/** Specify the format of the regular expression to match. */
private String format = "$.";
/**
* Specify the message which is used to notify about violations,
* if empty then default (hard-coded) message is used.
*/
private String message;
/** Specify the minimum number of matches required in each file. */
private int minimum;
/** Specify the maximum number of matches required in each file. */
private int maximum;
/** Control whether to ignore case when searching. */
private boolean ignoreCase;
/** The detector to use. */
private SinglelineDetector detector;
@Override
public void beginProcessing(String charset) {
final DetectorOptions options = DetectorOptions.newBuilder()
.reporter(this)
.compileFlags(0)
.format(format)
.message(message)
.minimum(minimum)
.maximum(maximum)
.ignoreCase(ignoreCase)
.build();
detector = new SinglelineDetector(options);
}
@Override
protected void processFiltered(File file, FileText fileText) {
detector.processLines(fileText);
}
/**
* Setter to specify the format of the regular expression to match.
*
* @param format the format of the regular expression to match.
*/
public void setFormat(String format) {
this.format = format;
}
/**
* Setter to specify the message which is used to notify about violations,
* if empty then default (hard-coded) message is used.
*
* @param message the message to report for a match.
*/
public void setMessage(String message) {
this.message = message;
}
/**
* Setter to specify the minimum number of matches required in each file.
*
* @param minimum the minimum number of matches required in each file.
*/
public void setMinimum(int minimum) {
this.minimum = minimum;
}
/**
* Setter to specify the maximum number of matches required in each file.
*
* @param maximum the maximum number of matches required in each file.
*/
public void setMaximum(int maximum) {
this.maximum = maximum;
}
/**
* Setter to control whether to ignore case when searching.
*
* @param ignoreCase whether to ignore case when searching.
*/
public void setIgnoreCase(boolean ignoreCase) {
this.ignoreCase = ignoreCase;
}
}