Package com.sshtools.common.files

Class AbstractFileAdapter

java.lang.Object

com.sshtools.common.files.AbstractFileAdapter

All Implemented Interfaces:

AbstractFile

Direct Known Subclasses:

ReadOnlyFileFactory.ReadOnlyAbstractFile

public abstract class AbstractFileAdapter
extends Object
implements AbstractFile

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractFile	file

Constructor Summary

Constructors

Constructor	Description
AbstractFileAdapter()
AbstractFileAdapter(AbstractFile file)

Method Summary

Modifier and Type	Method	Description
void	copyFrom(AbstractFile src)
boolean	createFolder()
boolean	createNewFile()
boolean	delete(boolean recursive)
boolean	exists()
String	getAbsolutePath()
SftpFileAttributes	getAttributes()
String	getCanonicalPath()
List<AbstractFile>	getChildren()
abstract AbstractFileFactory<? extends AbstractFile>	getFileFactory()
InputStream	getInputStream()
String	getName()
OutputStream	getOutputStream()
OutputStream	getOutputStream(boolean append)
AbstractFile	getParentFile()
protected void	init(AbstractFile file)
boolean	isDirectory()
boolean	isFile()
boolean	isHidden()
boolean	isReadable()
boolean	isWritable()
long	lastModified()
long	length()
void	linkFrom(String target)
void	linkTo(String target)	Deprecated, for removal: This API element is subject to removal in a future version.
void	moveTo(AbstractFile target)
AbstractFileRandomAccess	openFile(boolean writeAccess)
String	readSymbolicLink()
void	refresh()
AbstractFile	resolveFile(String child)
void	setAttributes(SftpFileAttributes attrs)
MultipartTransfer	startMultipartUpload(AbstractFile targetFile)
boolean	supportsMultipartTransfers()
boolean	supportsRandomAccess()
void	symlinkFrom(String target)
void	symlinkTo(String target)	Deprecated, for removal: This API element is subject to removal in a future version.
void	truncate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.common.files.AbstractFile

existsNoFollowLinks, getAttributesNoFollowLinks, getVolume, open

Field Details

file

protected AbstractFile file

Constructor Details

AbstractFileAdapter

public AbstractFileAdapter(AbstractFile file)

AbstractFileAdapter

public AbstractFileAdapter()

Method Details

getParentFile

public AbstractFile getParentFile()
                           throws IOException,
PermissionDeniedException

Specified by:

getParentFile in interface AbstractFile

Throws:

IOException

PermissionDeniedException

init

protected void init(AbstractFile file)

exists

public boolean exists()
               throws IOException,
PermissionDeniedException

Specified by:

exists in interface AbstractFile

Throws:

IOException

PermissionDeniedException

createFolder

public boolean createFolder()
                     throws IOException,
PermissionDeniedException

Specified by:

createFolder in interface AbstractFile

Throws:

IOException

PermissionDeniedException

lastModified

public long lastModified()
                  throws IOException,
PermissionDeniedException

Specified by:

lastModified in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getName

public String getName()

Specified by:

getName in interface AbstractFile

length

public long length()
            throws IOException,
PermissionDeniedException

Specified by:

length in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getAttributes

public SftpFileAttributes getAttributes()
                                 throws IOException,
PermissionDeniedException

Specified by:

getAttributes in interface AbstractFile

Throws:

IOException

PermissionDeniedException

isDirectory

public boolean isDirectory()
                    throws IOException,
PermissionDeniedException

Specified by:

isDirectory in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getChildren

public List<AbstractFile> getChildren()
                               throws IOException,
PermissionDeniedException

Specified by:

getChildren in interface AbstractFile

Throws:

IOException

PermissionDeniedException

isFile

public boolean isFile()
               throws IOException,
PermissionDeniedException

Specified by:

isFile in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getAbsolutePath

public String getAbsolutePath()
                       throws IOException,
PermissionDeniedException

Specified by:

getAbsolutePath in interface AbstractFile

Throws:

IOException

PermissionDeniedException

isReadable

public boolean isReadable()
                   throws IOException,
PermissionDeniedException

Specified by:

isReadable in interface AbstractFile

Throws:

IOException

PermissionDeniedException

createNewFile

public boolean createNewFile()
                      throws PermissionDeniedException,
IOException

Specified by:

createNewFile in interface AbstractFile

Throws:

PermissionDeniedException

IOException

truncate

public void truncate()
              throws PermissionDeniedException,
IOException

Specified by:

truncate in interface AbstractFile

Throws:

PermissionDeniedException

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException,
PermissionDeniedException

Specified by:

getInputStream in interface AbstractFile

Throws:

IOException

PermissionDeniedException

setAttributes

public void setAttributes(SftpFileAttributes attrs)
                   throws IOException

Specified by:

setAttributes in interface AbstractFile

Throws:

IOException

getCanonicalPath

public String getCanonicalPath()
                        throws IOException,
PermissionDeniedException

Specified by:

getCanonicalPath in interface AbstractFile

Throws:

IOException

PermissionDeniedException

supportsRandomAccess

public boolean supportsRandomAccess()

Specified by:

supportsRandomAccess in interface AbstractFile

openFile

public AbstractFileRandomAccess openFile(boolean writeAccess)
                                  throws IOException,
PermissionDeniedException

Specified by:

openFile in interface AbstractFile

Throws:

IOException

PermissionDeniedException

isHidden

public boolean isHidden()
                 throws IOException,
PermissionDeniedException

Specified by:

isHidden in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException,
PermissionDeniedException

Specified by:

getOutputStream in interface AbstractFile

Throws:

IOException

PermissionDeniedException

isWritable

public boolean isWritable()
                   throws IOException,
PermissionDeniedException

Specified by:

isWritable in interface AbstractFile

Throws:

IOException

PermissionDeniedException

copyFrom

public void copyFrom(AbstractFile src)
              throws IOException,
PermissionDeniedException

Specified by:

copyFrom in interface AbstractFile

Throws:

IOException

PermissionDeniedException

moveTo

public void moveTo(AbstractFile target)
            throws IOException,
PermissionDeniedException

Specified by:

moveTo in interface AbstractFile

Throws:

IOException

PermissionDeniedException

delete

public boolean delete(boolean recursive)
               throws IOException,
PermissionDeniedException

Specified by:

delete in interface AbstractFile

Throws:

IOException

PermissionDeniedException

refresh

public void refresh()

Specified by:

refresh in interface AbstractFile

getOutputStream

public OutputStream getOutputStream(boolean append)
                             throws IOException,
PermissionDeniedException

Specified by:

getOutputStream in interface AbstractFile

Throws:

IOException

PermissionDeniedException

resolveFile

public AbstractFile resolveFile(String child)
                         throws IOException,
PermissionDeniedException

Specified by:

resolveFile in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getFileFactory

public abstract AbstractFileFactory<? extends AbstractFile> getFileFactory()

Specified by:

getFileFactory in interface AbstractFile

symlinkTo

@Deprecated(since="3.1.0",
            forRemoval=true)
public void symlinkTo(String target)
               throws IOException,
PermissionDeniedException

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

symlinkTo in interface AbstractFile

Throws:

IOException

PermissionDeniedException

symlinkFrom

public void symlinkFrom(String target)
                 throws IOException,
PermissionDeniedException

Specified by:

symlinkFrom in interface AbstractFile

Throws:

IOException

PermissionDeniedException

linkFrom

public void linkFrom(String target)
              throws IOException,
PermissionDeniedException

Specified by:

linkFrom in interface AbstractFile

Throws:

IOException

PermissionDeniedException

linkTo

@Deprecated(since="3.1.0",
            forRemoval=true)
public void linkTo(String target)
            throws IOException,
PermissionDeniedException

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

linkTo in interface AbstractFile

Throws:

IOException

PermissionDeniedException

readSymbolicLink

public String readSymbolicLink()
                        throws IOException,
PermissionDeniedException

Specified by:

readSymbolicLink in interface AbstractFile

Throws:

IOException

PermissionDeniedException

supportsMultipartTransfers

public boolean supportsMultipartTransfers()

Specified by:

supportsMultipartTransfers in interface AbstractFile

startMultipartUpload

public MultipartTransfer startMultipartUpload(AbstractFile targetFile)
                                       throws IOException,
PermissionDeniedException

Specified by:

startMultipartUpload in interface AbstractFile

Throws:

IOException

PermissionDeniedException