Class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
java.lang.Object
org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
- Direct Known Subclasses:
FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile
- Enclosing class:
FTPTaskMirrorImpl.FTPDirectoryScanner
an AntFTPFile is a representation of a remote file
- Since:
- Ant 1.6
-
Constructor Summary
ConstructorsConstructorDescriptionAntFTPFile(org.apache.commons.net.ftp.FTPClient client, org.apache.commons.net.ftp.FTPFile ftpFile, String curpwd) constructorAntFTPFile(FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile parent, String path) other constructor -
Method Summary
Modifier and TypeMethodDescriptionbooleanexists()find out if the file existsfind out the absolute path of the fileprotected org.apache.commons.net.ftp.FTPClientreturn the attached FTP client object.returns the path of the directory containing the AntFTPFile.returns the path of the directory containing the AntFTPFile.find out the relative path assuming that the path used to construct this AntFTPFile was spelled properly with regards to case.org.apache.commons.net.ftp.FTPFilefind a file matching a string in an array of FTPFile.getLink()if the file is a symbolic link, find out to what it is pointinggetName()get the name of the filefind out the relative path to the rootPath of the enclosing scanner.booleantell if a file is a directory.booleantell if a file is a symbolic linkbooleanfind out if a symbolic link is encountered in the relative path of this file from rootPath.protected voidsets the current path of an AntFTPFiletoString()Get a string rep of this object.
-
Constructor Details
-
AntFTPFile
public AntFTPFile(org.apache.commons.net.ftp.FTPClient client, org.apache.commons.net.ftp.FTPFile ftpFile, String curpwd) constructor- Parameters:
client- ftp client variableftpFile- the filecurpwd- absolute remote path where the file is found
-
AntFTPFile
other constructor- Parameters:
parent- the parent filepath- a relative path to the parent file
-
-
Method Details
-
exists
public boolean exists()find out if the file exists- Returns:
- true if the file exists
-
getLink
if the file is a symbolic link, find out to what it is pointing- Returns:
- the target of the symbolic link
-
getName
-
getAbsolutePath
find out the absolute path of the file- Returns:
- absolute path as string
-
getFastRelativePath
find out the relative path assuming that the path used to construct this AntFTPFile was spelled properly with regards to case. This is OK on a case sensitive system such as UNIX- Returns:
- relative path
-
getRelativePath
find out the relative path to the rootPath of the enclosing scanner. this relative path is spelled exactly like on disk, for instance if the AntFTPFile has been instantiated as ALPHA, but the file is really called alpha, this method will return alpha. If a symbolic link is encountered, it is followed, but the name of the link rather than the name of the target is returned. (ie does not behave like File.getCanonicalPath())- Returns:
- relative path, separated by remoteFileSep
- Throws:
IOException- if a change directory fails, ...BuildException- if one of the components of the relative path cannot be found.
-
getFile
public org.apache.commons.net.ftp.FTPFile getFile(org.apache.commons.net.ftp.FTPFile[] theFiles, String lastpathelement) find a file matching a string in an array of FTPFile. This method will find "alpha" when requested for "ALPHA" if and only if the caseSensitive attribute is set to false. When caseSensitive is set to true, only the exact match is returned.- Parameters:
theFiles- array of fileslastpathelement- the file name being sought- Returns:
- null if the file cannot be found, otherwise return the matching file.
-
isDirectory
public boolean isDirectory()tell if a file is a directory. note that it will return false for symbolic links pointing to directories.- Returns:
truefor directories
-
isSymbolicLink
public boolean isSymbolicLink()tell if a file is a symbolic link- Returns:
truefor symbolic links
-
getClient
protected org.apache.commons.net.ftp.FTPClient getClient()return the attached FTP client object. Warning : this instance is really shared with the enclosing class.- Returns:
- FTP client
-
setCurpwd
sets the current path of an AntFTPFile- Parameters:
curpwd- the current path one wants to set
-
getCurpwd
returns the path of the directory containing the AntFTPFile. of the full path of the file itself in case of AntFTPRootFile- Returns:
- parent directory of the AntFTPFile
-
getCurpwdPlusFileSep
returns the path of the directory containing the AntFTPFile. of the full path of the file itself in case of AntFTPRootFile and appends the remote file separator if necessary.- Returns:
- parent directory of the AntFTPFile
- Since:
- Ant 1.8.2
-
isTraverseSymlinks
find out if a symbolic link is encountered in the relative path of this file from rootPath.- Returns:
trueif a symbolic link is encountered in the relative path.- Throws:
IOException- if one of the change directory or directory listing operations failsBuildException- if a path component in the relative path cannot be found.
-
toString
-