org.apache.commons.net.ftp
Class FTPFileEntryParserImpl
java.lang.Object
org.apache.commons.net.ftp.FTPFileEntryParserImpl
- FTPFileEntryParser, FTPFileListParser
public abstract class FTPFileEntryParserImpl
extends java.lang.Object
This abstract class implements both the older FTPFileListParser and
newer FTPFileEntryParser interfaces with default functionality.
All the classes in the parser subpackage inherit from this.
FTPFile[] | parseFileList(InputStream listStream) - The version of this method which takes an encoding should be used.
|
FTPFile[] | parseFileList(InputStream listStream, String encoding) -
Parses an FTP server file listing and converts it into a usable format
in the form of an array of
FTPFile instances.
|
List | preParse(List original) - This method is a hook for those implementors (such as
VMSVersioningFTPEntryParser, and possibly others) which need to
perform some action upon the FTPFileList after it has been created
from the server stream, but before any clients see the list.
|
String | readNextEntry(BufferedReader reader) - Reads the next entry using the supplied BufferedReader object up to
whatever delemits one entry from the next.
|
FTPFileEntryParserImpl
public FTPFileEntryParserImpl()
The constructor for a FTPFileEntryParserImpl object.
parseFileList
public FTPFile[] parseFileList(InputStream listStream)
throws IOException
The version of this method which takes an encoding should be used.
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.
- parseFileList in interface FTPFileListParser
listStream
- The InputStream from which the file list should be
read.
- 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.
parseFileList
public FTPFile[] parseFileList(InputStream listStream,
String encoding)
throws IOException
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.
- parseFileList in interface FTPFileListParser
listStream
- The InputStream from which the file list should be
read.
- 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.
preParse
public List preParse(List original)
This method is a hook for those implementors (such as
VMSVersioningFTPEntryParser, and possibly others) which need to
perform some action upon the FTPFileList after it has been created
from the server stream, but before any clients see the list.
This default implementation is a no-op.
- preParse in interface FTPFileEntryParser
original
- Original list after it has been created from the server stream
original
unmodified.
readNextEntry
public String readNextEntry(BufferedReader reader)
throws IOException
Reads the next entry using the supplied BufferedReader object up to
whatever delemits one entry from the next. This default implementation
simply calls BufferedReader.readLine().
- readNextEntry in interface FTPFileEntryParser
reader
- The BufferedReader object from which entries are to be
read.
- A string representing the next ftp entry or null if none found.