org.apache.commons.net.ftp
public class FTPFileList extends Object
Deprecated: This class is deprecated as of version 1.2 and will be removed in version 2.0 -- use FTPFileParseEngine instead.
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.
Version: $Id: FTPFileList.java 165675 2005-05-02 20:09:55Z rwinston $
See Also: FTPClient FTPFileIterator FTPFileEntryParser FTPListParseEngine
Method Summary | |
---|---|
static FTPFileList | create(InputStream stream, FTPFileEntryParser parser, String encoding)
The only way to create an FTPFileList object. |
static FTPFileList | create(InputStream stream, FTPFileEntryParser parser)
The only way to create an FTPFileList object. |
FTPFile[] | getFiles()
returns an array of FTPFile objects for all the files in the directory
listing
|
FTPFileIterator | iterator()
create an iterator over this list using the parser with which this list
was initally created
|
FTPFileIterator | iterator(FTPFileEntryParser parser)
create an iterator over this list using the supplied parser
|
void | readStream(InputStream stream, String encoding)
internal method for reading the input into the lines vector.
|
void | readStream(InputStream stream)
internal method for reading the input into the lines vector.
|
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 which
the output of the LIST command was returned parser the default FTPFileEntryParser
to be used
by this object. This may later be changed using the init() method. encoding The encoding to use
Returns: the FTPFileList
created, with an initialized
of unparsed lines of output. Will be null if the listing cannot
be read from the stream.
Throws: IOException Thrown on any failure to read from the socket.
Deprecated: The version of this method which takes an encoding should be used.
The only way to create anFTPFileList
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 which
the output of the LIST command was returned parser the default FTPFileEntryParser
to be used
by this object. This may later be changed using the init() method.
Returns: the FTPFileList
created, with an initialized
of unparsed lines of output. Will be null if the listing cannot
be read from the stream.
Throws: IOException Thrown on any failure to read from the socket.
Returns: an array of FTPFile objects for all the files in the directory listinge
Returns: an iterator over this list using the list's default parser.
Parameters: parser The user-supplied parser with which the list is to be iterated, may be different from this list's default parser.
Returns: an iterator over this list using the supplied parser.
lines
vector.
Parameters: stream The socket stream on which the input will be read. encoding The encoding to use.
Throws: IOException thrown on any failure to read the stream
Deprecated: The version of this method which takes an encoding should be used.
internal method for reading the input into thelines
vector.
Parameters: stream The socket stream on which the input will be read.
Throws: IOException thrown on any failure to read the stream