org.apache.commons.net.ftp
Class FTPListParseEngine

java.lang.Object
  extended byorg.apache.commons.net.ftp.FTPListParseEngine

public class FTPListParseEngine
extends java.lang.Object

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,v 1.7 2004/04/22 00:48:07 scohen Exp $

Field Summary
private  java.util.ListIterator _internalIterator
           
private  java.util.List entries
           
(package private)  FTPFileEntryParser parser
           
 
Constructor Summary
FTPListParseEngine(FTPFileEntryParser parser)
           
 
Method Summary
 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.
 FTPFile[] getNext(int quantityRequested)
          Returns an array of at most quantityRequested FTPFile objects starting at this object's internal iterator's current position.
 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.
 boolean hasNext()
          convenience method to allow clients to know whether this object's internal iterator's current position is at the end of the list.
 boolean hasPrevious()
          convenience method to allow clients to know whether this object's internal iterator's current position is at the beginning of the list.
 void readServerList(java.io.InputStream stream)
          handle the iniitial reading and preparsing of the list returned by the server.
private  void readStream(java.io.InputStream stream)
          Internal method for reading the input into the entries list.
 void resetIterator()
          resets this object's internal iterator to the beginning of the list.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

entries

private java.util.List entries

_internalIterator

private java.util.ListIterator _internalIterator

parser

FTPFileEntryParser parser
Constructor Detail

FTPListParseEngine

public FTPListParseEngine(FTPFileEntryParser parser)
Method Detail

readServerList

public void readServerList(java.io.InputStream stream)
                    throws java.io.IOException
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.
Throws:
java.io.IOException - thrown on any failure to read from the sever.

readStream

private void readStream(java.io.InputStream stream)
                 throws java.io.IOException
Internal method for reading the input into the entries list. After this method has completed, entries will contain a collection of entries (as defined by FTPFileEntryParser.readNextEntry()), but this may contain various non-entry preliminary lines from the server output, duplicates, and other data that will not be part of the final listing.

Parameters:
stream - The socket stream on which the input will be read.
Throws:
java.io.IOException - thrown on any failure to read the stream

getNext

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.
Returns:
an array of at most quantityRequested FTPFile objects starting at the current position of this iterator within its list and at least the number of elements which exist in the list at and after its current position.

getPrevious

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.
Returns:
an array of at most quantityRequested FTPFile objects starting at the current position of this iterator within its list and at least the number of elements which exist in the list at and after its current position. This array will be in the same order as the underlying list (not reversed).

getFiles

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

Returns:
an array of FTPFile objects containing the whole list of files returned by the server as read by this object's parser.
Throws:
java.io.IOException

hasNext

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

Returns:
true if internal iterator is not at end of list, false otherwise.

hasPrevious

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

Returns:
true if internal iterator is not at beginning of list, false otherwise.

resetIterator

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