org.xfp.filters.ftp
Class FTPListing

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.ftp.FTPAbstractFilter
              org.xfp.filters.ftp.FTPListing

public class FTPListing

extends FTPAbstractFilter

Lists files in an FTP directory. Use a nested PatternMatcher to limit the file set.

Version:

$Id: FTPListing.java,v 1.1 2004/03/19 15:56:42 flaviotordini Exp $

Author:

Flavio Tordini

Nested Class Summary

Nested classes inherited from class org.xfp.Filter

Filter.OnErrorEnum, Filter.OnLoopErrorEnum

Field Summary

Fields inherited from class org.xfp.filters.ftp.FTPAbstractFilter

ftp

Fields inherited from class org.xfp.AttributeContainer

name, parentContainer

Constructor Summary

FTPListing()

Method Summary

java.util.List	execute() Executes this filter.
void	setDirectories(boolean directories) List directories
void	setDirectory(java.lang.String directory) Sets the remote directory
void	setFiles(boolean files) List files
void	setRecurse(boolean recurse) Recurse in subdirectories
void	setSort(java.lang.String sort) Sets the sort.
void	setSortAscendant(boolean sortAscendant) Sets the sortAscendant.
void	setSymbolicLinks(boolean symbolicLinks) List symbolic links
void	subreset() Subclasses must reset their status within this method.

Methods inherited from class org.xfp.filters.ftp.FTPAbstractFilter

reset, setClient

Methods inherited from class org.xfp.Filter

getOnError, initialize, log, newInstance, perform, toString

Methods inherited from class org.xfp.AttributeContainer

configureAttributes, disposeAttributes, getAttributes, getFullName, getName, initializeAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FTPListing

public FTPListing()

Method Detail

execute

public java.util.List execute()
                       throws java.lang.Exception

Executes this filter.

Returns:

List of FTPFile

Throws:

java.lang.Exception

setDirectories

public void setDirectories(boolean directories)

List directories

Parameters:

directories -

setDirectory

public void setDirectory(java.lang.String directory)

Sets the remote directory

setFiles

public void setFiles(boolean files)

List files

Parameters:

files -

setRecurse

public void setRecurse(boolean recurse)

Recurse in subdirectories

Parameters:

recurse -

setSort

public void setSort(java.lang.String sort)
             throws java.lang.Exception

Sets the sort.

Parameters:

sort - The sort to set

Throws:

java.lang.Exception

setSortAscendant

public void setSortAscendant(boolean sortAscendant)

Sets the sortAscendant.

Parameters:

sortAscendant - The sortAscendant to set

setSymbolicLinks

public void setSymbolicLinks(boolean symbolicLinks)

List symbolic links

subreset

public void subreset()

Description copied from class: FTPAbstractFilter

Subclasses must reset their status within this method.

Specified by:

subreset in class FTPAbstractFilter

See Also:

FTPAbstractFilter.subreset()