commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgo...@apache.org
Subject svn commit: r895278 [2/2] - in /commons/proper/vfs/trunk: ./ core/ core/src/main/java/org/apache/commons/vfs/provider/bzip2/ core/src/main/java/org/apache/commons/vfs/provider/ftp/ core/src/main/java/org/apache/commons/vfs/provider/http/ core/src/main/...
Date Sat, 02 Jan 2010 20:03:09 GMT
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystemConfigBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystemConfigBuilder.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystemConfigBuilder.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystemConfigBuilder.java Sat Jan  2 20:02:29 2010
@@ -25,22 +25,36 @@
 import java.io.Serializable;
 
 /**
- * The config builder for various sftp configuration options
+ * The config BUILDER for various sftp configuration options.
  *
  * @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
  * @version $Revision$ $Date$
  */
-public class SftpFileSystemConfigBuilder extends FileSystemConfigBuilder
+public final class SftpFileSystemConfigBuilder extends FileSystemConfigBuilder
 {
-    private final static SftpFileSystemConfigBuilder builder = new SftpFileSystemConfigBuilder();
+    /** HTTP Proxy. */
+    public static final ProxyType PROXY_HTTP = new ProxyType("http");
+    /** SOCKS Proxy. */
+    public static final ProxyType PROXY_SOCKS5 = new ProxyType("socks");
+
+    private static final SftpFileSystemConfigBuilder BUILDER = new SftpFileSystemConfigBuilder();
+    private static final String USER_DIR_IS_ROOT = SftpFileSystemConfigBuilder.class.getName() + ".USER_DIR_IS_ROOT";
+    private static final String TIMEOUT = SftpFileSystemConfigBuilder.class.getName() + ".TIMEOUT";
 
-    private final static String USER_DIR_IS_ROOT = SftpFileSystemConfigBuilder.class.getName() + ".USER_DIR_IS_ROOT";
-    private final static String TIMEOUT = SftpFileSystemConfigBuilder.class.getName() + ".TIMEOUT";
+    private SftpFileSystemConfigBuilder()
+    {
+        super("sftp.");
+    }
 
-    public final static ProxyType PROXY_HTTP = new ProxyType("http");
-    public final static ProxyType PROXY_SOCKS5 = new ProxyType("socks");
+    public static SftpFileSystemConfigBuilder getInstance()
+    {
+        return BUILDER;
+    }
 
-    public static class ProxyType implements Serializable, Comparable
+    /**
+     * Proxy type.
+     */
+    public static final class ProxyType implements Serializable, Comparable
     {
         private final String proxyType;
 
@@ -54,7 +68,6 @@
             return proxyType.compareTo(((ProxyType) o).proxyType);
         }
 
-
         public boolean equals(Object o)
         {
             if (this == o)
@@ -75,24 +88,19 @@
 
             return true;
         }
-    }
 
-    public static SftpFileSystemConfigBuilder getInstance()
-    {
-        return builder;
-    }
-
-    private SftpFileSystemConfigBuilder()
-    {
-        super("sftp.");
+        public int hashCode()
+        {
+            return proxyType.hashCode();
+        }
     }
 
     /**
      * Set the userinfo class to use if e.g. a password or a not known host
-     * will be contacted
+     * will be contacted.
      *
-     * @param opts
-     * @param info
+     * @param opts The FileSystem options.
+     * @param info User information.
      */
     public void setUserInfo(FileSystemOptions opts, UserInfo info)
     {
@@ -100,7 +108,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystem options.
+     * @return The UserInfo.
      * @see #setUserInfo
      */
     public UserInfo getUserInfo(FileSystemOptions opts)
@@ -112,8 +121,9 @@
      * Set the known_hosts file. e.g. /home/user/.ssh/known_hosts2<br>
      * Need to use a java.io.File as JSch cant deal with vfs FileObjects ;-)
      *
-     * @param opts
-     * @param sshdir
+     * @param opts The FileSystem options.
+     * @param sshdir The known hosts directory.
+     * @throws FileSystemException if an error occurs.
      */
     public void setKnownHosts(FileSystemOptions opts, File sshdir) throws FileSystemException
     {
@@ -121,7 +131,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystem options.
+     * @return the known hosts File.
      * @see #setKnownHosts
      */
     public File getKnownHosts(FileSystemOptions opts)
@@ -133,8 +144,9 @@
      * Set the identity files (your private key files).<br>
      * Need to use a java.io.File as JSch cant deal with vfs FileObjects ;-)
      *
