Java Doc for FTPListParseEngine.java in  » Net » Apache-commons-net-1.4.1 » org » apache » commons » net » ftp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » Apache commons net 1.4.1 » org.apache.commons.net.ftp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.net.ftp.FTPListParseEngine

FTPListParseEngine
public class FTPListParseEngine (Code)
This class handles the entire process of parsing a listing of file entries from the server.

This object defines a two-part parsing mechanism.

The first part is comprised of reading the raw input into an internal list of strings. Every item in this list corresponds to an actual file. All extraneous matter emitted by the server will have been removed by the end of this phase. This is accomplished in conjunction with the FTPFileEntryParser associated with this engine, by calling its methods readNextEntry() - which handles the issue of what delimits one entry from another, usually but not always a line feed and preParse() - which handles removal of extraneous matter such as the preliminary lines of a listing, removal of duplicates on versioning systems, etc.

The second part is composed of the actual parsing, again in conjunction with the particular parser used by this engine. This is controlled by an iterator over the internal list of strings. This may be done either in block mode, by calling the getNext() and getPrevious() methods to provide "paged" output of less than the whole list at one time, or by calling the getFiles() method to return the entire list.

Examples:

Paged access:

 FTPClient f=FTPClient();
 f.connect(server);
 f.login(username, password);
 FTPListParseEngine engine = f.initiateListParsing(directory);
 while (engine.hasNext()) {
 FTPFile[] files = engine.getNext(25);  // "page size" you want
 //do whatever you want with these files, display them, etc.
 //expensive FTPFile objects not created until needed.
 }
 

For unpaged access, simply use FTPClient.listFiles(). That method uses this class transparently.
version:
   $Id: FTPListParseEngine.java 155429 2005-02-26 13:13:04Z dirkv $



Field Summary
 FTPFileEntryParserparser
    

Constructor Summary
public  FTPListParseEngine(FTPFileEntryParser parser)
    

Method Summary
public  FTPFile[]getFiles()
     Returns an array of FTPFile objects containing the whole list of files returned by the server as read by this object's parser. an array of FTPFile objects containing the whole list offiles returned by the server as read by this object's parser.

NOTE: This array may contain null members if any of the individual file listings failed to parse.

public  FTPFile[]getNext(int quantityRequested)
     Returns an array of at most quantityRequested FTPFile objects starting at this object's internal iterator's current position. If fewer than quantityRequested such elements are available, the returned array will have a length equal to the number of entries at and after after the current position. If no such entries are found, this array will have a length of 0. After this method is called this object's internal iterator is advanced by a number of positions equal to the size of the array returned.
Parameters:
  quantityRequested - the maximum number of entries we want to get.
public  FTPFile[]getPrevious(int quantityRequested)
     Returns an array of at most quantityRequested FTPFile objects starting at this object's internal iterator's current position, and working back toward the beginning. If fewer than quantityRequested such elements are available, the returned array will have a length equal to the number of entries at and after after the current position. If no such entries are found, this array will have a length of 0. After this method is called this object's internal iterator is moved back by a number of positions equal to the size of the array returned.
Parameters:
  quantityRequested - the maximum number of entries we want to get.
public  booleanhasNext()
     convenience method to allow clients to know whether this object's internal iterator's current position is at the end of the list.
public  booleanhasPrevious()
     convenience method to allow clients to know whether this object's internal iterator's current position is at the beginning of the list.
public  voidreadServerList(InputStream stream, String encoding)
     handle the iniitial reading and preparsing of the list returned by the server.
public  voidreadServerList(InputStream stream)
     handle the iniitial reading and preparsing of the list returned by the server.
public  voidresetIterator()
     resets this object's internal iterator to the beginning of the list.

Field Detail
parser
FTPFileEntryParser parser(Code)




Constructor Detail
FTPListParseEngine
public FTPListParseEngine(FTPFileEntryParser parser)(Code)




Method Detail
getFiles
public FTPFile[] getFiles() throws IOException(Code)
Returns an array of FTPFile objects containing the whole list of files returned by the server as read by this object's parser. an array of FTPFile objects containing the whole list offiles returned by the server as read by this object's parser.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  IOException -




getNext
public FTPFile[] getNext(int quantityRequested)(Code)
Returns an array of at most quantityRequested FTPFile objects starting at this object's internal iterator's current position. If fewer than quantityRequested such elements are available, the returned array will have a length equal to the number of entries at and after after the current position. If no such entries are found, this array will have a length of 0. After this method is called this object's internal iterator is advanced by a number of positions equal to the size of the array returned.
Parameters:
  quantityRequested - the maximum number of entries we want to get. an array of at most quantityRequested FTPFileobjects starting at the current position of this iterator within itslist and at least the number of elements which exist in the list atand after its current position.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.




getPrevious
public FTPFile[] getPrevious(int quantityRequested)(Code)
Returns an array of at most quantityRequested FTPFile objects starting at this object's internal iterator's current position, and working back toward the beginning. If fewer than quantityRequested such elements are available, the returned array will have a length equal to the number of entries at and after after the current position. If no such entries are found, this array will have a length of 0. After this method is called this object's internal iterator is moved back by a number of positions equal to the size of the array returned.
Parameters:
  quantityRequested - the maximum number of entries we want to get. an array of at most quantityRequested FTPFileobjects starting at the current position of this iterator within itslist and at least the number of elements which exist in the list atand after its current position. This array will be in the same orderas the underlying list (not reversed).

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.




hasNext
public boolean hasNext()(Code)
convenience method to allow clients to know whether this object's internal iterator's current position is at the end of the list. true if internal iterator is not at end of list, falseotherwise.



hasPrevious
public boolean hasPrevious()(Code)
convenience method to allow clients to know whether this object's internal iterator's current position is at the beginning of the list. true if internal iterator is not at beginning of list, falseotherwise.



readServerList
public void readServerList(InputStream stream, String encoding) throws IOException(Code)
handle the iniitial reading and preparsing of the list returned by the server. After this method has completed, this object will contain a list of unparsed entries (Strings) each referring to a unique file on the server.
Parameters:
  stream - input stream provided by the server socket.
exception:
  IOException - thrown on any failure to read from the sever.



readServerList
public void readServerList(InputStream stream) throws IOException(Code)
handle the iniitial reading and preparsing of the list returned by the server. After this method has completed, this object will contain a list of unparsed entries (Strings) each referring to a unique file on the server.
Parameters:
  stream - input stream provided by the server socket.
exception:
  IOException - thrown on any failure to read from the sever.



resetIterator
public void resetIterator()(Code)
resets this object's internal iterator to the beginning of the list.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.