[FOray-commit] SF.net SVN: foray: [10278] trunk/foray

[<vic...@us...>]

Revision: 10278
          http://foray.svn.sourceforge.net/foray/?rev=10278&view=rev
Author:   victormote
Date:     2007-11-10 07:20:35 -0800 (Sat, 10 Nov 2007)

Log Message:
-----------
Suppress checkstyle for the cases where a specific implementation must be used.

Modified Paths:
--------------
    trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
    trunk/foray/foray-graphic/src/java/org/foray/graphic/ImageConsumerImpl.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
    trunk/foray/scripts/checkstyle-config.xml

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java	2007-11-10 03:20:22 UTC (rev 10277)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java	2007-11-10 15:20:35 UTC (rev 10278)
@@ -78,11 +78,14 @@
     /** The list of markers in this document. */
     private List<Marker> documentMarkers = new ArrayList<Marker>();
 
+    /* Checkstyle-IllegalType-Off: This class depends on certain
+     * capabilities of ArrayList that are not part of the List interface. */
     /** The list of FOLinkage items for the nodes in the FOTree.
      * Each {@link FONode} in the {@link FOTree} has a unique index, which
      * indexes into this linkage map. */
     private ArrayList<FOLinkage> linkageMap = new ArrayList<FOLinkage>(
             AreaTree.INITIAL_LINKAGE_MAP_SIZE);
+    /* Checkstyle-IllegalType-On. */
 
     /**
      * An ordered list of all of the PageCollection objects that have been

Modified: trunk/foray/foray-graphic/src/java/org/foray/graphic/ImageConsumerImpl.java
===================================================================
--- trunk/foray/foray-graphic/src/java/org/foray/graphic/ImageConsumerImpl.java	2007-11-10 03:20:22 UTC (rev 10277)
+++ trunk/foray/foray-graphic/src/java/org/foray/graphic/ImageConsumerImpl.java	2007-11-10 15:20:35 UTC (rev 10278)
@@ -58,8 +58,11 @@
     /** The hints for the image. */
     private int hints = 0;
 
+    /* Checkstyle-IllegalType-Off: The Hashtable implementation is required
+     * by the superclass. */
     /** The properties. */
     private Hashtable<?, ?> properties;
+    /* Checkstyle-IllegalType-On. */
 
     /** The AWT color-model instance. */
     private ColorModel cm;
@@ -127,6 +130,7 @@
         this.width = width;
         this.height = height;
     }
+
     /**
      * {@inheritDoc}
      */
@@ -134,6 +138,9 @@
         // MessageHandler.errorln("setHints: " + hintflags);
         this.hints = hintflags;
     }
+
+    /* Checkstyle-IllegalType-Off: The Hashtable implementation is required
+     * by the superclass. */
     /**
      * {@inheritDoc}
      */
@@ -141,6 +148,7 @@
         // MessageHandler.errorln("setProperties: " + props);
         this.properties = props;
     }
+    /* Checkstyle-IllegalType-On. */
 
     /**
      * {@inheritDoc}

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2007-11-10 03:20:22 UTC (rev 10277)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2007-11-10 15:20:35 UTC (rev 10278)
@@ -128,11 +128,14 @@
     /** The initial size at which the linkage map should be created. */
     private static final short INITIAL_PROXY_MAP_SIZE = 200;
 
+    /* Checkstyle-IllegalType-Off: This class depends on certain
+     * capabilities of ArrayList that are not part of the List interface. */
     /** The list of FONodePL items for the nodes in the FOTree.
      * Each {@link FoNode} in the {@link FOTree} has a unique index, which
      * indexes into this proxy map. */
     private ArrayList<FONodePL> proxyMap = new ArrayList<FONodePL>(
             PioneerLS.INITIAL_PROXY_MAP_SIZE);
+    /* Checkstyle-IllegalType-On. */
 
     /** The line-breaker to be used by this layout system. */
     private EagerLineBreaker currentLineBreaker;

Modified: trunk/foray/scripts/checkstyle-config.xml
===================================================================
--- trunk/foray/scripts/checkstyle-config.xml	2007-11-10 03:20:22 UTC (rev 10277)
+++ trunk/foray/scripts/checkstyle-config.xml	2007-11-10 15:20:35 UTC (rev 10278)
@@ -16,8 +16,19 @@
     <property name="file" value="${foray.sandbox}/scripts/checkstyle-suppressions.xml"/>
   </module>
 
+  <!-- Allow otherwise Illegal Types to be used in certain circumstances. -->
+  <module name="SuppressionCommentFilter">
+    <property name="offCommentFormat" value="Checkstyle-IllegalType-Off"/>
+    <property name="onCommentFormat" value="Checkstyle-IllegalType-On"/>
+    <property name="checkFormat" value="IllegalType"/>
+  </module>
+
   <module name="TreeWalker">
 
+    <!-- Activate FileContentsHolder so that comments are visible to Checkstyle
+    and can be used to suppress warnings in allowed cases. -->
+    <module name="FileContentsHolder"/>
+
     <!-- Skip this one. -->
     <!--<module name="AbstractClassName"/>-->
     <module name="ConstantName"/>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.