[jboss-cvs] JBossAS SVN: r74127 - projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip.

[jboss-cvs-commits at lists.jboss.org]

Author: alesj
Date: 2008-06-05 03:34:32 -0400 (Thu, 05 Jun 2008)
New Revision: 74127

Modified:
   projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileLockReaper.java
   projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileWrapper.java
Log:
javadocs

Modified: projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileLockReaper.java
===================================================================
--- projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileLockReaper.java	2008-06-05 03:56:05 UTC (rev 74126)
+++ projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileLockReaper.java	2008-06-05 07:34:32 UTC (rev 74127)
@@ -21,20 +21,20 @@
 */
 package org.jboss.virtual.plugins.context.zip;
 
-import org.jboss.logging.Logger;
-
 import java.util.Iterator;
+import java.util.Queue;
 import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.ConcurrentLinkedQueue;
 
+import org.jboss.logging.Logger;
+
 /**
  * A monitoring object that closes ZipFiles when they haven't been used for a while
  *
  * @author <a href="strukelj at parsek.net">Marko Strukelj</a>
  * @version $Revision: 1.0 $
  */
-
 public class ZipFileLockReaper
 {
    private static final Logger log = Logger.getLogger(ZipFileLockReaper.class);
@@ -55,7 +55,7 @@
    private static ZipFileLockReaper singleton;
 
    /** A list of monitored ZipFileWrappers */
-   private ConcurrentLinkedQueue monitored = new ConcurrentLinkedQueue();
+   private Queue<ZipFileWrapper> monitored = new ConcurrentLinkedQueue<ZipFileWrapper>();
 
    /** The number of monitored ZipFileWrappers */
    private int monitoredCount = 0;
@@ -66,13 +66,11 @@
    /** Timestamp of last unregister() call */
    private long lastUsed;
 
-
    /**
     * Private constructor - to force retrieval through {@link #getInstance()}
     */
    private ZipFileLockReaper()
    {
-
    }
 
    /** Factory method to be used to retrieve reference to ZipFileLockReaper */
@@ -84,8 +82,11 @@
       return singleton;
    }
 
-
-   /** Register a ZipFileWrapper instance with this reaper */
+   /**
+    * Register a ZipFileWrapper instance with this reaper
+    *
+    * @param w wrapper to register
+    */
    public synchronized void register(ZipFileWrapper w)
    {
       monitored.add(w);
@@ -98,7 +99,11 @@
       log.debug("Registered: " + w);
    }
 
-   /** Unregister a ZipFileWrapper instance from this reaper */
+   /**
+    * Unregister a ZipFileWrapper instance from this reaper
+    *
+    * @param w wrapper to unregister
+    */
    public synchronized void unregister(ZipFileWrapper w)
    {
       monitored.remove(w);
@@ -107,8 +112,6 @@
       log.debug("Unregistered: " + w);
    }
 
-
-
    /** Timer task that does the actual reaping */
    class ReaperTimerTask extends TimerTask
    {
@@ -164,5 +167,4 @@
          }
       }
    }
-
 }

Modified: projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileWrapper.java
===================================================================
--- projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileWrapper.java	2008-06-05 03:56:05 UTC (rev 74126)
+++ projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/context/zip/ZipFileWrapper.java	2008-06-05 07:34:32 UTC (rev 74127)
@@ -21,9 +21,6 @@
 */
 package org.jboss.virtual.plugins.context.zip;
 
-import org.jboss.logging.Logger;
-import org.jboss.virtual.VFSUtils;
-
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
@@ -36,6 +33,8 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
+import org.jboss.logging.Logger;
+import org.jboss.virtual.VFSUtils;
 
 /**
  * ZipFileWrapper - for abstracted access to zip files on disk
@@ -45,12 +44,10 @@
  * @author <a href="strukelj at parsek.net">Marko Strukelj</a>
  * @version $Revision: 1.0 $
  */
-
 class ZipFileWrapper extends ZipWrapper
 {
    private static final Logger log = Logger.getLogger(ZipFileWrapper.class);
 
-
    private static boolean forceNoReaper;
 
    static
@@ -76,14 +73,12 @@
    // used for debugging stream leaks
    //ConcurrentLinkedQueue<ZipEntryInputStream> streams = new ConcurrentLinkedQueue<ZipEntryInputStream>();
 
-
    ZipFileWrapper(File archive, boolean autoClean, boolean noReaperOverride)
    {
       this.noReaperOverride = noReaperOverride;
       init(archive, autoClean);
    }
 
-
    ZipFileWrapper(URI rootPathURI, boolean autoClean, boolean noReaperOverride)
    {
       this.noReaperOverride = noReaperOverride;
@@ -97,8 +92,8 @@
    /**
     * Extra initialization that didn't fit in constructors
     *
-    * @param archive
-    * @param autoClean
+    * @param archive the archive file
+    * @param autoClean auto clean flag
     */
    private void init(File archive, boolean autoClean)
    {
@@ -169,13 +164,11 @@
       return zis;
    }
 
-
    InputStream getRootAsStream() throws FileNotFoundException
    {
       return new FileInputStream(file);
    }
 
-
    synchronized void acquire() throws IOException
    {
       ensureZipFile();
@@ -220,7 +213,6 @@
       return super.toString() + " - " + file.getAbsolutePath();
    }
 
-
    private static class CheckNoReaper implements PrivilegedAction<Boolean>
    {
       public Boolean run()