ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From peterrei...@apache.org
Subject svn commit: r475983 - in /ant/core/trunk/src/main/org/apache/tools/ant/util: ./ regexp/
Date Thu, 16 Nov 2006 23:37:31 GMT
Author: peterreilly
Date: Thu Nov 16 15:37:30 2006
New Revision: 475983

URL: http://svn.apache.org/viewvc?view=rev&rev=475983
Log:
checkstyle

Modified:
    ant/core/trunk/src/main/org/apache/tools/ant/util/ClasspathUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/CollectionUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/DOMElementWriter.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/DOMUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/FileUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/JAXPUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/LazyFileOutputStream.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/LazyHashtable.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/LoaderUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/ResourceUtils.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/Retryable.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/XmlConstants.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java
    ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/ClasspathUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/ClasspathUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/ClasspathUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/ClasspathUtils.java Thu Nov 16 15:37:30
2006
@@ -25,6 +25,8 @@
 import org.apache.tools.ant.types.Path;
 import org.apache.tools.ant.types.Reference;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * Offers some helper methods on the Path structure in ant.
  *

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/CollectionUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/CollectionUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/CollectionUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/CollectionUtils.java Thu Nov 16 15:37:30
2006
@@ -23,6 +23,8 @@
 import java.util.Enumeration;
 import java.util.NoSuchElementException;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * A set of helper methods related to collection manipulation.
  *

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/DOMElementWriter.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/DOMElementWriter.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/DOMElementWriter.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/DOMElementWriter.java Thu Nov 16 15:37:30
2006
@@ -453,7 +453,8 @@
      * <code>&amp;#x5d;&amp;#x5d;&amp;gt;</code>.</p>
      *
      * <p>See XML 1.0 2.2 <a
-     * href="http://www.w3.org/TR/1998/REC-xml-19980210#charsets">http://www.w3.org/TR/1998/REC-xml-19980210#charsets</a>
and
+     * href="http://www.w3.org/TR/1998/REC-xml-19980210#charsets">
+     * http://www.w3.org/TR/1998/REC-xml-19980210#charsets</a> and
      * 2.7 <a
      * href="http://www.w3.org/TR/1998/REC-xml-19980210#sec-cdata-sect">http://www.w3.org/TR/1998/REC-xml-19980210#sec-cdata-sect</a>.</p>
      * @param value the value to be encoded.

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/DOMUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/DOMUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/DOMUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/DOMUtils.java Thu Nov 16 15:37:30 2006
@@ -23,6 +23,8 @@
 import org.w3c.dom.Element;
 import org.w3c.dom.Text;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * Some utility methods for common tasks when building DOM trees in memory.
  *

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/FileUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/FileUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/FileUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/FileUtils.java Thu Nov 16 15:37:30 2006
@@ -250,6 +250,7 @@
                  overwrite, preserveLastModified, encoding);
     }
 
