File	Doc	Category	Size	Date	Package
FTPFileList.java	API Doc	Apache Commons NET 1.4.1 API	8162	Sat Dec 03 10:05:50 GMT 2005	org.apache.commons.net.ftp

FTPFileList

• java.lang.Object

Fields Summary
private LinkedList	lines storage for the raw lines of input read from the FTP server
private FTPFileEntryParser	parser the FTPFileEntryParser assigned to be used with this lister
private static final int	EMPTY_DIR private status code for an empty directory

Constructors Summary
private FTPFileList(FTPFileEntryParser parser, String encoding) The only constructor for FTPFileList, private because construction only invoked at create() param parser a FTPFileEntryParser value that knows how to parse the entries returned by a particular FTP site. param encoding The encoding to use. this.parser = parser; this.lines = new LinkedList();

Methods Summary
public static org.apache.commons.net.ftp.FTPFileList	create(java.io.InputStream stream, FTPFileEntryParser parser, java.lang.String encoding) The only way to create an 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. param stream The input stream created by reading the socket on which the output of the LIST command was returned param parser the default FTPFileEntryParser to be used by this object. This may later be changed using the init() method. param encoding The encoding to use return the FTPFileList created, with an initialized of unparsed lines of output. Will be null if the listing cannot be read from the stream. exception IOException Thrown on any failure to read from the socket. FTPFileList list = new FTPFileList(parser, encoding); list.readStream(stream, encoding); parser.preParse(list.lines); return list;
public static org.apache.commons.net.ftp.FTPFileList	create(java.io.InputStream stream, FTPFileEntryParser parser) The only way to create an 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. param stream The input stream created by reading the socket on which the output of the LIST command was returned param parser the default FTPFileEntryParser to be used by this object. This may later be changed using the init() method. return the FTPFileList created, with an initialized of unparsed lines of output. Will be null if the listing cannot be read from the stream. exception IOException Thrown on any failure to read from the socket. deprecated The version of this method which takes an encoding should be used. return create(stream, parser, null);
public FTPFile[]	getFiles() returns an array of FTPFile objects for all the files in the directory listing return an array of FTPFile objects for all the files in the directory listinge return iterator().getFiles();
java.util.List	getLines() Package private accessor for the collection of raw input lines. return vector containing all the raw input lines returned from the FTP server return this.lines;
FTPFileEntryParser	getParser() Accessor for this object's default parser. return this object's default parser. return this.parser;
public FTPFileIterator	iterator() create an iterator over this list using the parser with which this list was initally created return an iterator over this list using the list's default parser. return new FTPFileIterator(this);
public FTPFileIterator	iterator(FTPFileEntryParser parser) create an iterator over this list using the supplied parser param parser The user-supplied parser with which the list is to be iterated, may be different from this list's default parser. return an iterator over this list using the supplied parser. return new FTPFileIterator(this, parser);
public void	readStream(java.io.InputStream stream, java.lang.String encoding) internal method for reading the input into the lines vector. param stream The socket stream on which the input will be read. param encoding The encoding to use. exception IOException thrown on any failure to read the stream BufferedReader reader = new BufferedReader(new InputStreamReader(stream, encoding)); String line = this.parser.readNextEntry(reader); while (line != null) { this.lines.add(line); line = this.parser.readNextEntry(reader); } reader.close();
public void	readStream(java.io.InputStream stream) internal method for reading the input into the lines vector. param stream The socket stream on which the input will be read. exception IOException thrown on any failure to read the stream deprecated The version of this method which takes an encoding should be used. readStream(stream, null);