| career | drupal | java | mac | mysql | perl | scala | uml | unix  

Ant example source code file (checkstyle-config)

This example Ant source code file (checkstyle-config) is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Ant tags/keywords

avoidstarimport, checks, checks, checkstyle\:, checkstyle\:, crawl//dtd, crawl//dtd, illegalinstantiation, javadocmethod, nowhitespacebefore, simplifybooleanreturn, suppressioncommentfilter, todocomment, whitespacearound

The checkstyle-config source code

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "">

<module name="Checker">
  <module name="TreeWalker">
    <!-- Javadoc requirements -->
    <module name="JavadocType">
      <property name="scope" value="protected"/>
    <module name="JavadocMethod">
      <property name="scope" value="protected"/>
      <property name="allowUndeclaredRTE" value="true"/>
    <module name="JavadocVariable">
       <property name="scope" value="public"/>

    <!-- element naming -->
    <module name="PackageName"/>
    <module name="TypeName"/>
    <module name="ConstantName"/>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="MemberName"/>
    <module name="MethodName"/>
    <module name="ParameterName"/>
    <module name="StaticVariableName"/>

    <!-- required licence file -->
    <module name="Header">
        <property name="headerFile" value="${config.dir}/RequiredHeader.txt"/>
        <property name="ignoreLines" value="2"/>

    <!-- Import conventions -->
    <module name="AvoidStarImport"/>
    <module name="RedundantImport"/>
    <module name="UnusedImports"/>

    <!-- size limits -->
    <module name="FileLength"/>
    <module name="LineLength">
      <property name="max" value="100"/>
      <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
    <module name="MethodLength"/>
    <module name="ParameterNumber"/>

    <!-- whitespace checks -->
    <module name="EmptyForIteratorPad"/>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="OperatorWrap"/>
    <module name="ParenPad"/>
    <module name="TabCharacter"/>
    <module name="WhitespaceAfter"/>
    <module name="WhitespaceAround"/>

    <!-- Modifier Checks -->
    <module name="ModifierOrder"/>
    <module name="RedundantModifier"/>

    <!-- Checks for blocks -->
    <module name="AvoidNestedBlocks"/>
    <module name="EmptyBlock">
      <property name="option" value="text"/>
    <module name="LeftCurly"/>
    <module name="NeedBraces"/>
    <module name="RightCurly"/>

    <!-- Checks for common coding problems -->
    <module name="DoubleCheckedLocking"/>
    <module name="EmptyStatement"/>
    <module name="EqualsHashCode"/>
    <module name="IllegalInstantiation">
      <property name="classes" value="java.lang.Boolean"/>
    <module name="InnerAssignment"/>
    <module name="MagicNumber"/>
    <module name="MissingSwitchDefault"/>
    <module name="RedundantThrows">
      <property name="allowUnchecked" value="true"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>

    <!-- Checks for class design -->
    <module name="FinalClass"/>
    <module name="HideUtilityClassConstructor"/>
    <module name="InterfaceIsType"/>
    <module name="VisibilityModifier"/>

    <!-- Miscellaneous other checks. -->
    <module name="ArrayTypeStyle"/>
    <module name="GenericIllegalRegexp">
      <property name="format" value="\s+$"/>
      <property name="message" value="Line has trailing spaces."/>
    <module name="TodoComment"/>
    <module name="UpperEll"/>
    <!-- allow comment suppression of checks -->
    <module name="FileContentsHolder"/>
  <module name="SuppressionCommentFilter">
    <property name="offCommentFormat" value="CheckStyle\:([\w\|]+) *OFF"/>
    <property name="onCommentFormat" value="CheckStyle\:([\w\|]+) *ON"/>
    <property name="checkFormat" value="$1"/>

Other Ant examples (source code examples)

Here is a short list of links related to this Ant checkstyle-config source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.