+    // CheckStyle:ParameterNumberCheck OFF - bc
     /**
      * Convenience method to copy a file from a source to a
      * destination specifying if token filtering must be used, if
@@ -509,6 +510,8 @@
             filters, filterChains, overwrite, preserveLastModified,
             inputEncoding, outputEncoding, project);
     }
+
+    // CheckStyle:ParameterNumberCheck ON
 
     /**
      * Calls File.setLastModified(long time). Originally written to

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/JAXPUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/JAXPUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/JAXPUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/JAXPUtils.java Thu Nov 16 15:37:30 2006
@@ -29,6 +29,8 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.XMLReader;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * Collection of helper methods that retrieve a ParserFactory or
  * Parsers and Readers.

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/LazyFileOutputStream.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/LazyFileOutputStream.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/LazyFileOutputStream.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/LazyFileOutputStream.java Thu Nov 16
15:37:30 2006
@@ -103,6 +103,10 @@
         ensureOpened();
     }
 
+    /**
+     * Close the file.
+     * @throws IOException if there is an error.
+     */
     public synchronized void close() throws IOException {
         if (alwaysCreate && !closed) {
             ensureOpened();
@@ -115,19 +119,31 @@
 
     /**
      * Delegates to the three-arg version.
+     * @param b the bytearray to write.
+     * @throws IOException if there is a problem.
      */
     public void write(byte[] b) throws IOException {
         write(b, 0, b.length);
     }
 
-    //inherit doc
+    /**
+     * Write part of a byte array.
+     * @param b the byte array.
+     * @param offset write from this index.
+     * @param len    the number of bytes to write.
+     * @throws IOException if there is a probem.
+     */
     public synchronized void write(byte[] b, int offset, int len)
         throws IOException {
         ensureOpened();
         fos.write(b, offset, len);
     }
 
-    //inherit doc
+    /**
+     * Write a byte.
+     * @param b the byte to write.
+     * @throws IOException if there is a problem.
+     */
     public synchronized void write(int b) throws IOException {
         ensureOpened();
         fos.write(b);

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/LazyHashtable.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/LazyHashtable.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/LazyHashtable.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/LazyHashtable.java Thu Nov 16 15:37:30
2006
@@ -50,26 +50,48 @@
     }
 
 
+    /**
+     * Get a enumeration over the elements.
+     * @return an enumeration.
+     */
     public Enumeration elements() {
         initAll();
         return super.elements();
     }
 
+    /**
+     * Check if the table is empty.
+     * @return true if it is.
+     */
     public boolean isEmpty() {
         initAll();
         return super.isEmpty();
     }
 
+    /**
+     * Get the size of the table.
+     * @return the size.
+     */
     public int size() {
         initAll();
         return super.size();
     }
 
+    /**
+     * Check if the table contains a particular value.
+     * @param value the value to look for.
+     * @return true if the table contains the value.
+     */
     public boolean contains(Object value) {
         initAll();
         return super.contains(value);
     }
 
+    /**
+     * Check if the table contains a particular key.
+     * @param value the key to look for.
+     * @return true if the table contains key.
+     */
     public boolean containsKey(Object value) {
         initAll();
         return super.containsKey(value);
@@ -77,11 +99,17 @@
 
     /**
      * Delegates to {@link #contains contains}.
+     * @param value the value to look for.
+     * @return true if the table contains the value.
      */
     public boolean containsValue(Object value) {
         return contains(value);
     }
 
+    /**
+     * Get an enumeration over the keys.
+     * @return an enumeration.
+     */
     public Enumeration keys() {
         initAll();
         return super.keys();

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java Thu Nov 16
15:37:30 2006
@@ -75,6 +75,11 @@
     }
 
     //inherit doc
+    /**
+     * Read a byte from the stream.
+     * @return the byte (0 to 255) or -1 if there are no more.
+     * @throws IOException if there is an error.
+     */
     public synchronized int read() throws IOException {
         int result = -1;
         try {

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/LoaderUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/LoaderUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/LoaderUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/LoaderUtils.java Thu Nov 16 15:37:30
2006
@@ -21,6 +21,8 @@
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.launch.Locator;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * ClassLoader utility methods
  *

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/ResourceUtils.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/ResourceUtils.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/ResourceUtils.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/ResourceUtils.java Thu Nov 16 15:37:30
2006
@@ -52,6 +52,8 @@
 import org.apache.tools.ant.types.resources.selectors.ResourceSelector;
 import org.apache.tools.ant.types.selectors.SelectorUtils;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /**
  * This class provides utility methods to process Resources.
  *
@@ -59,7 +61,7 @@
  */
 public class ResourceUtils {
 
-    private static class Outdated implements ResourceSelector {
+    private static final class Outdated implements ResourceSelector {
         private Resource control;
         private long granularity;
         private Outdated(Resource control, long granularity) {
@@ -226,6 +228,7 @@
                      false, null, null, project);
     }
 
+    // CheckStyle:ParameterNumberCheck OFF - bc
     /**
      * Convenience method to copy content from one Resource to another
      * specifying whether token filtering must be used, whether filter chains
@@ -383,6 +386,7 @@
             setLastModified((Touchable) dest, source.getLastModified());
         }
     }
+    // CheckStyle:ParameterNumberCheck ON
 
     /**
      * Set the last modified time of an object implementing

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/Retryable.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/Retryable.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/Retryable.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/Retryable.java Thu Nov 16 15:37:30 2006
@@ -28,7 +28,7 @@
  */
 public interface Retryable {
     /** The value to use to never give up. */
-    public static final int RETRY_FOREVER = -1;
+    int RETRY_FOREVER = -1;
     /**
      * Called to execute the code.
      * @throws IOException if there is a problem.

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/XmlConstants.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/XmlConstants.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/XmlConstants.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/XmlConstants.java Thu Nov 16 15:37:30
2006
@@ -21,7 +21,9 @@
  * XML Parser constants, all kept in one place for ease of reuse
  * @see <a href="http://xml.apache.org/xerces-j/features.html">Xerces features</a>
  * @see <a href="http://xml.apache.org/xerces-j/properties.html">Xerces properties</a>
- * @see <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description">SAX.</a>
+ * @see <a href=
+ * "http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description"
+ * >SAX.</a>
  */
 
 public class XmlConstants {
@@ -47,10 +49,13 @@
     /** property for schema source */
     public static final String FEATURE_JAXP12_SCHEMA_SOURCE =
             "http://java.sun.com/xml/jaxp/properties/schemaSource";
+    /** the namespace for XML schema */
     public static final String URI_XSD =
             "http://www.w3.org/2001/XMLSchema";
+    /** the sax external entities feature */
     public static final String FEATURE_EXTERNAL_ENTITIES =
             "http://xml.org/sax/features/external-general-entities";
+    /** the apache.org/xml disalllow doctype decl feature */
     public static final String FEATURE_DISALLOW_DTD =
             "http://apache.org/xml/features/disallow-doctype-decl";
 }

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java Thu Nov 16
15:37:30 2006
@@ -94,6 +94,7 @@
     /**
      * Wrapper over RegexpMatcherFactory.createInstance that ensures that
      * we are dealing with a Regexp implementation.
+     * @param classname the name of the class to use.
      * @return the instance.
      * @throws BuildException if there is a problem.
      * @since 1.3

Modified: ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java?view=diff&rev=475983&r1=475982&r2=475983
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java Thu Nov 16 15:37:30
2006
@@ -17,6 +17,8 @@
  */
 package org.apache.tools.ant.util.regexp;
 
+// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
+
 /***
  * Regular expression utilities class which handles flag operations.
  *



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message