-     * @param opts
-     * @param identities
+     * @param opts The FileSystem options.
+     * @param identities An array of identity Files.
+     * @throws FileSystemException if an error occurs.
      */
     public void setIdentities(FileSystemOptions opts, File[] identities) throws FileSystemException
     {
@@ -146,9 +158,9 @@
      * e.g. pass "zlib,none" to enable the compression.<br>
      * See the jsch documentation for details.
      *
-     * @param opts
-     * @param compression
-     * @throws FileSystemException
+     * @param opts The FileSystem options.
+     * @param compression The compression algorithm name.
+     * @throws FileSystemException if an error occurs.
      */
     public void setCompression(FileSystemOptions opts, String compression) throws FileSystemException
     {
@@ -156,7 +168,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystem options.
+     * @return The name of the compression algorithm.
      * @see #setCompression
      */
     public String getCompression(FileSystemOptions opts)
@@ -165,7 +178,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystem options.
+     * @return the array of identity Files.
      * @see #setIdentities
      */
     public File[] getIdentities(FileSystemOptions opts)
@@ -178,13 +192,14 @@
      * valid arguments are only yes, no and ask.<br>
      * See the jsch documentation for details.
      *
-     * @param opts
-     * @param hostKeyChecking
-     * @throws FileSystemException
+     * @param opts The FileSystem options.
+     * @param hostKeyChecking The host key checking to use.
+     * @throws FileSystemException if an error occurs.
      */
     public void setStrictHostKeyChecking(FileSystemOptions opts, String hostKeyChecking) throws FileSystemException
     {
-        if (hostKeyChecking == null || (!hostKeyChecking.equals("ask") && !hostKeyChecking.equals("no") && !hostKeyChecking.equals("yes")))
+        if (hostKeyChecking == null || (!hostKeyChecking.equals("ask") && !hostKeyChecking.equals("no") &&
+            !hostKeyChecking.equals("yes")))
         {
             throw new FileSystemException("vfs.provider.sftp/StrictHostKeyChecking-arg.error", hostKeyChecking);
         }
@@ -193,8 +208,8 @@
     }
 
     /**
-     * @param opts
-     * @return the option value
+     * @param opts The FileSystem options.
+     * @return the option value The host key checking.
      * @see #setStrictHostKeyChecking(FileSystemOptions, String)
      */
     public String getStrictHostKeyChecking(FileSystemOptions opts)
@@ -203,10 +218,10 @@
     }
 
     /**
-     * use user directory as root (do not change to fs root)
+     * use user directory as root (do not change to fs root).
      *
-     * @param opts
-     * @param userDirIsRoot
+     * @param opts The FileSystem options.
+     * @param userDirIsRoot true if the user dir is the root directory.
      */
     public void setUserDirIsRoot(FileSystemOptions opts, boolean userDirIsRoot)
     {
@@ -214,7 +229,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystemOptions.
+     * @return true if the user directory is the root.
      * @see #setUserDirIsRoot
      */
     public Boolean getUserDirIsRoot(FileSystemOptions opts)
@@ -223,10 +239,10 @@
     }
 
     /**
-     * set the timeout value on jsch session
+     * set the timeout value on jsch session.
      *
-     * @param opts
-     * @param timeout
+     * @param opts The FileSystem options.
+     * @param timeout The timeout.
      */
     public void setTimeout(FileSystemOptions opts, Integer timeout)
     {
@@ -234,7 +250,8 @@
     }
 
     /**
-     * @param opts
+     * @param opts The FileSystem options.
+     * @return The timeout value.
      * @see #setTimeout
      */
     public Integer getTimeout(FileSystemOptions opts)
@@ -251,6 +268,7 @@
      * Set the proxy to use for sftp connection.<br>
      * You have to set the ProxyPort too if you would like to have the proxy relly used.
      *
+     * @param opts The FileSystem options.
      * @param proxyHost the host
      * @see #setProxyPort
      */
@@ -260,9 +278,10 @@
     }
 
     /**
-     * Set the proxy-port to use for sftp connection
+     * Set the proxy-port to use for sftp connection.
      * You have to set the ProxyHost too if you would like to have the proxy relly used.
      *
+     * @param opts The FileSystem options.
      * @param proxyPort the port
      * @see #setProxyHost
      */
@@ -272,9 +291,10 @@
     }
 
     /**
-     * Get the proxy to use for sftp connection
+     * Get the proxy to use for sftp connection.
      * You have to set the ProxyPort too if you would like to have the proxy relly used.
      *
+     * @param opts The FileSystem options.
      * @return proxyHost
      * @see #setProxyPort
      */
@@ -287,6 +307,7 @@
      * Get the proxy-port to use for sftp the connection
      * You have to set the ProxyHost too if you would like to have the proxy relly used.
      *
+     * @param opts The FileSystem options.
      * @return proxyPort: the port number or 0 if it is not set
      * @see #setProxyHost
      */
