org.apache.commons.net.ftp

Class FTPFileEntryParserImpl

java.lang.Object
|
+--org.apache.commons.net.ftp.FTPFileEntryParserImpl

All Implemented Interfaces:
FTPFileEntryParser, FTPFileListParser

Known Direct Subclasses:
CompositeFileEntryParser, RegexFTPFileEntryParserImpl

public abstract class FTPFileEntryParserImpl
extends java.lang.Object
implements FTPFileEntryParser, FTPFileListParser

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.

Author:

Steve Cohen <scohen@apache.org>

Constructor Summary

FTPFileEntryParserImpl()

The constructor for a FTPFileEntryParserImpl object.

Method Summary

parseFileList(InputStream listStream)

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.

Constructor Details

FTPFileEntryParserImpl

public FTPFileEntryParserImpl()

The constructor for a FTPFileEntryParserImpl object.

Method Details

parseFileList

public FTPFile[] parseFileList(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.

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.

- If an I/O error occurs reading the listStream.

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.

original - Original list after it has been created from the server stream

original unmodified.

readNextEntry

public String readNextEntry(BufferedReader reader)

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().

reader - The BufferedReader object from which entries are to be read.

A string representing the next ftp entry or null if none found.

- thrown on any IO Error reading from the reader.