You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ad...@apache.org on 2002/10/23 15:09:46 UTC
cvs commit: jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs FileContent.java FileName.java FileObject.java FileSystemManager.java package.html
adammurdoch 2002/10/23 06:09:46
Modified: vfs/src/java/org/apache/commons/vfs/tasks ShowFileTask.java
CopyTask.java MoveTask.java
vfs/src/java/org/apache/commons/vfs FileContent.java
FileName.java FileObject.java
FileSystemManager.java package.html
Log:
Javadoc comments.
Revision Changes Path
1.4 +2 -2 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/ShowFileTask.java
Index: ShowFileTask.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/ShowFileTask.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ShowFileTask.java 23 Oct 2002 11:59:42 -0000 1.3
+++ ShowFileTask.java 23 Oct 2002 13:09:45 -0000 1.4
@@ -65,7 +65,7 @@
import org.apache.tools.ant.BuildException;
/**
- * An Ant task, which writes the details of a file to Ant's log.
+ * An Ant task that writes the details of a file to Ant's log.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
1.3 +2 -2 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/CopyTask.java
Index: CopyTask.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/CopyTask.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CopyTask.java 23 Oct 2002 11:59:42 -0000 1.2
+++ CopyTask.java 23 Oct 2002 13:09:45 -0000 1.3
@@ -60,7 +60,7 @@
import org.apache.commons.vfs.Selectors;
/**
- * An Ant task that copies files.
+ * An Ant task that copies matching files.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
1.3 +2 -2 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/MoveTask.java
Index: MoveTask.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/MoveTask.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MoveTask.java 23 Oct 2002 11:59:42 -0000 1.2
+++ MoveTask.java 23 Oct 2002 13:09:45 -0000 1.3
@@ -60,7 +60,7 @@
import org.apache.commons.vfs.Selectors;
/**
- * An Ant task that moves files.
+ * An Ant task that moves matching files.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
1.5 +1 -1 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileContent.java
Index: FileContent.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileContent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- FileContent.java 23 Oct 2002 11:59:39 -0000 1.4
+++ FileContent.java 23 Oct 2002 13:09:45 -0000 1.5
@@ -60,7 +60,7 @@
import java.security.cert.Certificate;
/**
- * This interface is used to access the data content of a file.
+ * Represents the data content of a file.
*
* <p>To read from a file, use the {@link #getInputStream} method.
*
1.4 +2 -2 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileName.java
Index: FileName.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileName.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- FileName.java 23 Oct 2002 11:59:39 -0000 1.3
+++ FileName.java 23 Oct 2002 13:09:45 -0000 1.4
@@ -56,8 +56,8 @@
package org.apache.commons.vfs;
/**
- * The interface is used to perform operations on a file name. File names
- * are immutable, and work correctly as keys in hash tables.
+ * Represents a file name. File names are immutable, and work correctly as
+ * keys in hash tables.
*
* @see FileObject
*
1.8 +3 -3 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileObject.java
Index: FileObject.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileObject.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- FileObject.java 23 Oct 2002 11:59:39 -0000 1.7
+++ FileObject.java 23 Oct 2002 13:09:45 -0000 1.8
@@ -61,7 +61,7 @@
import java.util.List;
/**
- * This interface represents a file, and is used to access the content and
+ * Represents a file, and is used to access the content and
* structure of the file.
*
* <p>Files are arranged in a hierarchy. Each hierachy forms a
@@ -96,9 +96,9 @@
* using:
* <ul>
* <li>{@link #resolveFile} to find another file relative to this file.
- * <li>{@link #getChildren} to find the children of this file.
+ * <li>{@link #getChildren} and {@link #getChild} to find the children of this file.
* <li>{@link #getParent} to find the folder containing this file.
- * <li>{@link #getFileSystem} to find another ifle in the same file system.
+ * <li>{@link #getFileSystem} to find another file in the same file system.
* </ul>
*
* <p>To find files in another file system, use a {@link FileSystemManager}.
1.6 +1 -1 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileSystemManager.java
Index: FileSystemManager.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/FileSystemManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- FileSystemManager.java 23 Oct 2002 11:59:39 -0000 1.5
+++ FileSystemManager.java 23 Oct 2002 13:09:45 -0000 1.6
@@ -59,7 +59,7 @@
import java.net.URLStreamHandlerFactory;
/**
- * A FileSystemManager is manages a set of file systems. This interface is
+ * A FileSystemManager manages a set of file systems. This interface is
* used to locate a {@link FileObject} by name from one of those file systems.
*
* <p>To locate a {@link FileObject}, use one of the <code>resolveFile()</code>
1.3 +1 -8 jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/package.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- package.html 21 Aug 2002 13:10:56 -0000 1.2
+++ package.html 23 Oct 2002 13:09:45 -0000 1.3
@@ -1,10 +1,3 @@
<body>
-<p>This package contains the interfaces used to access the VFS.</p>
-
-<p>A {@link FileSystemManager} is the starting point for
-all file system access. It is used to locate a {@link FileObject}
-by name. Files are accessed using the {@link FileObject}
-interface. This interface allows a file's structure and content to be
-accessed.</p>
-
+<p>The public VFS API.</p>
</body>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>