FileDocCategorySizeDatePackage
FTPFileListParser.javaAPI DocApache Commons NET 1.4.1 API3027Sat Dec 03 10:05:48 GMT 2005org.apache.commons.net.ftp

FTPFileListParser

public interface FTPFileListParser
FTPFileListParser defines the interface for parsing FTP file listings and converting that information into an array of {@link org.apache.commons.net.ftp.FTPFile} instances. Sometimes you will want to parse unusual listing formats, in which case you would create your own implementation of FTPFileListParser and if necessary, subclass FTPFile.

author
Daniel F. Savarese
see
FTPFile
see
FTPClient#listFiles
deprecated
This interface is deprecated as of version 1.2 and will be removed in version 2.0 -- use FTPFileEntryParser instead.

Fields Summary
Constructors Summary
Methods Summary
public FTPFile[]parseFileList(java.io.InputStream listStream, java.lang.String encoding)
Parses an FTP server file listing and converts it into a usable format in the form of an array of FTPFile instances. If the file list contains no files, null should be returned, otherwise an array of FTPFile instances representing the files in the directory is returned.

param
listStream The InputStream from which the file list should be read.
param
encoding The encoding to use.
return
The list of file information contained in the given path. null if the list could not be obtained or if there are no files in the directory.
exception
IOException If an I/O error occurs reading the listStream.

public FTPFile[]parseFileList(java.io.InputStream listStream)
Parses an FTP server file listing and converts it into a usable format
in the form of an array of  FTPFile  instances. If the
file list contains no files,  null  should be
returned, otherwise an array of  FTPFile  instances
representing the files in the directory is returned.

param
listStream The InputStream from which the file list should be
read.
return
The list of file information contained in the given path. null
if the list could not be obtained or if there are no files in
the directory.
exception
IOException If an I/O error occurs reading the listStream.