| java.lang.Object
 org.apache.commons.net.ftp.FTPFileList
| FTPFileList | | public class FTPFileList (Code) | | This class encapsulates a listing of files from an FTP server. It is
initialized with an input stream which is read and the input split into
lines, each of which (after some possible initial verbiage) represents
a file on the FTP server. A parser is also supplied, which is used to
iterate through the internal list of lines parsing each into an FTPFile
object which is returned to the caller of the iteration methods. This
parser may be replaced with another, allowing the same list to be parsed
with different parsers.
Parsing takes place on an as-needed basis, basically, the first time a
position is iterated over. This happens at the time of iteration, not
prior to it as the older (FTPClient.listFiles() methods did,
which required a bigger memory hit.
author:
Steve Cohen
version:
$Id: FTPFileList.java 165675 2005-05-02 20:09:55Z rwinston $
See Also: org.apache.commons.net.ftp.FTPClient.createFileList
See Also: org.apache.commons.net.ftp.FTPFileIterator
See Also: org.apache.commons.net.ftp.FTPFileEntryParser
See Also: org.apache.commons.net.ftp.FTPListParseEngine |
| create | | public static FTPFileList create(InputStream stream, FTPFileEntryParser parser, String encoding) throws IOException(Code) | | The only way to create an FTPFileList object. Invokes
the private constructor and then reads the stream supplied stream to
build the intermediate array of "lines" which will later be parsed
into FTPFile object.
Parameters:
stream - The input stream created by reading the socket on whichthe output of the LIST command was returned
Parameters:
parser - the default FTPFileEntryParser to be usedby this object. This may later be changed using the init() method.
Parameters:
encoding - The encoding to use the FTPFileList created, with an initializedof unparsed lines of output. Will be null if the listing cannotbe read from the stream.
exception:
IOException - Thrown on any failure to read from the socket. |
| create | | public static FTPFileList create(InputStream stream, FTPFileEntryParser parser) throws IOException(Code) | | The only way to create an FTPFileList object. Invokes
the private constructor and then reads the stream supplied stream to
build the intermediate array of "lines" which will later be parsed
into FTPFile object.
Parameters:
stream - The input stream created by reading the socket on whichthe output of the LIST command was returned
Parameters:
parser - the default FTPFileEntryParser to be usedby this object. This may later be changed using the init() method. the FTPFileList created, with an initializedof unparsed lines of output. Will be null if the listing cannotbe read from the stream.
exception:
IOException - Thrown on any failure to read from the socket. |
| getFiles | | public FTPFile[] getFiles()(Code) | | returns an array of FTPFile objects for all the files in the directory
listing
an array of FTPFile objects for all the files in the directorylistinge |
| getLines | | List getLines()(Code) | | Package private accessor for the collection of raw input lines.
vector containing all the raw input lines returned from the FTPserver |
| iterator | | public FTPFileIterator iterator()(Code) | | create an iterator over this list using the parser with which this list
was initally created
an iterator over this list using the list's default parser. |
| iterator | | public FTPFileIterator iterator(FTPFileEntryParser parser)(Code) | | create an iterator over this list using the supplied parser
Parameters:
parser - The user-supplied parser with which the list is to beiterated, may be different from this list's default parser. an iterator over this list using the supplied parser. |
| readStream | | public void readStream(InputStream stream, String encoding) throws IOException(Code) | | internal method for reading the input into the lines vector.
Parameters:
stream - The socket stream on which the input will be read.
Parameters:
encoding - The encoding to use.
exception:
IOException - thrown on any failure to read the stream |
| readStream | | public void readStream(InputStream stream) throws IOException(Code) | | internal method for reading the input into the lines vector.
Parameters:
stream - The socket stream on which the input will be read.
exception:
IOException - thrown on any failure to read the stream |
|
|