@@ -297,6 +318,8 @@
 
     /**
      * Set the proxy type to use for sftp connection.
+     * @param opts The FileSystem options.
+     * @param proxyType the type of the proxy to use.
      */
     public void setProxyType(FileSystemOptions opts, ProxyType proxyType)
     {
@@ -305,6 +328,8 @@
 
     /**
      * Get the proxy type to use for sftp connection.
+     * @param opts The FileSystem options.
+     * @return The ProxyType.
      */
     public ProxyType getProxyType(FileSystemOptions opts)
     {
@@ -312,18 +337,22 @@
     }
 
     /**
-    * Configure authentication order
-    */
+     * Configure authentication order.
+     * @param opts The FileSystem options.
+     * @param preferredAuthentications The authentication order.
+     */
     public void setPreferredAuthentications(FileSystemOptions opts, String preferredAuthentications)
     {
-        setParam(opts,"PreferredAuthentications",preferredAuthentications);
+        setParam(opts, "PreferredAuthentications", preferredAuthentications);
     }
-  
+
     /**
-    * Get authentication order
-    */
+     * Get authentication order.
+     * @param opts The FileSystem options.
+     * @return The authentication order.
+     */
     public String getPreferredAuthentications(FileSystemOptions opts)
     {
-        return (String) getParam(opts,"PreferredAuthentications");
+        return (String) getParam(opts, "PreferredAuthentications");
     }
 }

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpRandomAccessContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpRandomAccessContent.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpRandomAccessContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpRandomAccessContent.java Sat Jan  2 20:02:29 2010
@@ -25,11 +25,16 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+/**
+ * Random access content.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
+ */
 class SftpRandomAccessContent extends AbstractRandomAccessStreamContent
 {
-    private final SftpFileObject fileObject;
-
+    /** file pointer */
     protected long filePointer = 0;
+
+    private final SftpFileObject fileObject;
     private DataInputStream dis = null;
     private InputStream mis = null;
 
@@ -91,22 +96,22 @@
                 return ret;
             }
 
-            public int read(byte b[]) throws IOException
+            public int read(byte[] b) throws IOException
             {
                 int ret = super.read(b);
                 if (ret > -1)
                 {
-                    filePointer+=ret;
+                    filePointer += ret;
                 }
                 return ret;
             }
 
-            public int read(byte b[], int off, int len) throws IOException
+            public int read(byte[] b, int off, int len) throws IOException
             {
                 int ret = super.read(b, off, len);
                 if (ret > -1)
                 {
-                    filePointer+=ret;
+                    filePointer += ret;
                 }
                 return ret;
             }
@@ -140,4 +145,4 @@
     {
         return fileObject.getContent().getSize();
     }
-}
\ No newline at end of file
+}

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/TrustEveryoneUserInfo.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/TrustEveryoneUserInfo.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/TrustEveryoneUserInfo.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/TrustEveryoneUserInfo.java Sat Jan  2 20:02:29 2010
@@ -21,7 +21,8 @@
 import org.apache.commons.logging.LogFactory;
 
 /**
- * Helper class to trust a new host
+ * Helper class to trust a new host.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class TrustEveryoneUserInfo implements UserInfo
 {
@@ -61,4 +62,4 @@
     {
         log.debug(s);
     }
-}
\ No newline at end of file
+}

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarBuffer.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarBuffer.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarBuffer.java Sat Jan  2 20:02:29 2010
@@ -256,7 +256,7 @@
         {
             if (!readBlock())
             {
-                return;// UNDONE
+                return; // UNDONE
             }
         }
 

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarConstants.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarConstants.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarConstants.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarConstants.java Sat Jan  2 20:02:29 2010
@@ -84,42 +84,42 @@
     /**
      * Normal file type.
      */
-    byte LF_NORMAL = (byte)'0';
+    byte LF_NORMAL = (byte) '0';
 
     /**
      * Link file type.
      */
-    byte LF_LINK = (byte)'1';
+    byte LF_LINK = (byte) '1';
 
     /**
      * Symbolic link file type.
      */
-    byte LF_SYMLINK = (byte)'2';
+    byte LF_SYMLINK = (byte) '2';
 
     /**
      * Character device file type.
      */
-    byte LF_CHR = (byte)'3';
+    byte LF_CHR = (byte) '3';
 
     /**
      * Block device file type.
      */
-    byte LF_BLK = (byte)'4';
+    byte LF_BLK = (byte) '4';
 
     /**
      * Directory file type.
      */
-    byte LF_DIR = (byte)'5';
+    byte LF_DIR = (byte) '5';
 
     /**
      * FIFO (pipe) file type.
      */
-    byte LF_FIFO = (byte)'6';
+    byte LF_FIFO = (byte) '6';
 
     /**
      * Contiguous file type.
      */
-    byte LF_CONTIG = (byte)'7';
+    byte LF_CONTIG = (byte) '7';
 
     /**
      * The magic tag representing a POSIX tar archive.
@@ -139,5 +139,5 @@
     /**
      * Identifies the *next* file on the tape as having a long name.
      */
-    byte LF_GNUTYPE_LONGNAME = (byte)'L';
+    byte LF_GNUTYPE_LONGNAME = (byte) 'L';
 }

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarEntry.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarEntry.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarEntry.java Sat Jan  2 20:02:29 2010
@@ -605,9 +605,19 @@
      * @param other Entry to be checked for equality.
      * @return True if the entries are equal.
      */
-    public boolean equals(final TarEntry other)
+    public boolean equals(final Object other)
     {
-        return getName().equals(other.getName());
+        if (!(other instanceof TarEntry))
+        {
+            return false;
+        }
+        TarEntry entry = (TarEntry) other;
+        return getName().equals(entry.getName());
+    }
+
+    public int hashCode()
+    {
+        return getName().hashCode();
     }
 
     /**

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileObject.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileObject.java Sat Jan  2 20:02:29 2010
@@ -29,14 +29,16 @@
 
 /**
  * A file in a Tar file system.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class TarFileObject
     extends AbstractFileObject
     implements FileObject
 {
+    /** The TarEntry */
+    protected TarEntry entry;
     private final HashSet children = new HashSet();
     private final TarFileSystem fs;
-    protected TarEntry entry;
     private FileType type;
 
     protected TarFileObject(FileName name,
@@ -87,6 +89,7 @@
      * Determines if this file can be written to.
      *
      * @return <code>true</code> if this file is writeable, <code>false</code> if not.
+     * @throws FileSystemException if an error occurs.
      */
     public boolean isWriteable() throws FileSystemException
     {

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileProvider.java Sat Jan  2 20:02:29 2010
@@ -33,12 +33,14 @@
 
 /**
  * A file system provider for Tar files.  Provides read-only file systems.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class TarFileProvider
     extends AbstractLayeredFileProvider
     implements FileProvider
 {
-    protected final static Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
+    /** The provider's capabilities */
+    protected static final Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
         {
             Capability.GET_LAST_MODIFIED,
             Capability.GET_TYPE,

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileSystem.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileSystem.java Sat Jan  2 20:02:29 2010
@@ -51,7 +51,7 @@
     extends AbstractFileSystem
     implements FileSystem
 {
-    private final static Log log = LogFactory.getLog(TarFileSystem.class);
+    private static final Log LOG = LogFactory.getLog(TarFileSystem.class);
 
     private final File file;
     private TarInputStream tarFile;
@@ -207,7 +207,8 @@
             }
             else if ("tbz2".equalsIgnoreCase(getRootName().getScheme()))
             {
-                return new TarInputStream(Bzip2FileObject.wrapInputStream(file.getAbsolutePath(), new FileInputStream(file)));
+                return new TarInputStream(Bzip2FileObject.wrapInputStream(file.getAbsolutePath(),
+                    new FileInputStream(file)));
             }
             return new TarInputStream(new FileInputStream(file));
         }
@@ -231,7 +232,7 @@
         catch (final IOException e)
         {
             // getLogger().warn("vfs.provider.tar/close-tar-file.error :" + file, e);
-            VfsLog.warn(getLogger(), log, "vfs.provider.tar/close-tar-file.error :" + file, e);
+            VfsLog.warn(getLogger(), LOG, "vfs.provider.tar/close-tar-file.error :" + file, e);
         }
     }
 

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarUtils.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarUtils.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarUtils.java Sat Jan  2 20:02:29 2010
@@ -23,9 +23,16 @@
  * @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
  * @version $Revision$ $Date$
  */
-class TarUtils
+final class TarUtils
 {
     /**
+     * Private constructor since this is a utility class with only static methods.
+     */
+    private TarUtils()
+    {
+    }
+
+    /**
      * Parse the checksum octal integer from a header buffer.
      *
      * @param offset The offset into the buffer from which to parse.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/Tbz2FileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/Tbz2FileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/Tbz2FileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/Tbz2FileProvider.java Sat Jan  2 20:02:29 2010
@@ -22,12 +22,14 @@
 
 /**
  * A file system provider for Tar files.  Provides read-only file systems.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class Tbz2FileProvider extends CompositeFileProvider
 {
-    protected final static Collection capabilities = TarFileProvider.capabilities;
+    /** The provider's capabilities */
+    protected static final Collection capabilities = TarFileProvider.capabilities;
 
-    private final static String[] SCHEMES = new String[]
+    private static final String[] SCHEMES = new String[]
     {
         "bz2",
         "tar"

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TgzFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TgzFileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TgzFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TgzFileProvider.java Sat Jan  2 20:02:29 2010
@@ -22,12 +22,14 @@
 
 /**
  * A file system provider for Tar files.  Provides read-only file systems.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class TgzFileProvider extends CompositeFileProvider
 {
-    protected final static Collection capabilities = TarFileProvider.capabilities;
+    /** The provider's capabilities */
+    protected static final Collection capabilities = TarFileProvider.capabilities;
 
-    private final static String[] SCHEMES = new String[]
+    private static final String[] SCHEMES = new String[]
     {
         "gz",
         "tar"

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/temp/TemporaryFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/temp/TemporaryFileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/temp/TemporaryFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/temp/TemporaryFileProvider.java Sat Jan  2 20:02:29 2010
@@ -87,8 +87,14 @@
 
     /**
      * Locates a file object, by absolute URI.
+     * @param baseFile The base FileObject.
+     * @param uri The URI of the file to be located.
+     * @param properties FileSystemOptions to use to locate or create the file.
+     * @return The FileObject.
+     * @throws FileSystemException if an error occurs.
      */
-    public synchronized FileObject findFile(final FileObject baseFile, final String uri, final FileSystemOptions properties)
+    public synchronized FileObject findFile(final FileObject baseFile, final String uri,
+                                            final FileSystemOptions properties)
         throws FileSystemException
     {
         // Parse the name

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileName.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileName.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileName.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileName.java Sat Jan  2 20:02:29 2010
@@ -20,15 +20,26 @@
 import org.apache.commons.vfs.provider.URLFileName;
 
 /**
- * Created by IntelliJ IDEA.
- * User: im
- * Date: 28.06.2005
- * Time: 16:00:19
- * To change this template use File | Settings | File Templates.
+ * A URL FileName.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
  */
 public class UrlFileName extends URLFileName
 {
-    public UrlFileName(final String scheme, final String hostName, final int port, final int defaultPort, final String userName, final String password, final String path, final FileType type, final String queryString)
+    /**
+     * The constructor.
+     * @param scheme The scheme to use.
+     * @param hostName The host name.
+     * @param port The port.
+     * @param defaultPort The default port.
+     * @param userName The user's login id.
+     * @param password The user's credentials.
+     * @param path The file path.
+     * @param type The file type.
+     * @param queryString Parameters to use when locating or creating the file name.
+     */
+    public UrlFileName(final String scheme, final String hostName, final int port, final int defaultPort,
+                       final String userName, final String password, final String path, final FileType type,
+                       final String queryString)
     {
         super(scheme, hostName, port, defaultPort, userName, password, path, type, queryString);
     }

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileNameParser.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileNameParser.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileNameParser.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileNameParser.java Sat Jan  2 20:02:29 2010
@@ -46,7 +46,16 @@
         return super.encodeCharacter(ch) || ch == '?';
     }
 
-    public FileName parseUri(final VfsComponentContext context, final FileName base, final String filename) throws FileSystemException
+  /**
+   * Parse a URI.
+   * @param context The component context.
+   * @param base The base FileName.
+   * @param filename The target file name.
+   * @return The FileName.
+   * @throws FileSystemException if an error occurs
+   */
+    public FileName parseUri(final VfsComponentContext context, final FileName base, final String filename)
+        throws FileSystemException
     {
         if (isUrlBased(base, filename))
         {
@@ -77,14 +86,14 @@
     /**
      * This method counts the slashes after the scheme.
      *
-     * @param filename
-     * @return nuof slashes
+     * @param filename The file name.
+     * @return number of slashes
      */
     protected int countSlashes(final String filename)
     {
         int state = 0;
         int nuofSlash = 0;
-        for (int pos = 0; pos<filename.length(); pos++)
+        for (int pos = 0; pos < filename.length(); pos++)
         {
             char c = filename.charAt(pos);
             if (state == 0)

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/url/UrlFileProvider.java Sat Jan  2 20:02:29 2010
@@ -40,7 +40,8 @@
 public class UrlFileProvider
     extends AbstractFileProvider
 {
-    protected final static Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
+    /** The provider's capabilities */
+    protected static final Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
     {
         Capability.READ_CONTENT,
         Capability.URI,
@@ -55,6 +56,11 @@
 
     /**
      * Locates a file object, by absolute URI.
+     * @param baseFile The base FileObject.
+     * @param uri The uri of the file to locate.
+     * @param fileSystemOptions The FileSystemOptions
+     * @return The FileObject
+     * @throws FileSystemException if an error occurs.
      */
     public synchronized FileObject findFile(final FileObject baseFile,
                                             final String uri,

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileObject.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileObject.java Sat Jan  2 20:02:29 2010
@@ -344,7 +344,7 @@
         {
             throw fse;
         }
-        catch(Exception e)
+        catch (Exception e)
         {
             throw new FileSystemException("vfs.provider.webdav/propfind.error", getName(), e);
         }

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileObject.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileObject.java Sat Jan  2 20:02:29 2010
@@ -36,10 +36,12 @@
     extends AbstractFileObject
     implements FileObject
 {
+    /** The ZipEntry. */
+    protected ZipEntry entry;
     private final HashSet children = new HashSet();
     private final ZipFileSystem fs;
     // protected final ZipFile file;
-    protected ZipEntry entry;
+
     private FileType type;
 
     protected ZipFileObject(FileName name,
@@ -79,7 +81,8 @@
     }
 
     /**
-     * Attaches a child
+     * Attaches a child.
+     * @param childName The name of the child.
      */
     public void attachChild(FileName childName)
     {
@@ -90,6 +93,7 @@
      * Determines if this file can be written to.
      *
      * @return <code>true</code> if this file is writeable, <code>false</code> if not.
+     * @throws FileSystemException if an error occurs.
      */
     public boolean isWriteable() throws FileSystemException
     {

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileProvider.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileProvider.java Sat Jan  2 20:02:29 2010
@@ -41,7 +41,8 @@
     extends AbstractLayeredFileProvider
     implements FileProvider
 {
-    protected final static Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
+    /** The list of capabilities this provider supports */
+    protected static final Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
         {
             Capability.GET_LAST_MODIFIED,
             Capability.GET_TYPE,

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileSystem.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileSystem.java Sat Jan  2 20:02:29 2010
@@ -47,12 +47,12 @@
     extends AbstractFileSystem
     implements FileSystem
 {
-    private final static Log log = LogFactory.getLog(ZipFileSystem.class);
+    private static final Log LOG = LogFactory.getLog(ZipFileSystem.class);
 
     private final File file;
     private ZipFile zipFile;
 
-    public ZipFileSystem(final FileName rootName,
+  public ZipFileSystem(final FileName rootName,
                          final FileObject parentLayer,
                          final FileSystemOptions fileSystemOptions)
         throws FileSystemException
@@ -173,7 +173,7 @@
         catch (final IOException e)
         {
             // getLogger().warn("vfs.provider.zip/close-zip-file.error :" + file, e);
-            VfsLog.warn(getLogger(), log, "vfs.provider.zip/close-zip-file.error :" + file, e);
+            VfsLog.warn(getLogger(), LOG, "vfs.provider.zip/close-zip-file.error :" + file, e);
         }
     }
 

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java Sat Jan  2 20:02:29 2010
@@ -64,6 +64,7 @@
 
     /**
      * Sets the destination file.
+     * @param destFile The destination file name.
      */
     public void setDestFile(final String destFile)
     {
@@ -72,6 +73,7 @@
 
     /**
      * Sets the destination directory.
+     * @param destDir The destination directory.
      */
     public void setDestDir(final String destDir)
     {
@@ -79,7 +81,8 @@
     }
 
     /**
-     * Sets the source file
+     * Sets the source file.
+     * @param srcFile The source file name.
      */
     public void setSrc(final String srcFile)
     {
@@ -89,7 +92,8 @@
     }
 
     /**
-     * Sets the source directory
+     * Sets the source directory.
+     * @param srcDir The source directory.
      */
     public void setSrcDir(final String srcDir)
     {
@@ -98,6 +102,7 @@
 
     /**
      * Sets whether the source directory should be consider as the base directory.
+     * @param srcDirIsBase true if the source directory is the base directory.
      */
     public void setSrcDirIsBase(final boolean srcDirIsBase)
     {
@@ -105,7 +110,8 @@
     }
 
     /**
-     * Sets whether we should fail if there was an error or not
+     * Sets whether we should fail if there was an error or not.
+     * @param failonerror true if the operation should fail if there is an error.
      */
     public void setFailonerror(final boolean failonerror)
     {
@@ -113,7 +119,8 @@
     }
 
     /**
-     * Sets whether we should fail if there was an error or not
+     * Sets whether we should fail if there was an error or not.
+     * @return true if the operation should fail if there was an error.
      */
     public boolean isFailonerror()
     {
@@ -121,7 +128,8 @@
     }
 
     /**
-     * Sets the files to includes
+     * Sets the files to includes.
+     * @param filesList The list of files to include.
      */
     public void setIncludes(final String filesList)
     {
@@ -129,7 +137,9 @@
     }
 
     /**
-     * Adds a nested <src> element.
+     * Adds a nested &lt;src&gt; element.
+     * @param srcInfo A nested source element.
+     * @throws BuildException if the SourceInfo doesn't reference a file.
      */
     public void addConfiguredSrc(final SourceInfo srcInfo)
         throws BuildException
@@ -144,6 +154,7 @@
 
     /**
      * Executes this task.
+     * @throws BuildException if an error occurs.
      */
     public void execute() throws BuildException
     {
@@ -238,7 +249,7 @@
 
         // Locate the source files, and make sure they exist
         FileName srcDirName = null;
-        if (srcDirUrl !=null )
+        if (srcDirUrl != null)
         {
             srcDirName = resolveFile(srcDirUrl).getName();
         }
@@ -289,7 +300,8 @@
             {
                 // Find matching files
                 // If srcDirIsBase is true, select also the sub-directories
-                final FileObject[] files = rootFile.findFiles(srcDirIsBase ? Selectors.SELECT_ALL : Selectors.SELECT_FILES);
+                final FileObject[] files = rootFile.findFiles(srcDirIsBase
+                    ? Selectors.SELECT_ALL : Selectors.SELECT_FILES);
 
                 for (int j = 0; j < files.length; j++)
                 {

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/CopyTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/CopyTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/CopyTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/CopyTask.java Sat Jan  2 20:02:29 2010
@@ -31,11 +31,12 @@
 public class CopyTask
     extends AbstractSyncTask
 {
-    private boolean overwrite = false;
+    private boolean overwrite;
     private boolean preserveLastModified = true;
 
     /**
      * Enable/disable overwriting of up-to-date files.
+     * @param overwrite true if the file should be overwritten.
      */
     public void setOverwrite(boolean overwrite)
     {
@@ -44,6 +45,7 @@
 
     /**
      * Enable/disable preserving last modified time of copied files.
+     * @param preserveLastModified true if the last modified time should be preserved.
      */
     public void setPreserveLastModified(boolean preserveLastModified)
     {
@@ -51,7 +53,7 @@
     }
 
     /**
-     * @return the curent value of overwrite
+     * @return the current value of overwrite
      */
     public boolean isOverwrite()
     {
@@ -59,7 +61,7 @@
     }
 
     /**
-     * @return the curent value of preserveLastModified
+     * @return the current value of preserveLastModified
      */
     public boolean isPreserveLastModified()
     {
@@ -68,6 +70,8 @@
 
     /**
      * Handles an out-of-date file.
+     * @param srcFile The source FileObject.
+     * @param destFile The destination FileObject.
      */
     protected void handleOutOfDateFile(final FileObject srcFile,
                                        final FileObject destFile)
@@ -75,9 +79,9 @@
     {
         log("Copying " + srcFile + " to " + destFile);
         destFile.copyFrom(srcFile, Selectors.SELECT_SELF);
-        if (preserveLastModified  &&
-                srcFile.getFileSystem().hasCapability(Capability.GET_LAST_MODIFIED) &&
-                destFile.getFileSystem().hasCapability(Capability.SET_LAST_MODIFIED_FILE))
+        if (preserveLastModified
+            && srcFile.getFileSystem().hasCapability(Capability.GET_LAST_MODIFIED)
+            && destFile.getFileSystem().hasCapability(Capability.SET_LAST_MODIFIED_FILE))
         {
             final long lastModTime = srcFile.getContent().getLastModifiedTime();
             destFile.getContent().setLastModifiedTime(lastModTime);
@@ -86,6 +90,8 @@
 
     /**
      * Handles an up-to-date file.
+     * @param srcFile The source FileObject.
+     * @param destFile The destination FileObject.
      */
     protected void handleUpToDateFile(final FileObject srcFile,
                                       final FileObject destFile)

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/DeleteTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/DeleteTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/DeleteTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/DeleteTask.java Sat Jan  2 20:02:29 2010
@@ -40,7 +40,7 @@
     /**
      * Sets the file/folder to delete.
      *
-     * @param file
+     * @param file The name of the file.
      */
     public void setFile(final String file)
     {
@@ -48,7 +48,8 @@
     }
 
     /**
-     * Sets the source directory
+     * Sets the source directory.
+     * @param srcDir The source directory.
      */
     public void setSrcDir(final String srcDir)
     {
@@ -56,7 +57,8 @@
     }
 
     /**
-     * Sets the files to includes
+     * Sets the files to include.
+     * @param filesList The list of files.
      */
     public void setIncludes(final String filesList)
     {
@@ -65,6 +67,7 @@
 
     /**
      * Executes this task.
+     * @throws BuildException if an error occurs.
      */
     public void execute() throws BuildException
     {

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MkdirTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MkdirTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MkdirTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MkdirTask.java Sat Jan  2 20:02:29 2010
@@ -35,7 +35,7 @@
     /**
      * Sets the directory to create.
      *
-     * @param dir
+     * @param dir The directory name.
      */
     public void setDir(final String dir)
     {
@@ -44,6 +44,7 @@
 
     /**
      * Executes the task.
+     * @throws BuildException if an exception occurs.
      */
     public void execute() throws BuildException
     {

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MoveTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MoveTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MoveTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MoveTask.java Sat Jan  2 20:02:29 2010
@@ -31,10 +31,11 @@
 public class MoveTask
     extends CopyTask
 {
-    private boolean tryRename = false;
+    private boolean tryRename;
 
     /**
-     * Enable/disable move/rename of file (if possible)
+     * Enable/disable move/rename of file (if possible).
+     * @param tryRename true if the file should be renamed.
      */
     public void setTryRename(boolean tryRename)
     {
@@ -59,8 +60,8 @@
         {
             log("Rename " + srcFile + " to " + destFile);
             srcFile.moveTo(destFile);
-            if (!isPreserveLastModified() &&
-                destFile.getFileSystem().hasCapability(Capability.SET_LAST_MODIFIED_FILE))
+            if (!isPreserveLastModified()
+                && destFile.getFileSystem().hasCapability(Capability.SET_LAST_MODIFIED_FILE))
             {
                 destFile.getContent().setLastModifiedTime(System.currentTimeMillis());
             }

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/ShowFileTask.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/ShowFileTask.java?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/ShowFileTask.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/ShowFileTask.java Sat Jan  2 20:02:29 2010
@@ -34,13 +34,15 @@
 public class ShowFileTask
     extends VfsTask
 {
+    private static final String INDENT = "  ";
     private String url;
     private boolean showContent;
     private boolean recursive;
-    private static final String INDENT = "  ";
+
 
     /**
      * The URL of the file to display.
+     * @param url The url of the file.
      */
     public void setFile(final String url)
     {
@@ -50,6 +52,7 @@
     /**
      * Shows the content.  Assumes the content is text, encoded using the
      * platform's default encoding.
+     * @param showContent true if the content should be shown.
      */
     public void setShowContent(final boolean showContent)
     {
@@ -57,7 +60,8 @@
     }
 
     /**
-     * Recursively shows the decendents of the file.
+     * Recursively shows the descendents of the file.
+     * @param recursive true if descendents should be shown.
      */
     public void setRecursive(final boolean recursive)
     {
@@ -66,6 +70,7 @@
 
     /**
      * Executes the task.
+     * @throws BuildException if any exception is thrown.
      */
     public void execute() throws BuildException
     {

Modified: commons/proper/vfs/trunk/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/pom.xml?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/pom.xml (original)
+++ commons/proper/vfs/trunk/pom.xml Sat Jan  2 20:02:29 2010
@@ -135,6 +135,11 @@
           <artifactId>maven-checkstyle-plugin</artifactId>
           <version>2.2</version>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-site-plugin</artifactId>
+          <version>2.2-SNAPSHOT</version>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
@@ -188,10 +193,10 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-site-plugin</artifactId>
-        <version>2.0-beta-5</version>
+        <version>2.2-SNAPSHOT</version>
         <configuration>
           <stagingDirectory>${user.home}/vfssite/tmp</stagingDirectory>
-          <stagingSiteURL>${user.home}/vfssite/staging</stagingSiteURL>
+          <stagingSiteURL>file://${user.home}/vfssite/staging</stagingSiteURL>
           <!-- Exclude the navigation file for Maven 1 sites
                and the changes file used by the changes-plugin,
                as they interfere with the site generation. -->

Modified: commons/proper/vfs/trunk/xdocs/download.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/xdocs/download.xml?rev=895278&r1=895277&r2=895278&view=diff
==============================================================================
--- commons/proper/vfs/trunk/xdocs/download.xml (original)
+++ commons/proper/vfs/trunk/xdocs/download.xml Sat Jan  2 20:02:29 2010
@@ -5,9 +5,9 @@
     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
-   
+
          http://www.apache.org/licenses/LICENSE-2.0
-   
+
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -40,7 +40,7 @@
                 <tr>
                     <td>
                         <a href="http://commons.apache.org/logging/">Commons Logging</a>
-                        Version 1.0.4 or later.
+                        Version 1.1.1 or later.
                     </td>
                     <td>All</td>
                 </tr>
@@ -60,13 +60,6 @@
                 </tr>
                 <tr>
                     <td>
-                        Jakarta
-                        <a href="http://jakarta.apache.org/oro/">ORO</a>
-                        Version 2.0.8
-                    </td>
-                </tr>
-                <tr>
-                    <td>
                         <a href="http://commons.apache.org/httpclient/">Commons Httpclient</a>
                         .
                         Version 2.0.
@@ -79,27 +72,10 @@
                 </tr>
                 <tr>
                     <td>
-                        jdom.org
-                        <a href="http://www.jdom.org">JDom</a>
-                        .
-                        Version 1.0.
-                        <br/>
-                        Only needed if you use webdav 2.2+
-                    </td>
-                    <td>
-                        WebDAV
+                        <a href="http://jackrabbit.apache.org">Apache Jackrabbit</a>
+                        Version 1.5.2 or later
                     </td>
-                </tr>
-                <tr>
-                    <td>
-                        Jakarta
-                        <a href="http://jakarta.apache.org/slide/">Slide</a>
-                        Version 2.2pre1 (20050629.002841)
-                        <br/>
-                        You only need this bleeding edge version if you would like to use the RandomAccessContent with
-                        webdav
-                    </td>
-                    <td>WebDAV (VFS sandbox)</td>
+                    <td>WebDAV</td>
                 </tr>
                 <tr>
                     <td>
@@ -111,7 +87,7 @@
                 <tr>
                     <td>
                         <a href="http://www.jcraft.com/jsch/">JSch</a>
-                        Version 0.1.23 or later.
+                        Version 0.1.42 or later.
                     </td>
                     <td>SFTP</td>
                 </tr>
@@ -122,21 +98,6 @@
 					</td>
 					<td>mime (VFS sandbox)</td>
 				</tr>
-<!--
-				<tr>
-                    <td>
-                        <a href="http://commons.apache.org/sandbox/compress/">Commons Compress</a>
-                        Nightly build 20050911
-                        <br/>
-                        There are no other nightlies than the one I created for maven, so please download it from the
-                        link below until this changes:
-                        <br/>
-                        <a href="http://www.ibiblio.org/maven/commons-compress/jars/commons-compress-20050911.jar">
-                            http://www.ibiblio.org/maven/commons-compress/jars/commons-compress-20050911.jar</a>
-                    </td>
-                    <td>tar, bz2</td>
-                </tr>
--->                
             </table>
         </section>
         <section name="Building Commons VFS">
@@ -166,27 +127,11 @@
             <ul>
                 <li>
                     Use
-                    <a href="http://ant.apache.org">Ant</a>
-                    1.6.2 or later.
-                    Use the
-                    <code>build.xml</code>
-                    file in the root source
-                    directory. The default target downloads the dependencies
-                    used to build Commons VFS, and then builds the jar file
-                    into the
-                    <code>target</code>
-                    directory.
-                </li>
-                <li>
-                    Use
                     <a href="http://maven.apache.org">Maven</a>
-                    1.0.2 or later. Use the
-                    <code>jar</code>
-                    goal to download
-                    the dependencies, and build the VFS jar. Maven builds the
-                    jar file into the
-                    <code>target</code>
-                    directory.
+                    2.1.0 or later. Use mvn install to build all the core, examples and sandbox. The
+                    jars will then be installed for use by other maven-based builds. The jars can either
+                    be copied from the local maven repository or the target sub-directories for non-Maven
+                    builds.
                 </li>
             </ul>
         </section>



Mime
View raw message