You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/12/30 04:58:53 UTC
cvs commit: jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser EnterpriseUnixFTPEntryParser.java NTFTPEntryParser.java OS2FTPEntryParser.java UnixFTPEntryParser.java VMSFTPEntryParser.java
scohen 2003/12/29 19:58:53
Modified: net/src/java/org/apache/commons/net/ftp/parser
EnterpriseUnixFTPEntryParser.java
NTFTPEntryParser.java OS2FTPEntryParser.java
UnixFTPEntryParser.java VMSFTPEntryParser.java
Log:
Remove outdated documentation on usage of the parsers and provide one central
bit of documentation explaining this usage.
Revision Changes Path
1.4 +2 -1 jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java
Index: EnterpriseUnixFTPEntryParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- EnterpriseUnixFTPEntryParser.java 18 May 2003 04:03:17 -0000 1.3
+++ EnterpriseUnixFTPEntryParser.java 30 Dec 2003 03:58:52 -0000 1.4
@@ -64,6 +64,7 @@
* "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST"
* @version $Id$
* @author <a href="Winston.Ojeda@qg.com">Winston Ojeda</a>
+ * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/
public class EnterpriseUnixFTPEntryParser extends FTPFileListParserImpl
{
1.5 +4 -40 jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
Index: NTFTPEntryParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NTFTPEntryParser.java 18 May 2003 04:03:17 -0000 1.4
+++ NTFTPEntryParser.java 30 Dec 2003 03:58:52 -0000 1.5
@@ -59,48 +59,12 @@
import org.apache.commons.net.ftp.FTPFileListParserImpl;
/**
- * This Class uses the ListParser class to validate the input string.
- * It also requires the NetComponents library version 1.3.7 or later
- * and the OROMatcher library for the regualar expressions stuff.
- *
- *
- * <P><B>USAGE:</B></P>
- * <LI>Create an instance of NTListParser</LI>
- * <dd>NTListParser parser = new NTListParser();
- * <LI>Create an instance of FTPClient</LI>
- * <dd>FTPClient FTPClientObj = new FTPClient();
- * <LI>Connect to the NODE </LI>
- * <dd>FTPClientObj.connect();
- * <LI>Login to the NODE </LI>
- * <dd>FTPClientObj.login(username,password);
- * <LI>Switch directories if you have to</LI>
- * <dd>FTPClientObj.changeWorkingDirectory(thePath);
- * <LI>You might want to check if you are truly in a NT System</LI>
- * <dd><B>String am_I_NT = FTPClientObj.getSystemName()</B>
- * <dd>parse am_I_NT to find out
- * <LI>Call listFiles passing the newly created parser and a filename or a
- * mask to look for </LI>
- * <dd>FTPClientObj.listFiles(parser,filename);
- * <LI>You'll get back the list as an array of FTPFiles like this
- * <dd>FTPFile[] myNTFiles = FTPClientObj.listFiles(parser,filename); (or)
- * <dd>FTPFile[] myNTFiles = FTPClientObj.listFiles(parser);
- * <P>
- * That's all there is to it.
- * <P>
- * Each FTPFile object is populated just like any other FTPFile
- * object. The only thing not implemented at this time is the file
- * permissions, but I can do it if there is a real need for it.
- * <P>
- * !NOTE/WARNING!:Before you pass the parser to listFiles, make sure you are in
- * the directory that you need to be. This parser will return the filtered
- * files from the directory it is in. This becomes crucial specialy if your
- * goal is to delete the output of the parser.
- * <P>
- *
+ * Implementation of FTPFileEntryParser and FTPFileListParser for NT Systems
+ *
* @author <a href="Winston.Ojeda@qg.com">Winston Ojeda</a>
* @author <a href="mailto:scohen@apache.org">Steve Cohen</a>
* @version $Id$
- * @see org.apache.commons.net.ftp.FTPFileListParser
+ * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/
public class NTFTPEntryParser extends FTPFileListParserImpl
{
1.4 +5 -40 jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
Index: OS2FTPEntryParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- OS2FTPEntryParser.java 6 Mar 2003 03:28:36 -0000 1.3
+++ OS2FTPEntryParser.java 30 Dec 2003 03:58:52 -0000 1.4
@@ -59,47 +59,12 @@
import org.apache.commons.net.ftp.FTPFileListParserImpl;
/**
- * This Class uses the ListParser class to validate the input string.
- * It also requires the NetComponents library version 1.3.7 or later
- * and the OROMatcher library for the regualar expressions stuff.
- *
- *
- * <P><B>USAGE:</B></P>
- * <LI>Create an instance of OS2FTPEntryParser</LI>
- * <dd>OS2FTPEntryParser parser = new OS2FTPEntryParser();
- * <LI>Create an instance of FTPClient</LI>
- * <dd>FTPClient FTPClientObj = new FTPClient();
- * <LI>Connect to the NODE </LI>
- * <dd>FTPClientObj.connect();
- * <LI>Login to the NODE </LI>
- * <dd>FTPClientObj.login(username,password);
- * <LI>Switch directories if you have to</LI>
- * <dd>FTPClientObj.changeWorkingDirectory(thePath);
- * <LI>You might want to check if you are truly in a OS2 System</LI>
- * <dd><B>String am_I_OS2 = FTPClientObj.getSystemName()</B>
- * <dd>parse am_I_OS2 to find out
- * <LI>Call listFiles passing the newly created parser and a filename or a mask
- * to look for </LI>
- * <dd>FTPClientObj.listFiles(parser,filename);
- * <LI>You'll get back the list as an array of FTPFiles like this
- * <dd>FTPFile[] myOS2Files = FTPClientObj.listFiles(parser,filename); (or)
- * <dd>FTPFile[] myOS2Files = FTPClientObj.listFiles(parser);
- * <P>
- * That's all there is to it.
- * <P>
- * Each FTPFile object is populated just like any other FTPFile
- * object. The only thing not implemented at this time is the file
- * permissions, but I can do it if there is a real need for it.
- * <P>
- * !NOTE/WARNING!:Before you pass the parser to listFiles, make sure you are
- * in the directory that you need to be. This parser will return the filtered
- * files from the directory it is in. This becomes specially crucial if your
- * goal is to delete the output of the parser.
- * <P>
- * @author <a href="Winston.Ojeda@qg.com">Winston Ojeda</a>
+ * Implementation of FTPFileEntryParser and FTPFileListParser for OS2 Systems
+ *
+ * @author <a href="Winston.Ojeda@qg.com">Winston Ojeda</a>
* @author <a href="mailto:scohen@apache.org">Steve Cohen</a>
* @version $Id$
- * @see org.apache.commons.net.ftp.FTPFileListParser
+ * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/
public class OS2FTPEntryParser extends FTPFileListParserImpl
1.4 +4 -1 jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
Index: UnixFTPEntryParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- UnixFTPEntryParser.java 25 Aug 2003 22:29:49 -0000 1.3
+++ UnixFTPEntryParser.java 30 Dec 2003 03:58:52 -0000 1.4
@@ -59,11 +59,14 @@
import org.apache.commons.net.ftp.FTPFileListParserImpl;
/**
+ * Implementation FTPFileEntryParser and FTPFileListParser for standard Unix Systems
+ *
* This class is based on the logic of Daniel Savarese's
* DefaultFTPListParser, but adapted to use regular expressions and to fit the
* new FTPFileEntryParser interface.
* @author <a href="mailto:scohen@ignitesports.com">Steve Cohen</a>
* @version $Id$
+ * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/
public class UnixFTPEntryParser extends FTPFileListParserImpl
{
1.8 +4 -43 jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
Index: VMSFTPEntryParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/net/src/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- VMSFTPEntryParser.java 5 Aug 2003 18:10:38 -0000 1.7
+++ VMSFTPEntryParser.java 30 Dec 2003 03:58:52 -0000 1.8
@@ -72,48 +72,7 @@
import org.apache.commons.net.ftp.FTPFileListParserImpl;
/**
- * This Class uses the FTPEntryParser class to validate the input string.
- * It also requires the Commons/Net library version 1.0.0 or later
- * and the Jakarta/ORO library for the regualar expressions stuff.
- *
- *
- * <P><B>USAGE:</B></P>
- * <LI>Create an instance of VMSFTPEntryParser</LI>
- * <dd>VMSFTPEntryParser parser = new VMSFTPEntryParser(boolean);
- * <dd><code>True</code> = returns all versions of a file with the respective
- * ;#
- * <dd><code>False</code> = only the last version will return <B>(Default)</B>
- * <LI>Create an instance of FTPClient</LI>
- * <dd>FTPClient FTPClientObj = new FTPClient();
- * <LI>Connect to the NODE </LI>
- * <dd>FTPClientObj.connect();
- * <LI>Login to the NODE </LI>
- * <dd>FTPClientObj.login(username,password);
- * <LI>Switch directories if you have to</LI>
- * <dd>FTPClientObj.changeWorkingDirectory(thePath);
- * <LI>You might want to check if you are truly in a VMS System</LI>
- * <dd>And how do I do that you ask? easy... VMS is such a wonderful OS
- * that when we do <dd><B>String am_I_VMS = FTPClientObj.getSystemName()</B>
- * <dd>it returns NULL, while everyone else returns the FTP servername
- * <LI>Call listFiles passing the newly created parser and a filename or a mask
- * to look for </LI> <dd>FTPClientObj.listFiles(parser,filename);
- * <LI>You'll get back the list as an array of FTPFile objects like this
- * <dd>FTPFile[] myVMSFiles = FTPClientObj.listFiles(parser,filename); (or)
- * <dd>FTPFile[] myVMSFiles = FTPClientObj.listFiles(parser);
- * <dd>If <code>filename</code> is a filename and versioning is OFF, the
- * version <dd>you requested will come back without the ;#
- * <P>
- * That's all there is to it.
- * <P>
- * Each FTPFile object is populated just like any other FTPFile
- * object. The only thing not implemented at this time is the file
- * permissions, but I can do it if there is a real need for it.
- * <P>
- * !NOTE/WARNING!:Before you pass the parser to listFiles, make sure you are
- * in the directory that you need to be. This parser will return the filtered
- * files from the directory it is in. This becomes crucial specialy if your
- * goal is to delete the output of the parser.
- * <P>
+ * Implementation FTPFileEntryParser and FTPFileListParser for VMS Systems
* This is a sample of VMS LIST output
*
* "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)",
@@ -125,6 +84,8 @@
* @author <a href="mailto:scohen@apache.org">Steve Cohen</a>
* @author <a href="sestegra@free.fr">Stephane ESTE-GRACIAS</a>
* @version $Id$
+ *
+ * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/
public class VMSFTPEntryParser extends FTPFileListParserImpl
{
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org