|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.net.ftp.FTPFileIterator
This class implements a bidirectional iterator over an FTPFileList. Elements may be retrieved one at at time using the hasNext() - next() syntax familiar from Java 2 collections. Alternatively, entries may be receieved as an array of any requested number of entries or all of them.
FTPFileList
,
FTPFileEntryParser
,
FTPListParseEngine
Field Summary | |
private static int |
DIREMPTY
Deprecated. constant shorthand for the situation where the raw listing has been scanned and found to have no valid entry. |
private static FTPFile[] |
EMPTY
Deprecated. shorthand for an empty return value. |
private int |
firstGoodEntry
Deprecated. number within rawlines of the first valid file entry. |
private int |
itemptr
Deprecated. this iterator's current position within rawlines . |
private FTPFileEntryParser |
parser
Deprecated. the parser to which this iterator delegates its parsing duties |
private List |
rawlines
Deprecated. a vector of strings, each representing a possibly valid ftp file entry |
private static int |
UNINIT
Deprecated. constant shorthand for the situation where the raw listing has not yet been scanned |
Constructor Summary | |
(package private) |
FTPFileIterator(FTPFileList rawlist)
Deprecated. "Package-private" constructor. |
(package private) |
FTPFileIterator(FTPFileList rawlist,
FTPFileEntryParser parser)
Deprecated. "Package-private" constructor. |
Method Summary | |
FTPFile[] |
getFiles()
Deprecated. Returns a list of FTPFile objects for ALL files listed in the server's LIST output. |
private int |
getFirstGoodEntry()
Deprecated. Skips over any introductory lines and stuff in the listing that does not represent files, returning the line number of the first entry that does represent a file. |
FTPFile[] |
getNext(int quantityRequested)
Deprecated. Returns an array of at most quantityRequested FTPFile
objects starting at this iterator's current position within its
associated list. |
FTPFile[] |
getPrevious(int quantityRequested)
Deprecated. Returns an array of at most quantityRequested FTPFile
objects starting at the position preceding this iterator's current
position within its associated list. |
boolean |
hasNext()
Deprecated. Method for determining whether getNext() will successfully return a non-null value. |
boolean |
hasPrevious()
Deprecated. Method for determining whether getPrevious() will successfully return a non-null value. |
private void |
init()
Deprecated. resets iterator to the beginning of the list. |
FTPFile |
next()
Deprecated. Returns a single parsed FTPFile object corresponding to the raw input line at this iterator's current position. |
private FTPFile |
parseFTPEntry(String entry)
Deprecated. Delegates to this object's parser member the job of parsing an entry. |
FTPFile |
previous()
Deprecated. Returns a single parsed FTPFile object corresponding to the raw input line at the position preceding that of the internal iterator over the list of raw lines maintained by this object After this method is called the internal iterator is retreated by one element (unless it is already at beginning of list). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private List rawlines
private FTPFileEntryParser parser
private static final int UNINIT
private static final int DIREMPTY
private int itemptr
rawlines
.
private int firstGoodEntry
rawlines
of the first valid file entry.
private static final FTPFile[] EMPTY
Constructor Detail |
FTPFileIterator(FTPFileList rawlist)
rawlist
- the FTPFileList to be iteratedFTPFileIterator(FTPFileList rawlist, FTPFileEntryParser parser)
rawlist
- the FTPFileList to be iteratedparser
- the system specific parser for raw FTP entries.Method Detail |
private FTPFile parseFTPEntry(String entry)
entry
- A string containing one entry, as determined by the
parser's getNextEntry() method.
private int getFirstGoodEntry()
rawlines
of the first good
entry in the array or DIREMPTY if there are no good entries.private void init()
public FTPFile[] getFiles()
public FTPFile[] getNext(int quantityRequested)
quantityRequested
FTPFile
objects starting at this iterator's current position within its
associated list. 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 the current position is advanced by
either quantityRequested
or the number of entries
available after the iterator, whichever is fewer.
quantityRequested
- the maximum number of entries we want to get. A 0
passed here is a signal to get ALL the entries.
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.public boolean hasNext()
public FTPFile next()
public FTPFile[] getPrevious(int quantityRequested)
quantityRequested
FTPFile
objects starting at the position preceding this iterator's current
position within its associated list. If fewer than
quantityRequested
such elements are available, the
returned array will have a length equal to the number of entries after
the iterator. If no such entries are found, this array will have a
length of 0. The entries will be ordered in the same order as the
list, not reversed.
After this method is called the current position is moved back by
either quantityRequested
or the number of entries
available before the current position, whichever is fewer.
quantityRequested
- the maximum number of entries we want to get.
A 0 passed here is a signal to get ALL the entries.
quantityRequested
FTPFile
objects starting at the position preceding the current position of
this iterator within its list and at least the number of elements which
exist in the list prior to its current position.public boolean hasPrevious()
public FTPFile previous()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |