org.waarp.ftp.core.file

Interface FtpDir

All Superinterfaces:

org.waarp.common.file.DirInterface

All Known Implementing Classes:

FileBasedDir, FilesystemBasedFtpDir

public interface FtpDir
extends org.waarp.common.file.DirInterface

Author:

Frederic Bregier

Field Summary

Fields inherited from interface org.waarp.common.file.DirInterface

SEPARATOR, SEPARATORCHAR

Method Summary

Methods

Modifier and Type	Method and Description
FtpFile	newFile(String path, boolean append) Create a new FtpFile
FtpFile	setFile(String path, boolean append) Set a path as the current FileInterface
FtpFile	setUniqueFile() Set a new unique path as the current FileInterface from the current Directory (STOU)

Methods inherited from interface org.waarp.common.file.DirInterface

canRead, canWrite, changeDirectory, changeDirectoryNotChecked, changeParentDirectory, checkIdentify, clear, exists, fileFull, getCRC, getFreeSpace, getMD5, getModificationTime, getOptsMLSx, getPwd, getSession, getSHA1, initAfterIdentification, isDirectory, isFile, isPathInCurrentDir, list, listFull, mkdir, rmdir, validatePath

Method Detail

newFile

FtpFile newFile(String path,
              boolean append)
                throws org.waarp.common.command.exception.CommandAbstractException

Create a new FtpFile

Specified by:

newFile in interface org.waarp.common.file.DirInterface

Parameters:

path -

append -

Returns:

the new Ftp FileInterface

Throws:

org.waarp.common.command.exception.CommandAbstractException

setFile

FtpFile setFile(String path,
              boolean append)
                throws org.waarp.common.command.exception.CommandAbstractException

Set a path as the current FileInterface

Specified by:

setFile in interface org.waarp.common.file.DirInterface

Parameters:

path -

append - True if this file is supposed to be in append mode (APPE), False in any other cases

Returns:

the Ftp FileInterface if it is correctly initiate

Throws:

org.waarp.common.command.exception.CommandAbstractException

setUniqueFile

FtpFile setUniqueFile()
                      throws org.waarp.common.command.exception.CommandAbstractException

Set a new unique path as the current FileInterface from the current Directory (STOU)

Specified by:

setUniqueFile in interface org.waarp.common.file.DirInterface

Returns:

the Ftp FileInterface if it is correctly initiate

Throws:

org.waarp.common.command.exception.CommandAbstractException