Class FTPFileList
Object
|
+--FTPFileList
- class
FTPFileList
An instance of this class represents a collection of files - usually
those in a particular directory. It's important to note that FTPFileList
is not itself an array - the member files is an array of FTPFiles.
Defined in ftpclient.js
Constructor Summary |
FTPFileList()
Constructs a file-list object.
|
Method Summary |
void
|
add(path, name, <FTPFileSize> size, date, <boolean> isDirectory, <boolean> isTextFile)
Add a file to the end of the files array.
|
boolean
|
containsFileName(<string> name)
Returns true of a file with the give name is in the list.
|
boolean
|
containsFilePath(<string> path)
Returns true of a file with the give path is in the list.
|
FTPFile
|
findByFileName(<string> name)
Returns the file with the give name or null if there isn't one in the list.
|
void
|
insert(<int> index, path, name, <FTPFileSize> size, date, <boolean> isDirectory, <boolean> isTextFile)
Inserts a file at the given index of the files array.
|
files
FTPFile files
FTPFileList
FTPFileList()
Constructs a file-list object.
add
void add(path, name, <FTPFileSize> size, date, <boolean> isDirectory, <boolean> isTextFile)
Add a file to the end of the files array.
Parameters:
isDirectory
- True if the object represents a directory.
isTextFile
- True if the file is likely to be a text-file.
filePath
- Full path of the file.
fileName
- Name of the file.
modifiedDate
- Date when the file was last modified.
containsFileName
boolean containsFileName(<string> name)
Returns true of a file with the give name is in the list.
Parameters:
name
- Name to search for.
Returns:
True if the list contains a file with the given name.
containsFilePath
boolean containsFilePath(<string> path)
Returns true of a file with the give path is in the list.
Parameters:
path
- Path to search for.
Returns:
True if the list contains a file with the given path.
findByFileName
FTPFile findByFileName(<string> name)
Returns the file with the give name or null if there isn't one in the list.
Parameters:
name
- Name to search for.
insert
void insert(<int> index, path, name, <FTPFileSize> size, date, <boolean> isDirectory, <boolean> isTextFile)
Inserts a file at the given index of the files array.
Parameters:
index
- Index at which to insert the file.
isDirectory
- True if the object represents a directory.
isTextFile
- True if the file is likely to be a text-file.
filePath
- Full path of the file.
fileName
- Name of the file.
modifiedDate
- Date when the file was last modified.
Documentation generated by
JSDoc on Tue Jan 24 10:46:49 2012