com.puppycrawl.tools.checkstyle.meta.checks.naming.AbstractClassNameCheck.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.21.4

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck"
             name="AbstractClassName"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;div&gt;
 Ensures that the names of abstract classes conforming to some pattern
 and check that {@code abstract} modifier exists.
 &lt;/div&gt;

 &lt;p&gt;
 Rationale: Abstract classes are convenience base class implementations of
 interfaces. For this reason, it should be made obvious that a given class
 is abstract by prefacing the class name with 'Abstract'.
 &lt;/p&gt;</description>
         <properties>
            <property default-value="^Abstract.+$"
                      name="format"
                      type="java.util.regex.Pattern">
               <description>Specify valid identifiers.</description>
            </property>
            <property default-value="false" name="ignoreModifier" type="boolean">
               <description>Control whether to ignore checking for the
 {@code abstract} modifier on classes that match the name.</description>
            </property>
            <property default-value="false" name="ignoreName" type="boolean">
               <description>Control whether to ignore checking the name.
 Realistically only useful if using the check to identify that match name and
 do not have the {@code abstract} modifier.</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="illegal.abstract.class.name"/>
            <message-key key="no.abstract.class.modifier"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>