Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.net.ftp
Class DefaultFTPFileListParser

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

All Implemented Interfaces:
  FTPFileListParser

public final class DefaultFTPFileListParser
extends java.lang.Object
implements FTPFileListParser

DefaultFTPFileListParser is the default implementation of FTPFileListParser used by FTPClient to parse file listings. 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 Also:
  `FTPFileListParser`, `FTPFile`, `FTPClient.listFiles(org.apache.commons.net.ftp.FTPFileListParser, java.lang.String)`

Constructor Summary
`DefaultFTPFileListParser()`

Method Summary
`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.
`FTPFile` | `parseFTPEntry(java.lang.String entry)` Parses an FTP server listing entry (a single line) and returns an FTPFile instance with the resulting information.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### DefaultFTPFileListParser

    public DefaultFTPFileListParser()

Method Detail

### parseFTPEntry

    public FTPFile parseFTPEntry(java.lang.String entry)

  Parses an FTP server listing entry (a single line) and returns an FTPFile instance with the resulting information. If the entry could not be parsed, returns null.

  Parameters:
    `entry` - A single line of an FTP server listing with the end of line truncated.
  Returns:
    An FTPFile instance representing the file information. null if the entry could be parsed, returns null.

### parseFileList

    public FTPFile[] parseFileList(java.io.InputStream listStream)
                            throws java.io.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` is returned, otherwise an array of `FTPFile` instances representing the files in the directory is returned.

  Specified by:
    `parseFileList` in interface `FTPFileListParser`
  Parameters:
    `listStream` - The InputStream from which the file list should be read.
  Returns:
    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.
  Throws:
    `java.io.IOException` - If an I/O error occurs reading the listStream.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1997-2003 Apache Software Foundation. All Rights Reserved.