--- a/gnv-artifacts/src/main/java/de/intevation/gnv/utils/FileUtils.java	Thu Apr 08 11:31:44 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/utils/FileUtils.java	Thu Apr 08 13:10:39 2010 +0000
@@ -13,6 +13,9 @@
 import java.util.zip.ZipOutputStream;
 
 /**
+ * A helper class to provide some methods for working with files and
+ * directories.
+ * 
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
@@ -21,6 +24,11 @@
     private FileUtils() {
     }
 
+    /**
+     * Deletes everything in a directory.
+     *
+     * @param dir The directory.
+     */
     public final static void deleteContent(File dir) {
         if (dir == null || !dir.isDirectory()) {
             return;
@@ -36,6 +44,12 @@
         return;
     }
 
+    /**
+     * Delete <i>file</i> and everything in <i>file</i> if it is a directory.
+     *
+     * @param file The file or directory.
+     * @return true, if deletion was successful - otherwise false.
+     */
     public final static boolean deleteRecursive(File file) {
 
         if (file == null) {
@@ -56,6 +70,14 @@
         return file.delete();
     }
 
+    /**
+     * Put the given file or directory into a zip archive.
+     *
+     * @param file The file or directory.
+     * @param outputStream The stream to write the archive to.
+     * @throws IOException if an error occured while zip creation or writing to
+     * output stream.
+     */
     public static void createZipArchive(
         File         file,
         OutputStream outputStream
@@ -98,6 +120,9 @@
         out.finish();
     }
 
+    /**
+     * A class representing a directory with a prefix.
+     */
     private static final class PrefixDir {
 
         String prefix;
@@ -110,6 +135,15 @@
 
     } // class PrefixDir
 
+    /**
+     * Write a file to zip archive.
+     *
+     * @param prefix A prefix.
+     * @param file The file.
+     * @param out The output stream.
+     * @throws IOException if an error occured while writing to zip output
+     * stream.
+     */
     private static void copyFileToZip(
         String          prefix,
         File            file,