com.puppycrawl.tools.checkstyle.meta.checks.regexp.RegexpSinglelineJavaCheck.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 10.20.1

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck"
             name="RegexpSinglelineJava"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;p&gt;
 Checks that a specified pattern matches a single-line in Java files.
 &lt;/p&gt;
 &lt;p&gt;
 This class is variation on
 &lt;a href="https://checkstyle.org/checks/regexp/regexpsingleline.html#RegexpSingleline"&gt;
 RegexpSingleline&lt;/a&gt;
 for detecting single-lines that match a supplied regular expression in Java files.
 It supports suppressing matches in Java comments.
 &lt;/p&gt;</description>
         <properties>
            <property default-value="$." name="format" type="java.util.regex.Pattern">
               <description>Specify the format of the regular expression to match.</description>
            </property>
            <property default-value="false" name="ignoreCase" type="boolean">
               <description>Control whether to ignore case when searching.</description>
            </property>
            <property default-value="false" name="ignoreComments" type="boolean">
               <description>Control whether to ignore text in comments when searching.</description>
            </property>
            <property default-value="0" name="maximum" type="int">
               <description>Specify the maximum number of matches required in each file.</description>
            </property>
            <property name="message" type="java.lang.String">
               <description>Specify the message which is used to notify about
 violations, if empty then default (hard-coded) message is used.</description>
            </property>
            <property default-value="0" name="minimum" type="int">
               <description>Specify the minimum number of matches required in each file.</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="regexp.exceeded"/>
            <message-key key="regexp.minimum"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>