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

Commons FileUpload example source code file (fileupload_checks.xml)

This example Commons FileUpload source code file (fileupload_checks.xml) is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Commons FileUpload tags/keywords

checks, checks, checkstyle, custom, disable, fileupload, fileupload, license, license, regexpheader, see, see, the, you

The Commons FileUpload fileupload_checks.xml source code

<?xml version="1.0"?>
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 See the License for the specific language governing permissions and
 limitations under the License.

    "-//Puppy Crawl//DTD Check Configuration 1.1//EN"

  Checkstyle configuration for Commons FileUpload. FileUpload uses the Sun
  coding guidelines, so this file is almost the same as Maven's sun_checks.xml
  file. The only changes from that file are:

    - Use a RegexpHeader check instead of a regular Header check, since the
      copyright years can vary per source file.

    - Disable the HiddenField module, since FileUpload has always used the
      " = foo" pattern, which is not recognised by this module.

    - Disable the DesignForExtension module, since fixing those complaints
      would result in backwards incompatible API changes.

    - Disable the FinalParameters module, since fixing those complaints
      would result in backwards incompatible API changes.

  Checkstyle configuration that checks the sun coding conventions from:

    - the Java Language Specification at

    - the Sun Code Conventions at

    - the Javadoc guidelines at

    - the JDK Api documentation

    - some best practices

  Checkstyle is very configurable. Be sure to read the documentation at (or in your downloaded distribution).

  Most Checks are configurable, be sure to consult the documentation.

  To completely disable a check, just comment it out or delete it from the file.

  Finally, it is worth reading the documentation.


<module name="Checker">

    <!-- Checks that a package.html file exists for each package.     -->
    <!-- See -->
    <module name="PackageHtml"/>

    <!-- Checks whether files end with a new line.                        -->
    <!-- See -->
    <module name="NewlineAtEndOfFile"/>

    <!-- Checks that property files contain the same keys.         -->
    <!-- See -->
    <module name="Translation"/>

    <module name="TreeWalker">

        <property name="cacheFile" value="${checkstyle.cache.file}"/>

        <!-- Checks for Javadoc comments.                     -->
        <!-- See -->
        <module name="JavadocMethod">
          <property name="allowUndeclaredRTE" value="true"/>
          <property name="allowThrowsTagsForSubclasses" value="true"/>
        <module name="JavadocType"/>
        <module name="JavadocVariable"/>
        <module name="JavadocStyle"/>

        <!-- Checks for Naming Conventions.                  -->
        <!-- See -->
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="PackageName"/>
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>

        <!-- Checks for Headers                              -->
        <!-- See -->
            <!-- The follow property value demonstrates the ability     -->
            <!-- to have access to ANT properties. In this case it uses -->
            <!-- the ${basedir} property to allow Checkstyle to be run  -->
            <!-- from any directory within a project. See property      -->
            <!-- expansion,                                             -->
            <!--        -->

        <!-- Following interprets the header file as regular expressions. -->
        <module name="RegexpHeader">
            <property name="headerFile" value="src/checkstyle/license-header.txt"/>

        <!-- Checks for imports                              -->
        <!-- See -->
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/> 
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>

        <!-- Checks for Size Violations.                    -->
        <!-- See -->
        <module name="FileLength"/>
        <!-- Begin Custom for FileUpload -->
        <module name="LineLength">
          <property name="ignorePattern" value="^ \* @version .*$"/>
        <!-- End Custom for FileUpload -->
        <module name="MethodLength"/>
        <module name="ParameterNumber"/>

        <!-- Checks for whitespace                               -->
        <!-- See -->
        <module name="EmptyForIteratorPad"/>
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="OperatorWrap"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="TabCharacter"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround"/>

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

        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See -->
        <module name="AvoidNestedBlocks"/>
        <!-- Begin Custom for FileUpload -->
        <module name="EmptyBlock">
          <property name="option" value="text"/>
        <!-- End Custom for FileUpload -->
        <module name="LeftCurly"/>
        <module name="NeedBraces"/>
        <module name="RightCurly"/>

        <!-- Checks for common coding problems               -->
        <!-- See -->
        <module name="AvoidInlineConditionals"/>
        <module name="DoubleCheckedLocking"/>    
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <!-- Disabled for FileUpload: module name="HiddenField"/ -->
        <module name="IllegalInstantiation"/>
        <module name="InnerAssignment"/>
        <module name="MagicNumber"/>
        <module name="MissingSwitchDefault"/>
        <module name="RedundantThrows"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>

        <!-- Checks for class design                         -->
        <!-- See -->
        <!-- Disabled for FileUpload: module name="DesignForExtension"/ -->
        <module name="FinalClass"/>
        <module name="HideUtilityClassConstructor"/>
        <module name="InterfaceIsType"/>
        <module name="VisibilityModifier"/>

        <!-- Miscellaneous other checks.                   -->
        <!-- See -->
        <module name="ArrayTypeStyle"/>
        <!-- Disabled for FileUpload: module name="FinalParameters"/ -->
        <module name="GenericIllegalRegexp">
            <property name="format" value="\s+$"/>
            <property name="message" value="Line has trailing spaces."/>
        <module name="TodoComment"/>
        <module name="UpperEll"/>



Other Commons FileUpload examples (source code examples)

Here is a short list of links related to this Commons FileUpload fileupload_checks.xml 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.